Member Junction
    Preparing search index...

    The result of running a channel verb (or opening a channel).

    Structured on purpose: the dispatcher turns a failure into a model-recoverable message, which it can only do well when it knows why the call failed (ErrorCode) rather than having to parse prose out of a JSON string.

    interface RealtimeChannelVerbResult {
        Details?: string[];
        Error?: string;
        ErrorCode?: string;
        Instance?: string;
        Result?: JSONValue;
        Success: boolean;
    }
    Index

    Properties

    Details?: string[]

    Specifics of the failure (e.g. each schema violation).

    Error?: string

    A message the model can read and act on. Present only on failure.

    ErrorCode?: string

    A stable machine-readable failure code (e.g. 'invalid_params'). Present only on failure.

    Instance?: string

    The instance a successful open created (or acted on), for a RealtimeChannelDescriptor.MultiInstance channel. Returned from OnOpen so the opened note, the opened event and the open result name the instance that was just created rather than the channel's primary one. Ignored by single-instance channels.

    Result?: JSONValue

    The verb's result, when it has one.

    Success: boolean

    Whether the verb did what was asked.