Params

@objcMembers
@objc(SBCRoomListQueryParams)
public class Params : NSObject

A class that provides configuration for RoomListQuery

Since

1.7.0

  • The number of rooms to be retrieved at once.

    Since

    1.7.0

    Declaration

    Swift

    public var limit: UInt

  • Filters query results to include rooms with the specified room type.

    Since

    1.7.0

    Declaration

    Swift

    public var types: Set<RoomType>

  • Filters query results to include rooms with the specified room type.

    Since

    1.7.0

    Declaration

    Swift

    public func getTypes() -> NSArray

  • Filters query results to include room with the specified room state.

    Since

    1.7.0

    Declaration

    Swift

    public var states: Set<Room.State>

  • Filters query results to include room with the specified room state.

    Since

    1.7.0

    Declaration

    Swift

    public func getState() -> NSArray

  • Filters query results to include rooms that were created by specified user IDs.

    Since

    1.7.0

    Declaration

    Swift

    public var createdByUserIds: [String]

  • Filters query results to include rooms that match the specified room IDs.

    Since

    1.7.0

    Declaration

    Swift

    public var roomIds: [String]

  • Filters query results to include rooms that were created between the specified range of time.

    Since

    1.7.0

    Declaration

    Swift

    public var createdAtRange: SendBirdRange

  • Filters query results to include rooms with the specified range of numbers for current participants.

    Since

    1.7.0

    Declaration

    Swift

    public var currentParticipantCountRange: SendBirdRange

  • Sets the number of rooms to be retrieved at once.

    Since

    1.7.0.

    Declaration

    Swift

    @discardableResult
@nonobjc
public func setLimit(_ limit: UInt) -> Self

  • Filters query results to include rooms with the specified room type.

    Since

    1.7.0.

    Declaration

    Swift

    @discardableResult
public func setType(_ type: RoomType) -> Self

  • Filters query results to include rooms that were created by specified user IDs.

    Since

    1.7.0

    Declaration

    Swift

    @discardableResult
@nonobjc
public func setCreatedByUserIds(_ userIds: [String]) -> Self

  • Filters query results to include rooms that match the specified room IDs.

    Since

    1.7.0

    Declaration

    Swift

    @discardableResult
@nonobjc
public func setRoomIds(_ roomIds: [String]) -> Self

  • Filters query results to include room with the specified room state.

    Since

    1.7.0.

    Declaration

    Swift

    @discardableResult
public func setState(_ state: Room.State) -> Self

  • Filters query results to include rooms with the specified range of numbers for current participants.

    Since

    1.7.0

    Declaration

    Swift

    @discardableResult
public func setRangeForCurrentParticipantCount(_ range: NSRange) -> Self

  • Filters query results to include rooms with the specified range of numbers for current participants.

    Since

    1.7.0

    Declaration

    Swift

    @discardableResult
public func setRangeForCurrentParticipantCount(_ range: PartialRangeFrom<UInt32>) -> Self

  • Filters query results to include rooms with the specified range of numbers for current participants.

    Since

    1.7.0

    Declaration

    Swift

    @discardableResult
public func setRangeForCurrentParticipantCount(_ range: PartialRangeUpTo<UInt32>) -> Self

  • Filters query results to include rooms with the specified range of numbers for current participants.

    Since

    1.7.0

    Declaration

    Swift

    @discardableResult
public func setRangeForCurrentParticipantCount(_ range: Swift.Range<UInt32>) -> Self

  • Filters query results to include rooms that were created between the specified range of time.

    Since

    1.7.0

    Declaration

    Swift

    @discardableResult
public func setRangeForCreatedAt(_ range: PartialRangeFrom<Date>) -> Self

  • Filters query results to include rooms that were created between the specified range of time.

    Since

    1.7.0

    Declaration

    Swift

    @discardableResult
public func setRangeForCreatedAt(_ range: PartialRangeUpTo<Date>) -> Self

  • Filters query results to include rooms that were created between the specified range of time.

    Since

    1.7.0

    Declaration

    Swift

    @discardableResult
public func setRangeForCreatedAt(_ range: Swift.Range<Date>) -> Self

  • Filters query results to include rooms that were created between the specified range of time.

    Since

    1.7.0

    Declaration

    Swift

    @discardableResult
public func setRangeForCreatedAt(_ range: NSRange) -> Self