TCHChannelDescriptor Class Reference

Inherits from NSObject
Declared in TCHChannelDescriptor.h

Overview

A snaphshot of a publicly available channel. The data and counts on this object are not updated beyond initial fetch so should not be cached long term.

  sid

The unique identifier for this channel.

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

Discussion

The unique identifier for this channel.

Declared In

TCHChannelDescriptor.h

  friendlyName

The friendly name for this channel.

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

Discussion

The friendly name for this channel.

Declared In

TCHChannelDescriptor.h

  uniqueName

The unique name for this channel.

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

Discussion

The unique name for this channel.

Declared In

TCHChannelDescriptor.h

  dateCreated

The timestamp the channel was created as an NSDate.

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

Discussion

The timestamp the channel was created as an NSDate.

Declared In

TCHChannelDescriptor.h

  createdBy

The identity of the channel’s creator.

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

Discussion

The identity of the channel’s creator.

Declared In

TCHChannelDescriptor.h

  dateUpdated

The timestamp the channel was last updated as an NSDate.

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

Discussion

The timestamp the channel was last updated as an NSDate.

Declared In

TCHChannelDescriptor.h

– attributes

Return this channel’s attributes.

- (nullable TCHJsonAttributes *)attributes

Return Value

The developer-defined extensible attributes for this channel.

Discussion

Return this channel’s attributes.

Declared In

TCHChannelDescriptor.h

– messagesCount

The number of messages on this channel.

- (NSUInteger)messagesCount

Return Value

The requested count.

Discussion

The number of messages on this channel.

Declared In

TCHChannelDescriptor.h

– membersCount

The number of members on this channel.

- (NSUInteger)membersCount

Return Value

The requested count.

Discussion

The number of members on this channel.

Declared In

TCHChannelDescriptor.h

– unconsumedMessagesCount

The number of unconsumed messages on this channel for the current user. See [TCHChannel getUnconsumedMessagesCountWithCompletion:] and https://www.twilio.com/docs/chat/consumption-horizon for more info.

- (nullable NSNumber *)unconsumedMessagesCount

Return Value

The requested count or null if last consumed message index has not been set.

Discussion

The number of unconsumed messages on this channel for the current user. See [TCHChannel getUnconsumedMessagesCountWithCompletion:] and https://www.twilio.com/docs/chat/consumption-horizon for more info.

Declared In

TCHChannelDescriptor.h

– channelWithCompletion:

Obtains the full channel object for this channel descriptor.

- (void)channelWithCompletion:(nonnull TCHChannelCompletion)completion

Parameters

completion

Completion block that will specify the result of the operation and a reference to the channel.

Discussion

Obtains the full channel object for this channel descriptor.

Declared In

TCHChannelDescriptor.h