Ably · Schema

namespace_patch

RealtimeWebSocketsPub/SubMessagingStreamingPush NotificationsChatLiveSync

Properties

Name	Type	Description
authenticated	boolean	If `true`, clients will not be permitted to use (including to attach, publish, or subscribe) any channels within this namespace unless they are identified, that is, authenticated using a client ID. Se
persisted	boolean	If `true`, all messages on a channel will be stored for 24 hours. You can access stored messages via the History API. Please note that for each message stored, an additional message is deducted from y
persistLast	boolean	If `true`, the last message published on a channel will be stored for 365 days. You can access the stored message only by using the channel rewind mechanism and attaching with rewind=1. Please note th
pushEnabled	boolean	If `true`, publishing messages with a push payload in the extras field is permitted and can trigger the delivery of a native push notification to registered devices for the channel.
batchingEnabled	boolean	If `true`, channels within this namespace will start batching inbound messages instead of sending them out immediately to subscribers.
batchingPolicy	string	If `true`, groups multiple incoming messages into a single batch.
batchingInterval	integer	If `true`, the batching interval, configurable from 20ms to 1s, temporarily holds and aggregates incoming messages. These messages are then combined and delivered as a single batch once the interval e
tlsOnly	boolean	If `true`, only clients that are connected using TLS will be permitted to subscribe to any channels within this namespace.
exposeTimeserial	boolean	If `true`, messages received on a channel will contain a unique `timeserial` that can be referenced by later messages for use with message interactions.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/namespace_patch",
  "title": "namespace_patch",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "authenticated": {
      "type": "boolean",
      "default": false,
      "description": "If `true`, clients will not be permitted to use (including to attach, publish, or subscribe) any channels within this namespace unless they are identified, that is, authenticated using a client ID. See the documentation for <a href=\"https://ably.com/docs/auth/identified-clients\">identified clients</a> for more details.",
      "example": false
    },
    "persisted": {
      "type": "boolean",
      "default": false,
      "description": "If `true`, all messages on a channel will be stored for 24 hours. You can access stored messages via the History API. Please note that for each message stored, an additional message is deducted from your monthly allocation.",
      "example": false
    },
    "persistLast": {
      "type": "boolean",
      "default": false,
      "description": "If `true`, the last message published on a channel will be stored for 365 days. You can access the stored message only by using the channel rewind mechanism and attaching with rewind=1. Please note that for each message stored, an additional message is deducted from your monthly allocation.",
      "example": false
    },
    "pushEnabled": {
      "type": "boolean",
      "default": false,
      "description": "If `true`, publishing messages with a push payload in the extras field is permitted and can trigger the delivery of a native push notification to registered devices for the channel.",
      "example": false
    },
    "batchingEnabled": {
      "type": "boolean",
      "default": false,
      "description": "If `true`, channels within this namespace will start batching inbound messages instead of sending them out immediately to subscribers."
    },
    "batchingPolicy": {
      "type": "string",
      "default": "simple",
      "description": "If `true`, groups multiple incoming messages into a single batch.",
      "example": "simple"
    },
    "batchingInterval": {
      "type": "integer",
      "default": 20,
      "description": "If `true`, the batching interval, configurable from 20ms to 1s, temporarily holds and aggregates incoming messages. These messages are then combined and delivered as a single batch once the interval elapses or a size limit is reached (before the interval elapses).",
      "example": 20
    },
    "tlsOnly": {
      "type": "boolean",
      "default": false,
      "description": "If `true`, only clients that are connected using TLS will be permitted to subscribe to any channels within this namespace.",
      "example": false
    },
    "exposeTimeserial": {
      "type": "boolean",
      "description": "If `true`, messages received on a channel will contain a unique `timeserial` that can be referenced by later messages for use with message interactions."
    }
  }
}