RealtimeRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RealtimeRequest",
  "title": "RealtimeRequest",
  "properties": {
    "isKeepAliveEnabled": {
      "description": "This represents that a json message {\\\"keepalive\\\":\\\"true\\\"} is expected over the websocket connection from Client. This should be sent periodically (usually 4s). If there are no keep-alive messages from the client for a period of 15 seconds, the server will drop the websocket.",
      "example": true,
      "default": true,
      "type": "boolean"
    },
    "clientType": {
      "description": "ClientType is used to identify a web application differently from other web applications. It is used to group connections together for a specific user coming from that specific web application.",
      "example": "ExtensiveSupervisoryDesktop",
      "default": "DefaultClient",
      "type": "string",
      "maxLength": 64,
      "minLength": 4
    },
    "allowMultiLogin": {
      "description": "This cannot be used without providing \\\"clientType\\\". When set to true, it informs the server to allow multiple logins for this user coming from the same clientType. Upto 10 multiple logins will be allowed.",
      "example": false,
      "default": false,
      "maxLength": 64,
      "minLength": 4,
      "type": "boolean"
    },
    "force": {
      "description": "When true, will drop a random connection and then subscribes if connections for a user exceed maximum limit. When allowMultiLogin is false and a multi-login is attempted, if set to true will drop all connections for that user of that clientType & then subscribes.",
      "example": false,
      "default": false,
      "maxLength": 64,
      "minLength": 4,
      "type": "boolean"
    }
  },
  "type": "object"
}