2.9 KiB
Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference
{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}
LiveSessionResumptionUpdate interface
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
An update of the session resumption state.
This message is only sent if SessionResumptionConfig was set in the session setup.
Signature:
export interface LiveSessionResumptionUpdate
Properties
| Property | Type | Description |
|---|---|---|
| lastConsumedClientMessageIndex | number | (Public Preview) The index of the last client message that is included in the state represented by this update. |
| newHandle | string | (Public Preview) The new handle that represents the state that can be resumed. Empty if resumable is false. |
| resumable | boolean | (Public Preview) Indicates if the session can be resumed at this point. |
| type | 'sessionResumptionUpdate' | (Public Preview) |
LiveSessionResumptionUpdate.lastConsumedClientMessageIndex
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
The index of the last client message that is included in the state represented by this update.
Signature:
lastConsumedClientMessageIndex?: number;
LiveSessionResumptionUpdate.newHandle
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
The new handle that represents the state that can be resumed. Empty if resumable is false.
Signature:
newHandle?: string;
LiveSessionResumptionUpdate.resumable
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Indicates if the session can be resumed at this point.
Signature:
resumable?: boolean;
LiveSessionResumptionUpdate.type
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Signature:
type: 'sessionResumptionUpdate';