@openfloor/protocol - v0.0.4
    Preparing search index...

    Variable default

    default: {
        BotAgent: typeof BotAgent;
        ByeEvent: typeof ByeEvent;
        Capability: typeof Capability;
        ContextEvent: typeof ContextEvent;
        ConvenerAgent: typeof ConvenerAgent;
        Conversant: typeof Conversant;
        Conversation: typeof Conversation;
        createBasicManifest: (
            options: {
                capabilities?: string[];
                department?: string;
                description: string;
                name: string;
                organization: string;
                role?: string;
                serviceUrl: string;
                speakerUri: string;
            },
        ) => Manifest;
        createPayload: (envelope: Envelope) => Payload;
        createSimpleEnvelope: (
            options: {
                conversationId?: string;
                events?: Event[];
                schemaUrl?: string;
                schemaVersion?: string;
                senderServiceUrl?: string;
                senderUri: string;
            },
        ) => Envelope;
        createTextUtterance: (
            options: {
                confidence?: number;
                lang?: string;
                speakerUri: string;
                text: string;
                to?: { private?: boolean; serviceUrl?: string; speakerUri?: string };
            },
        ) => UtteranceEvent;
        DeclineInviteEvent: typeof DeclineInviteEvent;
        DialogEvent: typeof DialogEvent;
        Envelope: typeof Envelope;
        Event: typeof Event;
        Feature: typeof Feature;
        FloorManager: typeof FloorManager;
        GetManifestsEvent: typeof GetManifestsEvent;
        GrantFloorEvent: typeof GrantFloorEvent;
        Identification: typeof Identification;
        InviteEvent: typeof InviteEvent;
        Manifest: typeof Manifest;
        OPEN_FLOOR_PROTOCOL: {
            description: "Open Floor Protocol implementation for JavaScript/TypeScript";
            documentation: "https://github.com/open-voice-interoperability/openfloor-js#readme";
            name: "@openfloor/protocol";
            repository: "https://github.com/open-voice-interoperability/openfloor-js";
            specifications: {
                dialogEvent: "1.0.2";
                envelope: "1.0.0";
                manifest: "1.0.0";
            };
            version: "0.0.1";
        };
        OpenFloorAgent: typeof OpenFloorAgent;
        parsePayload: (jsonString: string) => Payload;
        Payload: typeof Payload;
        PublishManifestsEvent: typeof PublishManifestsEvent;
        RequestFloorEvent: typeof RequestFloorEvent;
        RevokeFloorEvent: typeof RevokeFloorEvent;
        Schema: typeof Schema;
        Sender: typeof Sender;
        Span: typeof Span;
        SupportedLayers: typeof SupportedLayers;
        TextFeature: typeof TextFeature;
        To: typeof To;
        Token: typeof Token;
        UninviteEvent: typeof UninviteEvent;
        UtteranceEvent: typeof UtteranceEvent;
        validateAndParsePayload: (
            jsonString: string,
        ) => { errors: string[]; payload?: Payload; valid: boolean };
        validateDialogEvent: (data: unknown) => ValidationResult;
        validateEnvelope: (data: unknown) => ValidationResult;
        validateManifest: (data: unknown) => ValidationResult;
        VERSION: "0.0.1";
        YieldFloorEvent: typeof YieldFloorEvent;
    }

    Default export with all main classes for convenient importing

    Type declaration

    • BotAgent: typeof BotAgent
    • ByeEvent: typeof ByeEvent
    • Capability: typeof Capability
    • ContextEvent: typeof ContextEvent
    • ConvenerAgent: typeof ConvenerAgent
    • Conversant: typeof Conversant
    • Conversation: typeof Conversation
    • createBasicManifest: (
          options: {
              capabilities?: string[];
              department?: string;
              description: string;
              name: string;
              organization: string;
              role?: string;
              serviceUrl: string;
              speakerUri: string;
          },
      ) => Manifest
    • createPayload: (envelope: Envelope) => Payload
    • createSimpleEnvelope: (
          options: {
              conversationId?: string;
              events?: Event[];
              schemaUrl?: string;
              schemaVersion?: string;
              senderServiceUrl?: string;
              senderUri: string;
          },
      ) => Envelope
    • createTextUtterance: (
          options: {
              confidence?: number;
              lang?: string;
              speakerUri: string;
              text: string;
              to?: { private?: boolean; serviceUrl?: string; speakerUri?: string };
          },
      ) => UtteranceEvent
    • DeclineInviteEvent: typeof DeclineInviteEvent
    • DialogEvent: typeof DialogEvent
    • Envelope: typeof Envelope
    • Event: typeof Event
    • Feature: typeof Feature
    • FloorManager: typeof FloorManager
    • GetManifestsEvent: typeof GetManifestsEvent
    • GrantFloorEvent: typeof GrantFloorEvent
    • Identification: typeof Identification
    • InviteEvent: typeof InviteEvent
    • Manifest: typeof Manifest
    • OPEN_FLOOR_PROTOCOL: {
          description: "Open Floor Protocol implementation for JavaScript/TypeScript";
          documentation: "https://github.com/open-voice-interoperability/openfloor-js#readme";
          name: "@openfloor/protocol";
          repository: "https://github.com/open-voice-interoperability/openfloor-js";
          specifications: {
              dialogEvent: "1.0.2";
              envelope: "1.0.0";
              manifest: "1.0.0";
          };
          version: "0.0.1";
      }
    • OpenFloorAgent: typeof OpenFloorAgent
    • parsePayload: (jsonString: string) => Payload
    • Payload: typeof Payload
    • PublishManifestsEvent: typeof PublishManifestsEvent
    • RequestFloorEvent: typeof RequestFloorEvent
    • RevokeFloorEvent: typeof RevokeFloorEvent
    • Schema: typeof Schema
    • Sender: typeof Sender
    • Span: typeof Span
    • SupportedLayers: typeof SupportedLayers
    • TextFeature: typeof TextFeature
    • To: typeof To
    • Token: typeof Token
    • UninviteEvent: typeof UninviteEvent
    • UtteranceEvent: typeof UtteranceEvent
    • validateAndParsePayload: (jsonString: string) => { errors: string[]; payload?: Payload; valid: boolean }
    • validateDialogEvent: (data: unknown) => ValidationResult
    • validateEnvelope: (data: unknown) => ValidationResult
    • validateManifest: (data: unknown) => ValidationResult
    • VERSION: "0.0.1"
    • YieldFloorEvent: typeof YieldFloorEvent