GroupChannelListQuery

public final class GroupChannelListQuery: NSObject, Codable, Queryable
extension GroupChannelListQuery: Serializable

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

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

  • Boolean 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

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

    Declaration

    Swift

    public var limit: UInt

  • Declaration

    Swift

    public required init(from decoder: Decoder) throws

  • Declaration

    Swift

    public func encode(to encoder: Encoder) throws

  • Fetches next page

    Declaration

    Swift

    public func loadNextPage(completionHandler: @escaping GroupChannelListHandler)

    Parameters

    completionHandler

    completion handler

Copy

  • Copies this object

    Declaration

    Swift

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

    Parameters

    zone

    optional NSZone

    Return Value

    GroupChannelListQuery instance

SBComparator

BelongsTo

  • Validates the given channel object is belonged to this query object

    Declaration

    Swift

    public func belongsTo(channel: GroupChannel) -> Bool

    Parameters

    channel

    a group channel

    Return Value

    true if its belonged, otherwise false

Serializable

  • Serializes this object into data

    Declaration

    Swift

    public func serialize() -> Data?

    Return Value

    optioanal Data instance

  • Deserializes and reconstructs the object

    Declaration

    Swift

    public static func build(fromSerializedData data: Data?) -> Self?

    Parameters

    data

    Data instance

    Return Value

    GroupChannelListQuery if parameter is valid, otherwise nil

Params Bridge

  • Determines channel list includes empty channel. Default 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 object of the list includes members list.

    Declaration

    Swift

    public var includeMemberList: Bool

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

    Since

    3.0.216

    Declaration

    Swift

    public var includeMetaData: Bool

  • Sets query type for includeMemberList.

    Declaration

    Swift

    public var queryType: GroupChannelListQueryType

  • Sets the member state filter.

    Declaration

    Swift

    public var myMemberStateFilter: MyMemberStateFilter

  • Sets GroupChannel URLs filter. GroupChannel list containing only and exactly the passed GroupChannel URLs will be returned. This does not cooperate with other filters.

    Declaration

    Swift

    public var channelURLsFilter: [String]?

  • Sets to filter super channel. Default is .all

    Declaration

    Swift

    public var superChannelFilter: GroupChannelSuperChannelFilter

  • Sets to filter public channel.Default is .all

    Declaration

    Swift

    public var publicChannelFilter: GroupChannelPublicChannelFilter

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

    Declaration

    Swift

    public var customTypeStartsWithFilter: String?

  • Sets the custom types filter. The custom types to search.

    Declaration

    Swift

    public var customTypesFilter: [String]?

  • Sets the filter with nickname substring. Group channels whose members’ nicknames contain the filter are retruned by loadNextPage:.

    Declaration

    Swift

    public var nicknameContainsFilter: String?

  • Sets the filter with nickname prefix. Group channels whose members’ nicknames start with the filter are retruned by loadNextPage:.

    Declaration

    Swift

    public var nicknameStartsWithFilter: String?

  • Sets the filter with nickname. Group channels whose members’ nicknames match exactly with the filter are retruned by loadNextPage:.

    Declaration

    Swift

    public var nicknameExactMatchFilter: String?

  • Sets the filter with user IDs. The group channels which have the members that contain user IDs are returned by loadNextPage:.

    Declaration

    Swift

    public var userIdsIncludeFilter: [String]?

  • Sets the filter with user IDs. The group channels which have the members that have user IDs are returned by loadNextPage:. The channels have the userIds members only.

    Declaration

    Swift

    public var userIdsExactFilter: [String]?

  • Sets a filter to return only channels that contains the specified group channel name. The channel name to search. The query will return the channels include channelName.

    Declaration

    Swift

    public var channelNameContainsFilter: String?

  • Sets to filter channels by the unread messages. The default value is .all.

    Since

    3.0.113

    Declaration

    Swift

    public var unreadChannelFilter: UnreadChannelFilter

  • Sets a key for ordering by value in the metadata. This is valid when the order is GroupChannelListOrder.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?

  • Sets to filter channels by the hidden state. The default value is ChannelHiddenStateFilter.unhiddenOnly.

    Since

    3.0.122

    Declaration

    Swift

    public var channelHiddenStateFilter: ChannelHiddenStateFilter

  • The query property of the query specified by setSearchFilterQuery:fields:

    Since

    3.0.144

    Declaration

    Swift

    public var searchQuery: String?

  • The fields properties of the query specified by setSearchFilterQuery:fields:

    Since

    3.0.144

    Declaration

    Swift

    public var searchFields: GroupChannelListQuerySearchField

  • Sets the order of the list. The order is defined in GroupChannelListOrder.

    Declaration

    Swift

    public var order: GroupChannelListOrder

  • Since

    4.6.0

    Declaration

    Swift

    public var includeChatNotification: Bool

  • 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