TWMChannel Class Reference

Inherits from NSObject
Declared in TWMChannel.h

Overview

Representation of an IP Messaging channel.

  delegate

Optional channel delegate

@property (nonatomic, weak) id<TWMChannelDelegate> delegate

Discussion

Optional channel delegate

Declared In

TWMChannel.h

  sid

The unique identifier for this channel.

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

Discussion

The unique identifier for this channel.

Declared In

TWMChannel.h

  friendlyName

The friendly name for this channel.

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

Discussion

The friendly name for this channel.

Declared In

TWMChannel.h

  uniqueName

The unique name for this channel.

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

Discussion

The unique name for this channel.

Declared In

TWMChannel.h

  messages

The messages list object for this channel.

@property (nonatomic, strong, readonly) TWMMessages *messages

Discussion

The messages list object for this channel.

Declared In

TWMChannel.h

  members

The members list object for this channel.

@property (nonatomic, strong, readonly) TWMMembers *members

Discussion

The members list object for this channel.

Declared In

TWMChannel.h

  synchronizationStatus

The channel’s synchronization status.

@property (nonatomic, assign, readonly) TWMChannelSynchronizationStatus synchronizationStatus

Discussion

The channel’s synchronization status.

Declared In

TWMChannel.h

  status

The current user’s status on this channel.

@property (nonatomic, assign, readonly) TWMChannelStatus status

Discussion

The current user’s status on this channel.

Declared In

TWMChannel.h

  type

The channel’s visibility type.

@property (nonatomic, assign, readonly) TWMChannelType type

Discussion

The channel’s visibility type.

Declared In

TWMChannel.h

  dateCreated

The timestamp the channel was created.

@property (nonatomic, strong, readonly) NSString *dateCreated

Discussion

The timestamp the channel was created.

Declared In

TWMChannel.h

  dateCreatedAsDate

The timestamp the channel was created as an NSDate.

@property (nonatomic, strong, readonly) NSDate *dateCreatedAsDate

Discussion

The timestamp the channel was created as an NSDate.

Declared In

TWMChannel.h

  dateUpdated

The timestamp the channel was last updated.

@property (nonatomic, strong, readonly) NSString *dateUpdated

Discussion

The timestamp the channel was last updated.

Declared In

TWMChannel.h

  dateUpdatedAsDate

The timestamp the channel was last updated as an NSDate.

@property (nonatomic, strong, readonly) NSDate *dateUpdatedAsDate

Discussion

The timestamp the channel was last updated as an NSDate.

Declared In

TWMChannel.h

– synchronizeWithCompletion:

Perform the initial synchronization for channel.

- (void)synchronizeWithCompletion:(TWMCompletion)completion

Parameters

completion

Completion block that will specify the result of the operation.

Discussion

Perform the initial synchronization for channel.

Declared In

TWMChannel.h

– attributes

Return this channel’s attributes.

- (NSDictionary<NSString*,id> *)attributes

Return Value

The developer-defined extensible attributes for this channel.

Discussion

Return this channel’s attributes.

Declared In

TWMChannel.h

– setAttributes:completion:

Set this channel’s attributes.

- (void)setAttributes:(NSDictionary<NSString*,id> *)attributes completion:(TWMCompletion)completion

Parameters

attributes

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

Completion block that will specify the result of the operation.

Discussion

Set this channel’s attributes.

Declared In

TWMChannel.h

– setFriendlyName:completion:

Set this channel’s friendly name.

- (void)setFriendlyName:(NSString *)friendlyName completion:(TWMCompletion)completion

Parameters

friendlyName

The new friendly name for this channel.
completion

Completion block that will specify the result of the operation.

Discussion

Set this channel’s friendly name.

Declared In

TWMChannel.h

– setUniqueName:completion:

Set this channel’s unique name.

- (void)setUniqueName:(NSString *)uniqueName completion:(TWMCompletion)completion

Parameters

uniqueName

The new unique name for this channel.
completion

Completion block that will specify the result of the operation.

Discussion

Set this channel’s unique name.

Declared In

TWMChannel.h

– joinWithCompletion:

Join the current user to this channel.

- (void)joinWithCompletion:(TWMCompletion)completion

Parameters

completion

Completion block that will specify the result of the operation.

Discussion

Join the current user to this channel.

Declared In

TWMChannel.h

– declineInvitationWithCompletion:

Decline an invitation to this channel.

- (void)declineInvitationWithCompletion:(TWMCompletion)completion

Parameters

completion

Completion block that will specify the result of the operation.

Discussion

Decline an invitation to this channel.

Declared In

TWMChannel.h

– leaveWithCompletion:

Leave the current channel.

- (void)leaveWithCompletion:(TWMCompletion)completion

Parameters

completion

Completion block that will specify the result of the operation.

Discussion

Leave the current channel.

Declared In

TWMChannel.h

– destroyWithCompletion:

Destroy the current channel, removing all of its members.

- (void)destroyWithCompletion:(TWMCompletion)completion

Parameters

completion

Completion block that will specify the result of the operation.

Discussion

Destroy the current channel, removing all of its members.

Declared In

TWMChannel.h

– typing

Indicates to other users and the backend that the user is typing a message to this channel.

- (void)typing

Discussion

Indicates to other users and the backend that the user is typing a message to this channel.

Declared In

TWMChannel.h

– memberWithIdentity:

Fetch the member object for the given identity if it exists.

- (TWMMember *)memberWithIdentity:(NSString *)identity

Parameters

identity

The username to fetch.

Return Value

The TWMMember object, if one exists for the username for this channel.

Discussion

Fetch the member object for the given identity if it exists.

Declared In

TWMChannel.h