SBDUserListQuery Class Reference

Inherits from	NSObject
Conforms to	NSCopying
Declared in	SBDUserListQuery.h

Overview

The query for the all users is created by createAllUserListQuery of SBDMain class. The query for the users of the specified user IDs is created by createUserListQueryWithUserIds: of SBDMain class. The query for the blocked users is created by createBlockedUserListQuery of SBDMain class. The query for the participants in the specified open channel is created by createParticipantListQuery of the SBDOpenChannel instance. The query for the muted users is created by createMutedUserListQuery of the SBDOpenChannel instance. The query for the banned users is created by createBannedUserListQuery of the SBDOpenChannel instance.

`channel`

The channel instance related to query.

@property (strong, readonly, nullable) SBDBaseChannel *channel

Declared In

SBDUserListQuery.h

`queryType`

Query type. It is defined in SBDUserListQueryType.

@property (atomic, readonly) SBDUserListQueryType queryType

Declared In

SBDUserListQuery.h

`limit`

Sets the number of users per page.

@property (atomic) NSUInteger limit

Declared In

SBDUserListQuery.h

`hasNext`

Shows if there is a next page

@property (atomic, readonly) BOOL hasNext

Declared In

SBDUserListQuery.h

`metaDataKey`

3.0.120. (Deprecated: 3.0.120.)

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

Declared In

SBDUserListQuery.h

`metaDataValues`

3.0.120. (Deprecated: 3.0.120.)

@property (copy, nonatomic, readonly, nullable) NSArray<NSString*> *metaDataValues

Declared In

SBDUserListQuery.h

`– init`

DO NOT USE this initializer. Use [SBDMain createBlockedUserListQuery] instead.

- (nullable instancetype)init

Declared In

SBDUserListQuery.h

`– setMetaDataFilterWithKey:values:`

3.0.120. (Deprecated: 3.0.120.)

- (void)setMetaDataFilterWithKey:(NSString *_Nonnull)key values:(NSArray<NSString*> *_Nonnull)values

Parameters

`key`	The key of the meta data to use for filter.
`values`	The values of the meta data to use for filter.

Declared In

SBDUserListQuery.h

`– isLoading`

Returns YES if the query is loading, otherwise returns NO.

- (BOOL)isLoading

Return Value

Returns YES if the query is loading, otherwise returns NO.

Declared In

SBDUserListQuery.h

`– loadNextPageWithCompletionHandler:`

The handler block to execute. The users is the array of SBDUser instances.

- (void)loadNextPageWithCompletionHandler:(nullable void ( ^ ) ( NSArray<SBDUser*> *_Nullable users , SBDError *_Nullable error ))completionHandler

Parameters

`completionHandler`	The handler block to execute. The `users` is the array of `SBDUser` instances.

Declared In

SBDUserListQuery.h