ChannelConfig

  • anonymous
    Type: boolean
    required

    Whether anonymous users may connect.

  • extensions
    Type: object
    required

    Extensions attached to this channel, keyed by handle. Namespaces must be exclusive within a channel.

    • propertyName
      Type: object · ExtensionManifest

      A channel extension attachment.

      • namespace
        Type: string
        required

        The extension namespace (for example poll.).

      • script
        Type: string
        required

        The bundled extension script name.

      • transport
        Type: string
        required

        The extension transport (for example ws).

  • hooks
    Type: object · HooksManifest
    required

    What hooks a channel's config references (capabilities only, never code).

    • authz
      Type: boolean

      Whether the channel runs custom authorization on connect/publish.

    • notify
      Type: boolean

      Whether a notify hook is wired.

    • onDisconnect
      Type: integer

      The number of onDisconnect hooks.

    • onPublish
      Type: integer

      The number of onPublish hooks in the chain.

  • mode
    Type: string enum
    required

    Channel mode. standard has a roster and presence; broadcast does not.

    values
    • standard
    • broadcast