TCHUser Class Reference

Inherits from NSObject
Declared in TCHUser.h

Overview

User information for the current user and other conversation participants.

  identity

The identity for this user.

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

Discussion

The identity for this user.

Declared In

TCHUser.h

  friendlyName

The friendly name for this user.

@property (nonatomic, copy, readonly, nullable) NSString *friendlyName

Discussion

The friendly name for this user.

Declared In

TCHUser.h

– attributes

Return this user’s attributes.

- (nullable TCHJsonAttributes *)attributes

Return Value

The developer-defined extensible attributes for this user.

Discussion

Return this user’s attributes.

Declared In

TCHUser.h

– setAttributes:completion:

Set this user’s attributes.

- (void)setAttributes:(nullable TCHJsonAttributes *)attributes completion:(nullable TCHCompletion)completion

Parameters

attributes

The new developer-defined extensible attributes for this user. (Supported types are NSString, NSNumber, NSArray, NSDictionary and NSNull)
completion

Completion block that will specify the result of the operation.

Discussion

Set this user’s attributes.

Declared In

TCHUser.h

– setFriendlyName:completion:

Set this user’s friendly name.

- (void)setFriendlyName:(nullable NSString *)friendlyName completion:(nullable TCHCompletion)completion

Parameters

friendlyName

The new friendly name for this user.
completion

Completion block that will specify the result of the operation.

Discussion

Set this user’s friendly name.

Declared In

TCHUser.h

– isOnline

Indicates whether the user is online. Note that if TwilioConversationsClient indicates reachability is not enabled, this will return NO.

- (BOOL)isOnline

Return Value

YES if the user is online.

Discussion

Indicates whether the user is online. Note that if TwilioConversationsClient indicates reachability is not enabled, this will return NO.

Declared In

TCHUser.h

– isNotifiable

Indicates whether the user is notifiable. Note that if TwilioConversationsClient indicates reachability is not enabled, this will return NO.

- (BOOL)isNotifiable

Return Value

YES if the user is notifiable.

Discussion

Indicates whether the user is notifiable. Note that if TwilioConversationsClient indicates reachability is not enabled, this will return NO.

Declared In

TCHUser.h

– isSubscribed

Indicates if the User is currently subscribed. User objects which are no longer subscribed will not receive updates and will return nil or Unavailable for their values.

- (BOOL)isSubscribed

Return Value

YES if the user object is subscribed.

Discussion

Indicates if the User is currently subscribed. User objects which are no longer subscribed will not receive updates and will return nil or Unavailable for their values.

Declared In

TCHUser.h

– unsubscribe

Manually unsubscribes this user object. It will no longer receive updates from the Conversations backend.

- (void)unsubscribe

Discussion

Manually unsubscribes this user object. It will no longer receive updates from the Conversations backend.

Declared In

TCHUser.h