Member Junction
    Preparing search index...

    Interface RealtimeChannelsConfig

    The channels section of the realtime configuration cascade (RealtimeConfigSection.channels), and — after the app layer is mapped across — the shape every layer is normalized to.

    Keys mirror the persisted cascade JSON (realtime.channels.include, …).

    interface RealtimeChannelsConfig {
        config?: Record<string, JSONObject>;
        displayPolicy?: Record<string, RealtimeChannelDisplayPolicy>;
        exclude?: string[];
        include?: string[];
        requireZeroDataRetentionFor?: RealtimeZeroDataRetentionLevel[];
    }
    Index

    Properties

    config? displayPolicy? exclude? include? requireZeroDataRetentionFor?

    Properties

    config?: Record<string, JSONObject>

    Per-channel opaque configuration, delivered to the channel at session start.

    displayPolicy?: Record<string, RealtimeChannelDisplayPolicy>

    Per-channel display override.

    exclude?: string[]

    Channel keys to turn OFF. A hard veto: a host cannot lift it.

    include?: string[]

    Channel keys to turn ON. The only way to get an 'opt-in' channel; a no-op for 'all-sessions' ones.

    requireZeroDataRetentionFor?: RealtimeZeroDataRetentionLevel[]

    Exposure levels that need a zero-data-retention model. When the session model's configuration does not declare Privacy.ZeroDataRetention: true, exposure is lowered to below the lowest level listed (see ResolveChannelExposure). Applies to every channel in the session. Accumulates as a UNION across layers: a stricter layer's requirement is never loosened by another.

    Settings

    Member Visibility

    On This Page

    Properties