Message: update / connectionDisconnect (bidirectional)

Back to overview

Indicates that the sending peer is about to close the connection.

This message SHOULD be sent before the peer closes the SaltyRTC connection.

Args

None

Data

Field Description Type Optional Nullable
reason

The disconnect reason.

  • "stop": The session SHALL be stopped by the receiving peer.
  • "delete": The session MUST be stopped and deleted by the receiving peer.
  • "disable": The web client has been disabled in the app and the receiving peer SHALL stop the session.
  • "replace": The session has been replaced by another and the receiving peer MUST stop the session.
  • "oom": The session had to be stopped as the device ran out of memory.
  • "error": The session was stopped because an error occurred.

Allowed values: "stop", "delete", "disable", "replace", "oom", "error"

String False False