DellaBittaandGitHub
1ede45b3c5
### Discussion Support the handling of Going Away notifications in the Live Service. The service may send this event when the session is coming to a close due to timeout or nearing a token limit. ### Testing Unit tests added. Manual testing. ### API Changes See internal [API proposal](https://goto.google.com/fal-firebase-api-live-api-goaway-message).
1.6 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 %}
LiveServerGoingAwayNotice 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.
Notification that the server will not be able to service the client soon.
Signature:
export interface LiveServerGoingAwayNotice
Properties
| Property | Type | Description |
|---|---|---|
| timeLeft | number | (Public Preview) The remaining time (in seconds) before the connection will be terminated. |
| type | 'goingAwayNotice' | (Public Preview) |
LiveServerGoingAwayNotice.timeLeft
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 remaining time (in seconds) before the connection will be terminated.
Signature:
timeLeft: number;
LiveServerGoingAwayNotice.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: 'goingAwayNotice';