SBDGroupChannelMemberListQuery Class Reference

Inherits from NSObject
Conforms to NSCopying
Declared in SBDGroupChannelMemberListQuery.h

Overview

The SBDGroupChannelMemberListQuery class is a query class for getting the list member in group channels. The instance of this class is created by createMemberListQuery in SBDGroupChannel class.

– init

Don’t use this initializer. Use createGroupChannelListQuery of SBDGroupChannel instead.

- (nullable instancetype)init

Declared In

SBDGroupChannelMemberListQuery.h

  limit

Sets the number of members per page.

@property (atomic) NSUInteger limit

Declared In

SBDGroupChannelMemberListQuery.h

  hasNext

Shows if there is a next page

@property (atomic, readonly) BOOL hasNext

Declared In

SBDGroupChannelMemberListQuery.h

  loading

Shows if the query is loading.

@property (atomic, readonly, getter=isLoading) BOOL loading

Return Value

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

Availability

3.0.94

Declared In

SBDGroupChannelMemberListQuery.h

  nicknameStartsWithFilter

Filters members of nickname that starts with.

@property (copy, atomic, nullable) NSString *nicknameStartsWithFilter

Availability

3.0.102

Declared In

SBDGroupChannelMemberListQuery.h

  operatorFilter

Sets a filter to query operators.

@property (nonatomic) SBDGroupChannelOperatorFilter operatorFilter

Availability

3.0.89

Declared In

SBDGroupChannelMemberListQuery.h

  mutedMemberFilter

Sets a filter to query muted member list.

@property (nonatomic) SBDGroupChannelMutedMemberFilter mutedMemberFilter

Availability

3.0.89

Declared In

SBDGroupChannelMemberListQuery.h

  memberStateFilter

Sets a filter to query member list with member state.

@property (nonatomic) SBDMemberStateFilter memberStateFilter

Declared In

SBDGroupChannelMemberListQuery.h

  order

Sets how the query result should be ordered. If the order is SBDMemberListOrderNicknameAlphabetical, the result will be ordered by the nickname in alphabetical order. If the order is SBDMemberListOrderOperatorThenMemberNicknameAlphabetical, then the result will contain the operators first, and then the members. The two groups (operators and members) will be ordered by the nickname in alphabetical order. The default value is SBDMemberListOrderNicknameAlphabetical.

@property (atomic) SBDMemberListOrder order

Availability

3.0.198

Declared In

SBDGroupChannelMemberListQuery.h

– loadNextPageWithCompletionHandler:

Gets the list of member in group channel. If this method is repeatedly called, it will retrieve the following pages of the member list.

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

Parameters

completionHandler

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

Declared In

SBDGroupChannelMemberListQuery.h