Params

data class Params(state: LiveEventState?, types: List<LiveEventType>, createdAtRange: Range?, participantCountRange: Range?, durationRange: Range?, liveEventIds: List<String>, createdByUserIds: List<String>, limit: Int)

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

Since

1.0.0

Constructors

Link copied to clipboard
fun Params(state: LiveEventState? = null, types: List<LiveEventType> = emptyList(), createdAtRange: Range? = null, participantCountRange: Range? = null, durationRange: Range? = null, liveEventIds: List<String> = emptyList(), createdByUserIds: List<String> = emptyList(), limit: Int = 10)

Properties

Link copied to clipboard
val createdAtRange: Range? = null

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

Link copied to clipboard
val createdByUserIds: List<String>

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

Link copied to clipboard
val durationRange: Range? = null

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

Link copied to clipboard
val limit: Int = 10

Sets the number of rooms to be retrieved at once.

Link copied to clipboard
val liveEventIds: List<String>

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

Link copied to clipboard
val participantCountRange: Range? = null

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

Link copied to clipboard
val state: LiveEventState? = null

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

Link copied to clipboard
val types: List<LiveEventType>

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