TwilioIPMessagingClient Class Reference
| Inherits from | NSObject |
|---|---|
| Declared in | TwilioIPMessagingClient.h |
accessManager
Access manager to use with this client.
@property (nonatomic, strong) TwilioAccessManager *accessManagerDiscussion
Access manager to use with this client.
Declared In
TwilioIPMessagingClient.h
delegate
Messaging client delegate
@property (nonatomic, weak) id<TwilioIPMessagingClientDelegate> delegateDiscussion
Messaging client delegate
Declared In
TwilioIPMessagingClient.h
userInfo
The info for the logged in user in the IP Messaging system.
@property (nonatomic, strong, readonly) TWMUserInfo *userInfoDiscussion
The info for the logged in user in the IP Messaging system.
Declared In
TwilioIPMessagingClient.h
synchronizationStatus
The current client synchronization state.
@property (nonatomic, assign, readonly) TWMClientSynchronizationStatus synchronizationStatusDiscussion
The current client synchronization state.
Declared In
TwilioIPMessagingClient.h
+ setLogLevel:
Sets the logging level for the client.
+ (void)setLogLevel:(TWMLogLevel)logLevelParameters
logLevel |
The new log level. |
|---|
Discussion
Sets the logging level for the client.
Declared In
TwilioIPMessagingClient.h
+ logLevel
The logging level for the client.
+ (TWMLogLevel)logLevelReturn Value
The log level.
Discussion
The logging level for the client.
Declared In
TwilioIPMessagingClient.h
+ ipMessagingClientWithAccessManager:delegate:
Initialize a new IP Messaging client instance with a token manager. (Deprecated: Please use the ipMessagingClientWithAccessManager:properties:delegate: method below. Note that this change impacts client initialization logic, please refer to the release notes.)
+ (TwilioIPMessagingClient *)ipMessagingClientWithAccessManager:(TwilioAccessManager *)accessManager delegate:(id<TwilioIPMessagingClientDelegate>)delegateParameters
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
+ ipMessagingClientWithAccessManager:properties:delegate:
Initialize a new IP Messaging client instance with a token manager.
+ (TwilioIPMessagingClient *)ipMessagingClientWithAccessManager:(TwilioAccessManager *)accessManager properties:(TwilioIPMessagingClientProperties *)properties delegate:(id<TwilioIPMessagingClientDelegate>)delegateParameters
accessManager |
Instance of TwilioAccessManager. |
|---|---|
properties |
The properties to initialize the client with, if this is nil defaults will be used. |
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 *)versionReturn 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)completionParameters
completion |
Completion block that will specify the result of the operation and a list of channels visible to the current user. @deprecated |
|---|
Discussion
List of channels available to the current user.
Declared In
TwilioIPMessagingClient.h
– channelsList
List of channels available to the current user.
- (TWMChannels *)channelsListReturn 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 ipMessagingClient:updated:
Declared In
TwilioIPMessagingClient.h
– registerWithToken:
Register APNS token for push notification updates.
- (void)registerWithToken:(NSData *)tokenParameters
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 *)tokenParameters
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 *)notificationParameters
notification |
The incomming notification. |
|---|
Discussion
Queue the incoming notification with the messaging library for processing - notifications usually arrive from ‘didReceiveRemoteNotification’.
Declared In
TwilioIPMessagingClient.h
– isReachabilityEnabled
Indicates whether reachability is enabled for this instance.
- (BOOL)isReachabilityEnabledReturn Value
YES if reachability is enabled.
Discussion
Indicates whether reachability is enabled for this instance.
Declared In
TwilioIPMessagingClient.h
– shutdown
Cleanly shut down the messaging subsystem when you are done with it.
- (void)shutdownDiscussion
Cleanly shut down the messaging subsystem when you are done with it.
Declared In
TwilioIPMessagingClient.h