GroupChannelListQuery
@objc(SBDGroupChannelListQuery)
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
@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 }
-
Specifies the number of results to return per call. (Default: 20)
Declaration
Swift
@objc public var limit: UInt { get }
-
Declaration
Swift
public required init(from decoder: Decoder) throws
-
Declaration
Swift
public func encode(to encoder: Encoder) throws
-
Fetches next page
Declaration
Swift
@objc 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
GroupChannelListQuery
instance
-
Gets comparator
Declaration
Swift
@objc public func comparator() -> SBObjectComparator
Return Value
SBObjectComparator
object -
Compares two channels
Declaration
Swift
@objc public func orderBetweenObject(obj1: Any?, obj2: Any?) -> ComparisonResult
Parameters
obj1
First channel
obj2
Second channel
Return Value
ComparisonResult
value
-
Validates the given channel object is belonged to this query object
Declaration
Swift
@objc public func belongsTo(channel: GroupChannel) -> Bool
Parameters
channel
a group channel
Return Value
true
if its belonged, otherwisefalse
-
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
instanceReturn Value
GroupChannelListQuery
if parameter is valid, otherwisenil
-
Determines channel list includes empty channel. Default is
true
Declaration
Swift
@objc public var includeEmptyChannel: Bool { get }
-
Determines channel list includes frozen channel. Default is
true
Since
3.0.182Declaration
Swift
@objc public var includeFrozenChannel: Bool { get }
-
Determines channel object of the list includes members list.
Declaration
Swift
@objc public var includeMemberList: Bool { get }
-
Determines channel object of the list includes meta data property.
Since
3.0.216Declaration
Swift
@objc public var includeMetaData: Bool { get }
-
Sets query type for
includeMemberList
.Declaration
Swift
@objc public var queryType: GroupChannelListQueryType { get }
-
Sets the member state filter.
Declaration
Swift
@objc public var myMemberStateFilter: MyMemberStateFilter { get }
-
Sets
GroupChannel
URLs filter.GroupChannel
list containing only and exactly the passedGroupChannel
URLs will be returned. This does not cooperate with other filters.Declaration
Swift
@objc public var channelURLsFilter: [String]? { get }
-
Sets to filter super channel. Default is
.all
Declaration
Swift
@objc public var superChannelFilter: GroupChannelSuperChannelFilter { get }
-
Sets to filter public channel.Default is
.all
Declaration
Swift
@objc public var publicChannelFilter: GroupChannelPublicChannelFilter { get }
-
Sets to filter channels by custom type that starts with.
Declaration
Swift
@objc public var customTypeStartsWithFilter: String? { get }
-
Sets the custom types filter. The custom types to search.
Declaration
Swift
@objc public var customTypesFilter: [String]? { get }
-
Sets the filter with nickname substring. Group channels whose members’ nicknames contain the filter are retruned by
loadNextPage:
.Declaration
Swift
@objc public var nicknameContainsFilter: String? { get }
-
Sets the filter with nickname prefix. Group channels whose members’ nicknames start with the filter are retruned by
loadNextPage:
.Declaration
Swift
@objc public var nicknameStartsWithFilter: String? { get }
-
Sets the filter with nickname. Group channels whose members’ nicknames match exactly with the filter are retruned by
loadNextPage:
.Declaration
Swift
@objc public var nicknameExactMatchFilter: String? { get }
-
Sets the filter with user IDs. The group channels which have the members that contain user IDs are returned by
loadNextPage:
.Declaration
Swift
@objc public var userIdsIncludeFilter: [String]? { get }
-
Sets the filter with user IDs. The group channels which have the members that have user IDs are returned by
loadNextPage:
. The channels have theuserIds
members only.Declaration
Swift
@objc public var userIdsExactFilter: [String]? { get }
-
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
@objc public var channelNameContainsFilter: String? { get }
-
Sets to filter channels by the unread messages. The default value is
.all
.Since
3.0.113Declaration
Swift
@objc public var unreadChannelFilter: UnreadChannelFilter { get }
-
Sets a key for ordering by value in the metadata. This is valid when the
order
isGroupChannelListOrder.channelMetaDataValueAlphabetical
only.Since
3.0.118Declaration
Swift
@objc public var metaDataOrderKeyFilter: String? { get }
-
Searches for group channels with metadata containing an item with the specified value as its key
Since
3.0.232Declaration
Swift
@objc public var metaDataKeyFilter: String? { get }
-
Searches for group channels with metadata containing an item with the key specified by the metaDataKey
Since
3.0.232Declaration
Swift
@objc public var metaDataValuesFilter: [String]? { get }
-
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.232Declaration
Swift
@objc public var metaDataValueStartsWithFilter: String? { get }
-
Sets to filter channels by the hidden state. The default value is
ChannelHiddenStateFilter.unhiddenOnly
.Since
3.0.122Declaration
Swift
@objc public var channelHiddenStateFilter: ChannelHiddenStateFilter { get }
-
The query property of the query specified by
setSearchFilterQuery:fields:
Since
3.0.144Declaration
Swift
@objc public var searchQuery: String? { get }
-
The fields properties of the query specified by
setSearchFilterQuery:fields:
Since
3.0.144Declaration
Swift
@objc public var searchFields: GroupChannelListQuerySearchField { get }
-
Sets the order of the list. The order is defined in
GroupChannelListOrder
.Declaration
Swift
@objc public var order: GroupChannelListOrder { get }
-
Since
4.6.0Declaration
Swift
@objc public var includeChatNotification: Bool { get }
-
Searches for public group channels created before the specified value. (milliseconds)
Since
4.11.0Declaration
Swift
@objc public var createdBefore: Int64 { get }
-
Searches for public group channels created after the specified value. (milliseconds)
Since
4.11.0Declaration
Swift
@objc public var createdAfter: Int64 { get }