TCHUserDescriptor Class Reference
Inherits from | NSObject |
---|---|
Declared in | TCHUserDescriptor.h |
identity
The identity for this user.
@property (nonatomic, copy, readonly, nullable) NSString *identity
Discussion
The identity for this user.
Declared In
TCHUserDescriptor.h
friendlyName
The friendly name for this user.
@property (nonatomic, copy, readonly, nullable) NSString *friendlyName
Discussion
The friendly name for this user.
Declared In
TCHUserDescriptor.h
– attributes
Return this user’s attributes.
- (nullable NSDictionary<NSString*,id> *)attributes
Return Value
The developer-defined extensible attributes for this user.
Discussion
Return this user’s attributes.
Declared In
TCHUserDescriptor.h
– isOnline
Indicates whether the user is online. Note that if TwilioChatClient 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 TwilioChatClient indicates reachability is not enabled, this will return NO.
Declared In
TCHUserDescriptor.h
– isNotifiable
Indicates whether the user is notifiable. Note that if TwilioChatClient 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 TwilioChatClient indicates reachability is not enabled, this will return NO.
Declared In
TCHUserDescriptor.h
– subscribeWithCompletion:
Subscribe and obtain a full TCHUser object for this user descriptor.
- (void)subscribeWithCompletion:(nullable TCHUserCompletion)completion
Parameters
completion |
Completion block that will specify the result of the operation and the newly subscribed user. |
---|
Discussion
Subscribe and obtain a full TCHUser object for this user descriptor.
Declared In
TCHUserDescriptor.h