PublicGroupChannelListQuery

public final class PublicGroupChannelListQuery: NSObject, Queryable

The PublicGroupChannelListQuery class is a query class for getting the list of public group channels.

The instance of this class is created by createPublicGroupChannelListQuery() in GroupChannel class.

  • indicates there are more data to fetch

    Declaration

    Swift

    public internal(set) var hasNext: Bool = true

  • Indicates the query is currently loading or not

    Declaration

    Swift

    public internal(set) var isLoading: Bool = false

  • Fetches next page

    Declaration

    Swift

    public func loadNextPage(completionHandler: @escaping GroupChannelListHandler)

    Parameters

    completionHandler

    completion handler

  • Copies this object

    Declaration

    Swift

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

    Parameters

    zone

    optional NSZone

    Return Value

    PublicGroupChannelListQuery instance

Params Bridge

  • Determines channel list includes empty channel. Deafult is true

    Declaration

    Swift

    public var includeEmptyChannel: Bool

  • Determines channel list includes frozen channel. Default is true

    Since

    3.0.182

    Declaration

    Swift

    public var includeFrozenChannel: Bool

  • Determines channel list includes their members. Default is true

    Declaration

    Swift

    public var includeMemberList: Bool

  • Determines channel object of the list includes meta data property. Default is true

    Since

    3.0.216

    Declaration

    Swift

    public var includeMetaData: Bool

  • Sets the order of the list. The order is defined in PublicGroupChannelListOrder. Default is .chronological

    Declaration

    Swift

    public var order: PublicGroupChannelListOrder

  • Sets to filter super channel. Default is .all

    Declaration

    Swift

    public var superChannelFilter: GroupChannelSuperChannelFilter

  • Sets GroupChannel URLs filter.

    GroupChannel list containing only and exactly the passed GroupChannel URLs will be returned.

    Note

    This does not cooperate with other filters.

    Declaration

    Swift

    public var publicMembershipFilter: PublicGroupChannelMembershipFilter

  • Sets the custom types filter.

    Declaration

    Swift

    public var customTypesFilter: [String]?

  • Sets to filter channels by custom type that starts with.

    Declaration

    Swift

    public var customTypeStartsWithFilter: String?

  • Sets GroupChannel URLs filter.

    GroupChannel list containing only and exactly the passed GroupChannel URLs will be returned.

    Note

    This does not cooperate with other filters.

    Declaration

    Swift

    public var channelURLsFilter: [String]?

  • Sets GroupChannel names filter.

    GroupChannel list containing only and exactly the passed GroupChannel name will be returned.

    Note

    This does not cooperate with other filters.

    Declaration

    Swift

    public var channelNameContainsFilter: String?

  • Sets a key for ordering by value in the metadata.

    This is valid when the order is .channelMetaDataValueAlphabetical only.

    Since

    3.0.118

    Declaration

    Swift

    public var metaDataOrderKeyFilter: String?

  • Searches for group channels with metadata containing an item with the specified value as its key

    Since

    3.0.232

    Declaration

    Swift

    public var metaDataKeyFilter: String?

  • Searches for group channels with metadata containing an item with the key specified by the metaDataKey

    Since

    3.0.232

    Declaration

    Swift

    public var metaDataValuesFilter: [String]?

  • Searches for group channels with metadata containing an item with the key specified by the metaDataKey and the values of that item start with the specified value

    Since

    3.0.232

    Declaration

    Swift

    public var metaDataValueStartsWithFilter: String?

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

    Declaration

    Swift

    public var limit: UInt

  • Searches for public group channels created before the specified value. (milliseconds)

    Since

    4.11.0

    Declaration

    Swift

    public var createdBefore: Int64

  • Searches for public group channels created after the specified value. (milliseconds)

    Since

    4.11.0

    Declaration

    Swift

    public var createdAfter: Int64