TCHUsers Class Reference

Inherits from NSObject
Declared in TCHUsers.h

Overview

Representation of a chat channel’s users list.

– userDescriptorsForChannel:completion:

Obtain a list of user descriptors for the specified channel.

- (void)userDescriptorsForChannel:(nonnull TCHChannel *)channel completion:(nonnull TCHUserDescriptorPaginatorCompletion)completion

Parameters

channel

The channel to load the user descriptors for.
completion

Completion block that will specify the result of the operation and an array of user descriptors.

Discussion

Obtain a list of user descriptors for the specified channel.

Declared In

TCHUsers.h

– userDescriptorWithIdentity:completion:

Obtain a static snapshot of the user descriptor object for the given identity.

- (void)userDescriptorWithIdentity:(nonnull NSString *)identity completion:(nonnull TCHUserDescriptorCompletion)completion

Parameters

identity

The identity of the user to obtain.
completion

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

Discussion

Obtain a static snapshot of the user descriptor object for the given identity.

Declared In

TCHUsers.h

– subscribedUserWithIdentity:completion:

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

- (void)subscribedUserWithIdentity:(nonnull NSString *)identity completion:(nonnull TCHUserCompletion)completion

Parameters

identity

The identity of the user to obtain.
completion

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

Discussion

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

Declared In

TCHUsers.h

– subscribedUsers

Obtain a reference to all currently subscribed users in the system.

- (nonnull NSArray<TCHUser*> *)subscribedUsers

Return Value

An array of subscribed TCHUser objects.

Discussion

Obtain a reference to all currently subscribed users in the system.

Declared In

TCHUsers.h