OpenChannelListQuery

@objc(SBDOpenChannelListQuery)
public final class OpenChannelListQuery : NSObject, NSCopying, Queryable

The OpenChannelListQuery class is a query class for getting the list of open channels.

The instance of this class is created by createOpenChannelListQuery() in OpenChannel class.

  • Boolean indicates there are more data to fetch

    Declaration

    Swift

    @objc
public internal(set) var hasNext: Bool { get }

  • Indicates the query is currently loading or not

    Declaration

    Swift

    @objc
public internal(set) var isLoading: Bool { get }

  • Fetches next page

    Declaration

    Swift

    @objc
public func loadNextPage(completionHandler: @escaping OpenChannelListHandler)

    Parameters

    completionHandler

    completion handler

  • Copies this object

    Declaration

    Swift

    public func copy(with zone: NSZone? = nil) -> Any

    Parameters

    zone

    optional NSZone

    Return Value

    OpenChannelListQuery instance

Params Bridge

  • Whether the result contains frozen channel or not. Default is true

    Since

    3.0.182

    Declaration

    Swift

    @objc
public var includeFrozenChannel: Bool { get }

  • Whether the result channel includes metadata or not. Default is false

    Since

    3.0.216

    Declaration

    Swift

    @objc
public var includeMetaData: Bool { get }

  • Whether the result channel includes pinned messages. Default is true

    Since

    4.20.0

    Declaration

    Swift

    @objc
public var includePinnedMessages: Bool { get }

  • Sets the channel URL filter.

    Declaration

    Swift

    @objc
public var channelURLFilter: String? { get }

  • Sets the channel name filter.

    Declaration

    Swift

    @objc
public var channelNameFilter: String? { get }

  • Sets the custom type filter.

    Declaration

    Swift

    @objc
public var customTypeFilter: String? { get }

  • Specifies the number of results to return per call. (Default: 20)

    Declaration

    Swift

    @objc
public var limit: UInt { get }