Member Junction
    Preparing search index...

    Type Alias WhiteboardWidgetChannelMessage

    WhiteboardWidgetChannelMessage:
        | {
            Actions: WhiteboardWidgetActionInfo[];
            DocumentToken: string;
            HasState: boolean;
            ItemID: string;
            Kind: "ready";
        }
        | {
            Actions: WhiteboardWidgetActionInfo[];
            ItemID: string;
            Kind: "actions";
        }
        | {
            DocumentToken?: string;
            ItemID: string;
            Kind: "state";
            StateJson: string;
        }
        | { ItemID: string; Kind: "reply"; Reply: WhiteboardWidgetReply }

    A validated message from a widget's helper (everything except submit / interaction).

    Type Declaration

    • {
          Actions: WhiteboardWidgetActionInfo[];
          DocumentToken: string;
          HasState: boolean;
          ItemID: string;
          Kind: "ready";
      }
      • Actions: WhiteboardWidgetActionInfo[]
      • DocumentToken: string

        Random token minted once per widget DOCUMENT. A repeated ready with the same token (e.g. the answer to hello) is the same document; a new token means it reloaded.

      • HasState: boolean
      • ItemID: string
      • Kind: "ready"
    • { Actions: WhiteboardWidgetActionInfo[]; ItemID: string; Kind: "actions" }
    • { DocumentToken?: string; ItemID: string; Kind: "state"; StateJson: string }
      • OptionalDocumentToken?: string

        The sending document's token (as on its ready), when the helper supplies one.

      • ItemID: string
      • Kind: "state"
      • StateJson: string
    • { ItemID: string; Kind: "reply"; Reply: WhiteboardWidgetReply }