Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryOptions

Defines the structure for options which can be sent to Collaboration query endpoints.

Hierarchy

  • QueryOptions

Index

Properties

Properties

Optional activeRoomsOnly

activeRoomsOnly: boolean

Return data for active rooms only.

Optional dateRange

dateRange: object

Filter results by Data range.

Type declaration

  • end: Date

    End date.

  • start: Date

    Start date.

Optional eventTypes

eventTypes: string[]

Return events matching the following event type.

Optional getAfterId

getAfterId: string

Return events which occured after this Id.

Optional getBeforeId

getBeforeId: string

Return events which occured before this Id.

Optional pageSize

pageSize: number

The number of events to return.

rooms

rooms: string[]

An array of Room ids to fetch events for.