Cluster Creator Kit Script Reference
    Preparing search index...

    Interface CallExternalStreamEventItem

    Represents an event that occurs when receiving external communication streaming.

    interface CallExternalStreamEvent {
        data: string | null;
        errorReason: string | null;
        meta: string;
        type: "message" | "complete" | "error";
    }
    Index

    Properties

    data errorReason meta type

    Properties

    data: string | null

    If type is "message", the data payload of the server-sent event is stored.
    If type is any other value, it will be null.

    errorReason: string | null

    If type is "error", a string indicating the error details is stored.
    If type is any other value, it will be null.

    meta: string

    Returns the same value as the meta specified in ClusterScript.callExternalStream.

    type: "message" | "complete" | "error"

    Represents the type of the event.

    Settings

    Member Visibility

    On This Page

    Properties