ListenSessionEventsDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
A poll's response.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description |
|---|---|---|
events
required |
array of ListenSessionEventDto array of ListenSessionEventDto | Events after the cursor, oldest first.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of each ListenSessionEventDto: This body has no documented fields. | ||
nextCursorUtc
required |
string (date-time) | The cursor to send on the next poll: the staging instant of the last event returned, or the
cursor the caller sent when nothing was returned.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
agedOutGap
required |
boolean | Set when the caller's cursor predates the oldest event still buffered, meaning events expired
before they were read.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
oldestAvailableUtc
required |
string (date-time) | The staging instant of the oldest event still buffered, when there is a gap.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
expiresAtUtc
required |
string (date-time) | When the session now expires, after this poll renewed it.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This model has no documented fields.