Conforms to AGConfig
Declared in AGPipeConfig.h

Overview

Represents the public API to configure AGPipe objects.

Tasks

Properties

authModule

The Authentication Module configured for this Pipe.

@property (strong, nonatomic) id<AGAuthenticationModule> authModule

Discussion

The Authentication Module configured for this Pipe.

Declared In

AGPipeConfig.h

authzModule

The Authentication Module configured for this Pipe.

@property (strong, nonatomic) id<AGAuthzModule> authzModule

Discussion

The Authentication Module configured for this Pipe.

Declared In

AGPipeConfig.h

baseURL

The baseURL to the configuration.

@property (strong, nonatomic) NSURL *baseURL

Discussion

The baseURL to the configuration.

Declared In

AGPipeConfig.h

credential

The NSURLCredential to use if the request requires authentication.

@property (strong, nonatomic) NSURLCredential *credential

Discussion

The NSURLCredential to use if the request requires authentication.

The credential is used during the authentication challenge to a remote server that supports HTTP Basic and HTTP Digest authentication.

Note: Care should be taken when specifying the persistence type param when constructing the NSURLCredential object. Specifying type other than NSURLCredentialPersistenceNone, will have the effect of the credentials to be preserved across session and application restarts. In that case, the developer is responsible to clear the cache. See NSURLCredentialStorage class reference for more information.

Declared In

AGPipeConfig.h

endpoint

The endpoint to the configuration. If no endpoint is specified, the name will be used as its value.

@property (copy, nonatomic) NSString *endpoint

Discussion

The endpoint to the configuration. If no endpoint is specified, the name will be used as its value.

Declared In

AGPipeConfig.h

pageConfig

A block specifying paging configuration for this Pipe. See AGPageConfig and for the available paging configuration parameters and category AGNSMutableArray(Paging) for example usage.

@property (copy, nonatomic) void ( ^ ) ( id<AGPageConfig> ) pageConfig

Discussion

A block specifying paging configuration for this Pipe. See AGPageConfig and for the available paging configuration parameters and category AGNSMutableArray(Paging) for example usage.

Declared In

AGPipeConfig.h

recordId

The recordId to the configuration.

@property (copy, nonatomic) NSString *recordId

Discussion

The recordId to the configuration.

Declared In

AGPipeConfig.h

timeout

The timeout interval for a request to complete.

@property (assign, nonatomic) NSTimeInterval timeout

Discussion

The timeout interval for a request to complete.

Declared In

AGPipeConfig.h