Ably · Schema

ChannelDetails

RealtimeWebSocketsPub/SubMessagingStreamingPush NotificationsChatLiveSync

Properties

Name Type Description
channelId string The required name of the channel including any qualifier, if any.
region string In events relating to the activity of a channel in a specific region, this optionally identifies the region.
isGlobalMaster boolean In events relating to the activity of a channel in a specific region, this optionally identifies whether or not that region is responsible for global coordination of the channel.
status object
View JSON Schema on GitHub

JSON Schema

ably-channeldetails-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ChannelDetails",
  "title": "ChannelDetails",
  "type": "object",
  "properties": {
    "channelId": {
      "type": "string",
      "description": "The required name of the channel including any qualifier, if any."
    },
    "region": {
      "type": "string",
      "description": "In events relating to the activity of a channel in a specific region, this optionally identifies the region."
    },
    "isGlobalMaster": {
      "type": "boolean",
      "description": "In events relating to the activity of a channel in a specific region, this optionally identifies whether or not that region is responsible for global coordination of the channel."
    },
    "status": {
      "$ref": "#/components/schemas/ChannelStatus"
    }
  },
  "required": [
    "channelId"
  ]
}