Ably · Schema

ChannelStatus

A ChannelStatus instance.

RealtimeWebSocketsPub/SubMessagingStreamingPush NotificationsChatLiveSync

Properties

Name Type Description
isActive boolean A required boolean value indicating whether the channel that is the subject of the event is active. For events indicating regional activity of a channel this indicates activity in that region, not glo
occupancy object
View JSON Schema on GitHub

JSON Schema

ably-channelstatus-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ChannelStatus",
  "title": "ChannelStatus",
  "type": "object",
  "description": "A ChannelStatus instance.",
  "properties": {
    "isActive": {
      "type": "boolean",
      "description": "A required boolean value indicating whether the channel that is the subject of the event is active. For events indicating regional activity of a channel this indicates activity in that region, not global activity."
    },
    "occupancy": {
      "$ref": "#/components/schemas/Occupancy"
    }
  },
  "required": [
    "isActive"
  ]
}