OpenChannelListQueryParams

@objc(SBDOpenChannelListQueryParams)
public final class OpenChannelListQueryParams : NSObject
extension OpenChannelListQueryParams: NSCopying

Undocumented

  • Whether the result contains frozen channel or not. Default is true

    Since

    3.0.182

    Declaration

    Swift

    @objc
public var includeFrozenChannel: Bool

  • Whether the result channel includes metadata or not. Default is false

    Since

    3.0.216

    Declaration

    Swift

    @objc
public var includeMetaData: Bool

  • Whether the result channel includes pinned messages. Default is true

    Since

    4.20.0

    Declaration

    Swift

    @objc
public var includePinnedMessages: Bool

  • Sets the channel URL filter.

    Declaration

    Swift

    @objc
public var channelURLFilter: String?

  • Sets the channel name filter.

    Declaration

    Swift

    @objc
public var channelNameFilter: String?

  • Sets the custom type filter.

    Declaration

    Swift

    @objc
public var customTypeFilter: String?

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

    Since

    4.0.0

    Declaration

    Swift

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

    Parameters

    builder

    The builder closure.

    Return Value

    An initialized params object.

Equatable

  • Undocumented

    Declaration

    Swift

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

NSCopying

  • Undocumented

    Declaration

    Swift

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