ARTAuthProtocol Protocol Reference


                    
                    
                    clientId

A client ID, used for identifying this client when publishing messages or for presence purposes. The clientId can be any non-empty string, except it cannot contain a *. This option is primarily intended to be used in situations where the library is instantiated with a key. Note that a clientId may also be implicit in a token used to instantiate the library. An error is raised if a clientId specified here conflicts with the clientId implicit in the token. Find out more about identified clients.

Declaration

Objective-C

@property (readonly, nullable) NSString *clientId;

Swift

var clientId: String? { get }


                    
                    
                    -requestToken:withOptions:callback:

Calls the requestToken REST API endpoint to obtain an Ably Token according to the specified ARTTokenParams and ARTAuthOptions. Both ARTTokenParams and ARTAuthOptions are optional. When omitted or nil, the default token parameters and authentication options for the client library are used, as specified in the ARTClientOptions when the client library was instantiated, or later updated with an explicit -[ARTAuthProtocol authorize:] request. Values passed in are used instead of, rather than being merged with, the default values. To understand why an Ably ARTTokenRequest may be issued to clients in favor of a token, see Token Authentication explained.

Declaration

Objective-C

- (void)requestToken:(nullable ARTTokenParams *)tokenParams
         withOptions:(nullable ARTAuthOptions *)authOptions
            callback:(nonnull ARTTokenDetailsCallback)callback;

Swift

func requestToken(_ tokenParams: ARTTokenParams?, with authOptions: ARTAuthOptions?, callback: @escaping ARTTokenDetailsCallback)

Parameters

`tokenParams`	An `ARTTokenParams` object.
`authOptions`	An `ARTAuthOptions` object.
`callback`	A callback for receiving an `ARTTokenDetails` object.


                    
                    
                    -requestToken:

See -[ARTAuthProtocol requestToken:withOptions:callback:] for details.

Declaration

Objective-C

- (void)requestToken:(nonnull ARTTokenDetailsCallback)callback;

Swift

func requestToken(_ callback: @escaping ARTTokenDetailsCallback)

Parameters


                                callback

A callback for receiving an ARTTokenDetails object.


                    
                    
                    -authorize:options:callback:

Instructs the library to get a new token immediately. When using the realtime client, it upgrades the current realtime connection to use the new token, or if not connected, initiates a connection to Ably, once the new token has been obtained. Also stores any ARTTokenParams and ARTAuthOptions passed in as the new defaults, to be used for all subsequent implicit or explicit token requests. Any ARTTokenParams and ARTAuthOptions objects passed in entirely replace, as opposed to being merged with, the current client library saved values.

Declaration

Objective-C

- (void)authorize:(nullable ARTTokenParams *)tokenParams
          options:(nullable ARTAuthOptions *)authOptions
         callback:(nonnull ARTTokenDetailsCallback)callback;

Swift

func authorize(_ tokenParams: ARTTokenParams?, options authOptions: ARTAuthOptions?, callback: @escaping ARTTokenDetailsCallback)

Parameters

`tokenParams`	An `ARTTokenParams` object.
`authOptions`	An `ARTAuthOptions` object.
`callback`	A callback for receiving an `ARTTokenDetails` object.


                    
                    
                    -authorize:

See -[ARTAuthProtocol authorize:options:callback:] for details.

Declaration

Objective-C

- (void)authorize:(nonnull ARTTokenDetailsCallback)callback;

Swift

func authorize(_ callback: @escaping ARTTokenDetailsCallback)

Parameters


                                callback

A callback for receiving an ARTTokenDetails object.


                    
                    
                    -createTokenRequest:options:callback:

Creates and signs an Ably ARTTokenRequest based on the specified (or if none specified, the client library stored) ARTTokenParams and ARTAuthOptions. Note this can only be used when the API key value is available locally. Otherwise, the Ably ARTTokenRequest must be obtained from the key owner. Use this to generate an Ably ARTTokenRequest in order to implement an Ably Token request callback for use by other clients. Both ARTTokenParams and ARTAuthOptions are optional. When omitted or nil, the default token parameters and authentication options for the client library are used, as specified in the ARTClientOptions when the client library was instantiated, or later updated with an explicit -[ARTAuthProtocol authorize:] request. Values passed in are used instead of, rather than being merged with, the default values. To understand why an Ably ARTTokenRequest may be issued to clients in favor of a token, see Token Authentication explained.

Declaration

Objective-C

- (void)createTokenRequest:(nullable ARTTokenParams *)tokenParams
                   options:(nullable ARTAuthOptions *)options
                  callback:(nonnull void (^)(ARTTokenRequest *_Nullable,
                                             NSError *_Nullable))callback;

Swift

func createTokenRequest(_ tokenParams: ARTTokenParams?, options: ARTAuthOptions?, callback: @escaping (ARTTokenRequest?, (any Error)?) -> Void)

Parameters

`tokenParams`	An `ARTTokenParams` object.
`options`	An `ARTAuthOptions` object.
`callback`	A callback for receiving an `ARTTokenRequest` object.


                    
                    
                    -createTokenRequest:

See -[ARTAuthProtocol createTokenRequest:options:callback:] for details.

Declaration

Objective-C

- (void)createTokenRequest:(nonnull void (^)(ARTTokenRequest *_Nullable,
                                             NSError *_Nullable))callback;

Swift

func createTokenRequest(_ callback: @escaping (ARTTokenRequest?, (any Error)?) -> Void)

Parameters


                                callback

A callback for receiving an ARTTokenRequest object.