LiveEventListQueryParams

public struct LiveEventListQueryParams

A class that provides parameters that are used to query a list of live events.

Since

1.0.0

  • Filters query results to include live events with the specified live event state.

    Since

    1.0.0

    Declaration

    Swift

    public var state: LiveEvent.State?

  • Filters query results to include live events that were created within the specified ragne, in Unixmilliseconds.

    Since

    1.0.0

    Declaration

    Swift

    public var createdAtRange: Range<Int64>?

  • Filters query results to include live events of which the number of current participants is within the specified range.

    Since

    1.0.0

    Declaration

    Swift

    public var participantCountRange: Range<Int>?

  • Filters query to include live events of which the duration is within the specified range.

    Since

    1.0.0

    Declaration

    Swift

    public var durationRange: Range<Int64>?

  • Filters query to include live events with the specified live event IDs.

    Since

    1.0.0

    Declaration

    Swift

    public var liveEventIds: [String]

  • Filters query to include live events that were created by the specified user IDs.

    Since

    1.0.0

    Declaration

    Swift

    public var createdByUserIds: [String]

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

    Since

    1.0.0

    Declaration

    Swift

    public var limit: Int

  • Undocumented

    Declaration

    Swift

    public init(
    limit: Int = 10,
    state: LiveEvent.State?,
    createdAtRange: Range<Int64>?,
    participantCountRange: Range<Int>?,
    durationRange: Range<Int64>?,
    liveEventIds: [String],
    createdByUserIds: [String]
)

  • Undocumented

    Declaration

    Swift

    public init()