Editor API Reference - v1.1.16
    Preparing search index...

    Type Alias MessagerClient

    MessagerClient: Events & {
        isConnected: boolean;
        authenticate(accessToken: string, role: string): void;
        connect(url: string): void;
        projectWatch(projectId: string): void;
    }

    The MessagerClient interface extends the Events class and defines the methods and properties required for the Messenger client.

    Type declaration

    • isConnected: boolean

      Indicates whether the client is connected.

    • authenticate: function
      • Authenticates the client with the specified access token and role.

        Parameters

        • accessToken: string

          The access token for authentication.

        • role: string

          The role for authentication.

        Returns void

    • connect: function
      • Connects to the specified URL.

        Parameters

        • url: string

          The URL to connect to.

        Returns void

    • projectWatch: function
      • Watches the specified project.

        Parameters

        • projectId: string

          The ID of the project to watch.

        Returns void