Skip to content

Latest commit

 

History

History
27 lines (16 loc) · 1.18 KB

File metadata and controls

27 lines (16 loc) · 1.18 KB

WebidaRestfulApi.Session

Properties

Name Type Description Notes
id String the id of a session. usually same to socket id.
name String human readable name, usually derived from workspace name.
state String NORMAL = connected, normally working. CLOSING = server requested client to disconnect. Connection will be closed soon. TERMINATED = disconnected. server will remove this session from registry ASAP.
workspaceId String the id of workspace that this sessions is working on. If falsy, then this session is not belonged to any workpsace. Usually, dashboard / monitoring app will create a session without workspace id. [optional]
clientAddress String the peer address of session connection. not always
connectedAt Date the time when socket connection is established
willCloseAt Date when state becomes CLOSING, server sets this time as deadline. [optional]

Enum: StateEnum

  • NORMAL (value: "NORMAL")

  • CLOSING (value: "CLOSING")

  • TERMINATED (value: "TERMINATED")