Documentation - v1.2.0-alpha.3
    Preparing search index...

    Interface CopilotStudioWebChatConnection

    Represents a connection interface for integrating Copilot Studio with WebChat.

    This interface provides the necessary methods and observables to facilitate bidirectional communication between a WebChat client and the Copilot Studio service.

    The connection follows the DirectLine protocol pattern, making it compatible with Microsoft Bot Framework WebChat components.

    interface CopilotStudioWebChatConnection {
        activity$: Observable<Partial<Activity>>;
        connectionStatus$: BehaviorSubject<number>;
        end(): void;
        postActivity(activity: Activity): Observable<string>;
    }
    Index

    Properties

    activity$ connectionStatus$

    Methods

    end postActivity

    Properties

    activity$: Observable<Partial<Activity>>

    An observable stream that emits incoming activities from the Copilot Studio service. Each activity represents a message, card, or other interactive element sent by the agent.

    All emitted activities include:

    • A timestamp indicating when the activity was received
    • A 'webchat:sequence-id' in their channelData for proper message ordering
    • Standard Bot Framework Activity properties (type, text, attachments, etc.)
    connectionStatus$: BehaviorSubject<number>

    An observable that emits the current connection status as numeric values. This allows WebChat clients to monitor and react to connection state changes.

    Connection status values:

    • 0: Disconnected - No active connection to the service
    • 1: Connecting - Attempting to establish connection
    • 2: Connected - Successfully connected and ready for communication

    Methods

    • Gracefully terminates the connection to the Copilot Studio service. This method ensures proper cleanup by completing all active observables and releasing associated resources.

      After calling this method:

      • The connectionStatus$ observable will be completed
      • The activity$ observable will stop emitting new activities
      • No further activities can be posted through this connection

      Returns void

    • Posts a user activity to the Copilot Studio service and returns an observable that emits the activity ID once the message is successfully sent.

      The method validates that the activity contains meaningful content and handles the complete message flow including optional typing indicators.

      Parameters

      • activity: Activity

        The user activity to send.

      Returns Observable<string>

      An observable that emits the unique activity ID upon successful posting.

      Error if the activity text is empty or if the connection is not properly initialized.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods