TWMChannels Class Reference

Inherits from NSObject
Declared in TWMChannels.h

Overview

Representation of an IP Messaging channel list.

– loadChannelsWithCompletion:

Requesting loading of all channels from server to be delivered via delegate callbacks. (Deprecated: This is done implicitly by the client now.)

- (void)loadChannelsWithCompletion:(TWMCompletion)completion

Parameters

completion

Completion block that will specify the result.

Discussion

Requesting loading of all channels from server to be delivered via delegate callbacks.

Declared In

TWMChannels.h

– allObjects

Request a list of all channels loaded so far. Will be an incomplete list until loading completes.

- (NSArray<TWMChannel*> *)allObjects

Return Value

The channels loaded so far.

Discussion

Request a list of all channels loaded so far. Will be an incomplete list until loading completes.

Declared In

TWMChannels.h

– createChannelWithOptions:completion:

Create a new channel with the specified options.

- (void)createChannelWithOptions:(NSDictionary *)options completion:(TWMChannelCompletion)completion

Parameters

options

Channel options for new channel whose keys are TWMChannelOption* constants. (optional - may be empty or nil)
completion

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

Discussion

Create a new channel with the specified options.

TWMChannelOptionFriendlyName - String friendly name (optional)

TWMChannelOptionUniqueName - String unique name (optional)

TWMChannelOptionType - Expected values are @(TWMChannelTypePublic) or @(TWMChannelTypePrivate) (optional)

TWMChannelOptionAttributes - Expected value is an NSDictionary<NSString,id> , see also TWMChannel setAttributes:completion: (optional)

Declared In

TWMChannels.h

– channelWithId:

Loads a channel with the specified id.

- (TWMChannel *)channelWithId:(NSString *)channelId

Parameters

channelId

Identifier for the channel.

Return Value

The channel.

Discussion

Loads a channel with the specified id.

Declared In

TWMChannels.h

– channelWithUniqueName:

Loads a channel with the unique name.

- (TWMChannel *)channelWithUniqueName:(NSString *)uniqueName

Parameters

uniqueName

Unique name for the channel.

Return Value

The channel.

Discussion

Loads a channel with the unique name.

Declared In

TWMChannels.h