TCHParticipant Class Reference

Inherits from NSObject
Declared in TCHParticipant.h

Overview

Representation of a Participant on a conversations conversation.

  conversation

The conversation for this participant.

@property (nonatomic, weak, readonly, nullable) TCHConversation *conversation

Discussion

The conversation for this participant.

Declared In

TCHParticipant.h

  sid

The unique identifier for this participant.

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

Discussion

The unique identifier for this participant.

Declared In

TCHParticipant.h

  identity

The identity for this participant.

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

Discussion

The identity for this participant.

Declared In

TCHParticipant.h

  channelType

The channel type this participant originated from.

@property (nonatomic, readonly) TCHParticipantChannelType channelType

Discussion

The channel type this participant originated from.

Declared In

TCHParticipant.h

  channel

The raw value of the channel type this participant originated from.

@property (nonatomic, readonly, nullable) NSString *channel

Discussion

The raw value of the channel type this participant originated from.

  • Returns: The channel type if the participant object was fully initialized, nil otherwise.

Declared In

TCHParticipant.h

  lastReadMessageIndex

Index of the last Message the Participant has read in this Conversation.

@property (nonatomic, copy, readonly, nullable) NSNumber *lastReadMessageIndex

Discussion

Index of the last Message the Participant has read in this Conversation.

Declared In

TCHParticipant.h

  lastReadTimestamp

Timestamp the last read message index updated for the Participant in this Conversation.

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

Discussion

Timestamp the last read message index updated for the Participant in this Conversation.

Declared In

TCHParticipant.h

  lastReadTimestampAsDate

Timestamp the last read message index updated for the Participant in this Conversation as an NSDate.

@property (nonatomic, strong, readonly, nullable) NSDate *lastReadTimestampAsDate

Discussion

Timestamp the last read message index updated for the Participant in this Conversation as an NSDate.

Declared In

TCHParticipant.h

  dateCreated

The Participant creation date.

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

Discussion

The Participant creation date.

Declared In

TCHParticipant.h

  dateCreatedAsDate

The Participant creation date as an NSDate.

@property (nonatomic, copy, readonly, nullable) NSDate *dateCreatedAsDate

Discussion

The Participant creation date as an NSDate.

Declared In

TCHParticipant.h

  dateUpdated

The Participant last update date.

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

Discussion

The Participant last update date.

Declared In

TCHParticipant.h

  dateUpdatedAsDate

The Participant last update date as an NSDate.

@property (nonatomic, copy, readonly, nullable) NSDate *dateUpdatedAsDate

Discussion

The Participant last update date as an NSDate.

Declared In

TCHParticipant.h

– attributes

Return this participant’s attributes.

- (nullable TCHJsonAttributes *)attributes

Return Value

The developer-defined extensible attributes for this participant.

Discussion

Return this participant’s attributes.

Declared In

TCHParticipant.h

– setAttributes:completion:

Set this participant’s attributes.

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

Parameters

attributes

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

Completion block that will specify the result of the operation.

Discussion

Set this participant’s attributes.

Declared In

TCHParticipant.h

– subscribedUserWithCompletion:

Obtain a subscribed user object for the participant. If no current subscription exists for this user, this will fetch the user and subscribe them. The least recently subscribed user object will be unsubscribed if you reach your instance’s user subscription limit.

- (void)subscribedUserWithCompletion:(nonnull TCHUserCompletion)completion

Parameters

completion

Completion block that will specify the result of the operation and the newly subscribed user.

Discussion

Obtain a subscribed user object for the participant. If no current subscription exists for this user, this will fetch the user and subscribe them. The least recently subscribed user object will be unsubscribed if you reach your instance’s user subscription limit.

Declared In

TCHParticipant.h

– removeWithCompletion:

Remove this participant from conversation

- (void)removeWithCompletion:(nullable TCHCompletion)completion

Parameters

completion

Completion block that will specify the result of the operation.

Discussion

Remove this participant from conversation

Declared In

TCHParticipant.h