TwilioIPMessagingClient Class Reference

Inherits from NSObject
Declared in TwilioIPMessagingClient.h

Overview

Represents an IP Messaging client connection to Twilio.

  accessManager

Access manager to use with this client.

@property (nonatomic, strong) TwilioAccessManager *accessManager

Discussion

Access manager to use with this client.

Declared In

TwilioIPMessagingClient.h

  delegate

Messaging client delegate

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

Discussion

Messaging client delegate

Declared In

TwilioIPMessagingClient.h

  identity

The unique identity identifier of this user in the IP Messaging system.

@property (nonatomic, copy, readonly) NSString *identity

Discussion

The unique identity identifier of this user in the IP Messaging system.

Declared In

TwilioIPMessagingClient.h

+ ipMessagingClientWithToken:delegate:

Initialize a new IP Messaging client instance with a token. (Deprecated: Please use ipMessagingClientWithAccessManager:delegate: instead.)

+ (TwilioIPMessagingClient *)ipMessagingClientWithToken:(NSString *)token delegate:(id<TwilioIPMessagingClientDelegate>)delegate

Parameters

token

The authentication token for the user.
delegate

Delegate conforming to TwilioIPMessagingClientDelegate for IP Messaging client lifecycle notifications.

Return Value

New IP Messaging client instance.

Discussion

Initialize a new IP Messaging client instance with a token.

Declared In

TwilioIPMessagingClient.h

+ ipMessagingClientWithAccessManager:delegate:

Initialize a new IP Messaging client instance with a token manager.

+ (TwilioIPMessagingClient *)ipMessagingClientWithAccessManager:(TwilioAccessManager *)accessManager delegate:(id<TwilioIPMessagingClientDelegate>)delegate

Parameters

accessManager

Instance of TwilioAccessManager.
delegate

Delegate conforming to TwilioIPMessagingClientDelegate for IP Messaging client lifecycle notifications.

Return Value

New IP Messaging client instance.

Discussion

Initialize a new IP Messaging client instance with a token manager.

Declared In

TwilioIPMessagingClient.h

– version

Returns the version of the SDK

- (NSString *)version

Return Value

The IP Messaging client version.

Discussion

Returns the version of the SDK

Declared In

TwilioIPMessagingClient.h

– channelsListWithCompletion:

List of channels available to the current user.

- (void)channelsListWithCompletion:(TWMChannelListCompletion)completion

Parameters

completion

Completion block that will specify the result of the operation and a list of channels visible to the current user.

Discussion

List of channels available to the current user.

Declared In

TwilioIPMessagingClient.h

– registerWithToken:

Register APNS token for push notification updates.

- (void)registerWithToken:(NSData *)token

Parameters

token

The APNS token which usually comes from ‘didRegisterForRemoteNotificationsWithDeviceToken’.

Discussion

Register APNS token for push notification updates.

Declared In

TwilioIPMessagingClient.h

– deregisterWithToken:

De-register from push notification updates.

- (void)deregisterWithToken:(NSData *)token

Parameters

token

The APNS token which usually comes from ‘didRegisterForRemoteNotificationsWithDeviceToken’.

Discussion

De-register from push notification updates.

Declared In

TwilioIPMessagingClient.h

– handleNotification:

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

- (void)handleNotification:(NSDictionary *)notification

Parameters

notification

The incomming notification.

Discussion

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

Declared In

TwilioIPMessagingClient.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

TwilioIPMessagingClient.h