SBDOpenChannelListQuery Class Reference

Inherits from	NSObject
Conforms to	NSCopying
Declared in	SBDOpenChannelListQuery.h

Overview

The SBDOpenChannelListQuery class is a query class for getting the list of open channels. The instance of this class is created by createOpenChannelListQuery in SBDOpenChannel class.

`limit`

Sets the number of channels per page.

@property (atomic) NSUInteger limit

Declared In

SBDOpenChannelListQuery.h

`includeFrozenChannel`

Whether the result contains frozen channel or not. Default is YES

@property (atomic) BOOL includeFrozenChannel

Availability

3.0.182

Declared In

SBDOpenChannelListQuery.h

`includeMetaData`

Whether the result channel includes metadata or not. Default is NO

@property (atomic) BOOL includeMetaData

Availability

3.0.216

Declared In

SBDOpenChannelListQuery.h

`hasNext`

Shows if there is a next page.

@property (atomic, readonly) BOOL hasNext

Declared In

SBDOpenChannelListQuery.h

`urlKeyword`

Sets the keyword to search channel url. (Deprecated: in 3.0.64. (Use setChannelUrlFilter: instead.))

@property (strong, nonatomic, nullable) NSString *urlKeyword

Declared In

SBDOpenChannelListQuery.h

`nameKeyword`

Sets the keyword to search channel name. (Deprecated: in 3.0.64. (Use setChannelNameFilter: instead.))

@property (strong, nonatomic, nullable) NSString *nameKeyword

Declared In

SBDOpenChannelListQuery.h

`channelUrlFilter`

Sets the channel URL filter.

@property (copy, nonatomic, nullable) NSString *channelUrlFilter

Declared In

SBDOpenChannelListQuery.h

`channelNameFilter`

Sets the channel name filter.

@property (copy, nonatomic, nullable) NSString *channelNameFilter

Declared In

SBDOpenChannelListQuery.h

`customTypeFilter`

Sets the custom type filter.

@property (copy, nonatomic, nullable) NSString *customTypeFilter

Declared In

SBDOpenChannelListQuery.h

`– isLoading`

Shows if the query is loading.

- (BOOL)isLoading

Return Value

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

Declared In

SBDOpenChannelListQuery.h

`– loadNextPageWithCompletionHandler:`

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

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

Parameters

`completionHandler`	The handler block to execute. The `channels` is the array of `SBDOpenChannel` instances.

Declared In

SBDOpenChannelListQuery.h