GroupChannelListQueryParams

@objc(SBDGroupChannelListQueryParams)
public final class GroupChannelListQueryParams : NSObject, Codable
extension GroupChannelListQueryParams: NSCopying

Undocumented

  • Determines channel list includes empty channel. Default is true

    Declaration

    Swift

    @objc
    public var includeEmptyChannel: Bool
  • Determines channel list includes frozen channel. Default is true

    Since

    3.0.182

    Declaration

    Swift

    @objc
    public var includeFrozenChannel: Bool
  • Determines channel object of the list includes members list.

    Declaration

    Swift

    @objc
    public var includeMemberList: Bool
  • Determines channel object of the list includes meta data property.

    Since

    3.0.216

    Declaration

    Swift

    @objc
    public var includeMetaData: Bool
  • Sets the order of the list. The order is defined in GroupChannelListOrder.

    Declaration

    Swift

    @objc
    public var order: GroupChannelListOrder
  • Sets query type for includeMemberList.

    Declaration

    Swift

    @objc
    public var queryType: GroupChannelListQueryType
  • Sets the member state filter.

    Declaration

    Swift

    @objc
    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

    @objc
    public var channelURLsFilter: [String]?
  • Sets to filter super channel. Default is .all

    Declaration

    Swift

    @objc
    public var superChannelFilter: GroupChannelSuperChannelFilter
  • Sets to filter public channel.Default is .all

    Declaration

    Swift

    @objc
    public var publicChannelFilter: GroupChannelPublicChannelFilter
  • Sets to filter channels by custom type that starts with.

    Declaration

    Swift

    @objc
    public var customTypeStartsWithFilter: String?
  • Sets the custom types filter. The custom types to search.

    Declaration

    Swift

    @objc
    public var customTypesFilter: [String]?
  • Sets the filter with nickname. The group channels which have the member that has nickname are returned by loadNextPage:(LIKE search).

    Declaration

    Swift

    @objc
    public var nicknameContainsFilter: String? { get set }
  • Sets the filter with nickname prefix. Group channels whose members’ nicknames start with the filter are retruned by loadNextPage:. Since: 4.0.14

    Declaration

    Swift

    @objc
    public var nicknameStartsWithFilter: String?
  • Sets the filter with nickname. Group channels whose members’ nicknames match exactly with the filter are retruned by loadNextPage:. Since: 4.0.14

    Declaration

    Swift

    @objc
    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

    @objc
    public private(set) var userIdsIncludeFilter: [String]? { get set }
  • 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

    @objc
    public var userIdsExactFilter: [String]? { get set }
  • 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?
  • Sets to filter channels by the unread messages. The default value is .all.

    Since

    3.0.113

    Declaration

    Swift

    @objc
    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

    @objc
    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

    @objc
    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

    @objc
    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

    @objc
    public var metaDataValueStartsWithFilter: String?
  • Sets to filter channels by the hidden state. The default value is ChannelHiddenStateFilter.unhiddenOnly.

    Since

    3.0.122

    Declaration

    Swift

    @objc
    public var channelHiddenStateFilter: ChannelHiddenStateFilter
  • The query property of the query specified by setSearchFilterQuery:fields:

    Since

    3.0.144

    Declaration

    Swift

    @objc
    public private(set) var searchQuery: String? { get }
  • The fields properties of the query specified by setSearchFilterQuery:fields:

    Since

    3.0.144

    Declaration

    Swift

    @objc
    public private(set) var searchFields: GroupChannelListQuerySearchField { get }
  • Specifies the number of results to return per call. (Default: 20)

    Declaration

    Swift

    @objc
    public var limit: UInt
  • Default constructor.

    Declaration

    Swift

    public override init()
  • Initializes and returns a newly allocated params object that mutated through builder closure.

    Declaration

    Swift

    @objc
    public init(builder: (GroupChannelListQueryParams) -> Void)

    Parameters

    builder

    The builder closure.

    Return Value

    An initialized params object.

  • Sets the filter with user IDs.

    The group channels which have the members that contain user IDs are returned by loadNext:.

    Declaration

    Swift

    @objc
    public func setUserIdsIncludeFilter(_ userIds: [String], queryType: GroupChannelListQueryType)

    Parameters

    userIds

    User IDs to search.

    queryType

    Logical condition applied to filter. If you pass GroupChannelListQueryTypeAnd to queryType and A, B to userIds, the channels whose members containing A and B will be returned. If GroupChannelListQueryTypeOr is set, the members of the queried channels will be A or B.

  • Sets the search query and search fields of the query specified a given query and a given fields.

    Note

    fields MUST be an array with GroupChannelListQuerySearchField.

    Since

    3.0.144

    Declaration

    Swift

    @objc
    public func setSearchFilter(_ query: String, fields: GroupChannelListQuerySearchField)

    Parameters

    query

    The query to request for searchFields.

    fields

    The fields to request query for searchQuery that MUST be GroupChannelListQuerySearchField.

  • Sets meta data filter

    Note

    Using this method will reset metaDataValueStartsWithFilter property

    Declaration

    Swift

    @objc(setMetaDataFilterWithKey:values:)
    public func setMetaDataFilter(_ key: String, values: [String])

    Parameters

    key

    meta data key

    values

    meta data values

  • Sets meta data filter

    Note

    Using this method will reset metaDataValuesFilter property

    Declaration

    Swift

    @objc(setMetaDataFilterWithKey:valueStartsWith:)
    public func setMetaDataFilter(_ key: String, valueStartsWith value: String)

    Parameters

    key

    meta data key

    value

    meta data values that starts with

Equatable

  • Undocumented

    Declaration

    Swift

    public override func isEqual(_ object: Any?) -> Bool

NSCopying

  • Undocumented

    Declaration

    Swift

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