TwilioChatClient Class Reference

Inherits from NSObject
Declared in TwilioChatClient.h

Overview

Represents a chat client connection to Twilio.

  delegate

Messaging client delegate

@property (nonatomic, weak) id<TwilioChatClientDelegate> delegate

Discussion

Messaging client delegate

Declared In

TwilioChatClient.h

  user

The logged in user in the chat system.

@property (nonatomic, strong, readonly) TCHUser *user

Discussion

The logged in user in the chat system.

Declared In

TwilioChatClient.h

  connectionState

The client’s current connection state.

@property (nonatomic, assign, readonly) TCHClientConnectionState connectionState

Discussion

The client’s current connection state.

Declared In

TwilioChatClient.h

  synchronizationStatus

The current client synchronization state.

@property (nonatomic, assign, readonly) TCHClientSynchronizationStatus synchronizationStatus

Discussion

The current client synchronization state.

Declared In

TwilioChatClient.h

+ setLogLevel:

Sets the logging level for the client.

+ (void)setLogLevel:(TCHLogLevel)logLevel

Parameters

logLevel

The new log level.

Discussion

Sets the logging level for the client.

Declared In

TwilioChatClient.h

+ logLevel

The logging level for the client.

+ (TCHLogLevel)logLevel

Return Value

The log level.

Discussion

The logging level for the client.

Declared In

TwilioChatClient.h

+ chatClientWithToken:properties:delegate:completion:

Initialize a new chat client instance.

+ (void)chatClientWithToken:(NSString *)token properties:(TwilioChatClientProperties *)properties delegate:(id<TwilioChatClientDelegate>)delegate completion:(TCHTwilioClientCompletion)completion

Parameters

token

The client access token to use when communicating with Twilio.
properties

The properties to initialize the client with, if this is nil defaults will be used.
delegate

Delegate conforming to TwilioChatClientDelegate for chat client lifecycle notifications.
completion

Completion block that will specify the result of the operation and a reference to the new TwilioChatClient.

Discussion

Initialize a new chat client instance.

Declared In

TwilioChatClient.h

– version

Returns the version of the SDK

- (NSString *)version

Return Value

The chat client version.

Discussion

Returns the version of the SDK

Declared In

TwilioChatClient.h

– updateToken:completion:

Updates the access token currently being used by the client.

- (void)updateToken:(NSString *)token completion:(TCHCompletion)completion

Parameters

token

The updated client access token to use when communicating with Twilio.
completion

Completion block that will specify the result of the operation.

Discussion

Updates the access token currently being used by the client.

Declared In

TwilioChatClient.h

– channelsList

List of channels available to the current user.

- (TCHChannels *)channelsList

Return Value

The channelsList object.

Discussion

List of channels available to the current user.

This will be nil until the client is fully initialized, see the client delegate callback chatClient:synchronizationStatusUpdated:

Declared In

TwilioChatClient.h

– users

Provides access to the TCHUsers class to obtain user descriptors and subscribed users.

- (TCHUsers *)users

Return Value

The users object.

Discussion

Provides access to the TCHUsers class to obtain user descriptors and subscribed users.

Declared In

TwilioChatClient.h

– registerWithNotificationToken:completion:

Register APNS token for push notification updates.

- (void)registerWithNotificationToken:(NSData *)token completion:(TCHCompletion)completion

Parameters

token

The APNS token which usually comes from didRegisterForRemoteNotificationsWithDeviceToken.
completion

Completion block that will specify the result of the operation.

Discussion

Register APNS token for push notification updates.

Declared In

TwilioChatClient.h

– deregisterWithNotificationToken:completion:

De-register from push notification updates.

- (void)deregisterWithNotificationToken:(NSData *)token completion:(TCHCompletion)completion

Parameters

token

The APNS token which usually comes from didRegisterForRemoteNotificationsWithDeviceToken.
completion

Completion block that will specify the result of the operation.

Discussion

De-register from push notification updates.

Declared In

TwilioChatClient.h

– handleNotification:completion:

Queue the incoming notification with the messaging library for processing - notifications usually arrive from didReceiveRemoteNotification.

- (void)handleNotification:(NSDictionary *)notification completion:(TCHCompletion)completion

Parameters

notification

The incomming notification.
completion

Completion block that will specify the result of the operation.

Discussion

Queue the incoming notification with the messaging library for processing - notifications usually arrive from didReceiveRemoteNotification.

Declared In

TwilioChatClient.h

– isReachabilityEnabled

Indicates whether reachability is enabled for this instance.

- (BOOL)isReachabilityEnabled

Return Value

YES if reachability is enabled.

Discussion

Indicates whether reachability is enabled for this instance.

Declared In

TwilioChatClient.h

– shutdown

Cleanly shut down the messaging subsystem when you are done with it.

- (void)shutdown

Discussion

Cleanly shut down the messaging subsystem when you are done with it.

Declared In

TwilioChatClient.h