PublicGroupChannelListQueryParams

@objc(SBDPublicGroupChannelListQueryParams)
public final class PublicGroupChannelListQueryParams : NSObject
extension PublicGroupChannelListQueryParams: NSCopying

Undocumented

  • Determines channel list includes empty channel. Deafult 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 list includes their members. Default is true

    Declaration

    Swift

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

    Since

    3.0.216

    Declaration

    Swift

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

    Declaration

    Swift

    @objc
    public var order: PublicGroupChannelListOrder
  • Sets to filter super channel. Default is .all

    Declaration

    Swift

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

    @objc
    public var publicMembershipFilter: PublicGroupChannelMembershipFilter
  • Sets the custom types filter.

    Declaration

    Swift

    @objc
    public var customTypesFilter: [String]?
  • Sets to filter channels by custom type that starts with.

    Declaration

    Swift

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

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

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

    @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 internal(set) var metaDataKeyFilter: String? { get }
  • Searches for group channels with metadata containing an item with the key specified by the metaDataKey

    Since

    3.0.232

    Declaration

    Swift

    @objc
    public internal(set) 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.232

    Declaration

    Swift

    @objc
    public internal(set) var metaDataValueStartsWithFilter: String? { get }
  • Specifies the number of results to return per call. (Default: 20)

    Declaration

    Swift

    @objc
    public var limit: UInt
  • Default constructor.

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    builder

    The builder closure.

    Return Value

    An initialized params object.

  • Sets meta data filter

    Note

    Using this method will reset metaDataValueStartsWithFilter property

    Declaration

    Swift

    @objc(setMetaDataFilterWithKey:values:)
    public func setMetaDataFilter(withKey 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(withKey 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