@sovereignbase/actor-channel
    Preparing search index...

    Type Alias ChannelAttachment<Topic>

    Metadata and broker state associated with a channel.

    type ChannelAttachment<Topic> = {
        authenticated?: boolean;
        challenge?: Uint8Array;
        ipAddress?: string;
        rpcEnabled?: boolean;
        topics?: Set<Topic>;
    }

    Type Parameters

    • Topic
    Index
    authenticated? challenge? ipAddress? rpcEnabled? topics?
    authenticated?: boolean

    Whether the host authenticated the channel's application-level identity.

    challenge?: Uint8Array

    Let's you temporarily store a authentication challenge

    ipAddress?: string

    The channel's IP address, managed by the host.

    rpcEnabled?: boolean

    Whether the channel may issue RPC requests, managed automatically.

    topics?: Set<Topic>

    Topics currently subscribed by the channel, managed automatically.

    Settings
    Member Visibility

    On This Page
    Properties