Documentation - v1.6.0-beta.24
    Preparing search index...

    Interface CreateConversationOptions

    Options passed to Proactive.createConversation(). Flattened — no nested Conversation wrapper.

    interface CreateConversationOptions {
        channelId: string;
        identity: ConversationClaims;
        parameters: Partial<ConversationParameters>;
        scope: string;
        serviceUrl: string;
        storeConversation?: boolean;
    }
    Index

    Properties

    channelId identity parameters scope serviceUrl storeConversation?

    Properties

    channelId: string

    The target channel (e.g. 'msteams').

    identity: ConversationClaims

    JWT claims for the agent identity. aud must be the agent's client ID.

    parameters: Partial<ConversationParameters>

    Conversation configuration passed to adapter.createConversationAsync().

    scope: string

    OAuth scope for token acquisition. Defaults to AzureBotScope when not set by the builder.

    serviceUrl: string

    The service URL for the channel.

    storeConversation?: boolean

    When true, the resulting Conversation is stored automatically after creation. Defaults to false.

    Settings

    Member Visibility

    On This Page

    Properties