Class ConversationBuilder

Fluent builder for the Conversation class.

Example

// Build from scratch
const conv = ConversationBuilder
  .create('my-client-id', 'msteams')
  .withUser('user-aad-id')
  .withConversationId('19:channel@thread.skype')
  .build()

// Build from a live TurnContext
const conv = ConversationBuilder.fromContext(turnContext).build()

Index

Methods

build withActivityId withConversation withConversationId withReference withUser create fromContext

Methods

build

build(): Conversation
Builds the Conversation, auto-filling serviceUrl from channel defaults if needed.

Returns Conversation
- Defined in packages/agents-hosting/src/app/proactive/conversationBuilder.ts:120

withActivityId

withActivityId(activityId: string): this
Sets reference.activityId.
Parameters
- activityId: string
Returns this
- Defined in packages/agents-hosting/src/app/proactive/conversationBuilder.ts:104

withConversation

withConversation(account: ConversationAccount): this
Sets reference.conversation from a full ConversationAccount.
Parameters
- account: ConversationAccount
Returns this
- Defined in packages/agents-hosting/src/app/proactive/conversationBuilder.ts:98

withConversationId

withConversationId(id: string): this
Sets reference.conversation.id.
Parameters
- id: string
Returns this
- Defined in packages/agents-hosting/src/app/proactive/conversationBuilder.ts:91

withReference

withReference(ref: Partial<ConversationReference>): this
Merges a partial ConversationReference into the current one. Useful for overlaying externally-provided reference data without losing fields set by earlier builder calls.
Parameters
- ref: Partial<ConversationReference>
Returns this
- Defined in packages/agents-hosting/src/app/proactive/conversationBuilder.ts:114

withUser

withUser(userId: string, userName?: string): this
Sets reference.user.
Parameters
- userId: string
- OptionaluserName: string
Returns this
- Defined in packages/agents-hosting/src/app/proactive/conversationBuilder.ts:84

`Static`create

create(
    agentClientId: string,
    channelId: string,
    serviceUrl?: string,
    requestorId?: string,
): ConversationBuilder
Creates a new builder for the given agent and channel.
Parameters
- agentClientId: string
- channelId: string
- OptionalserviceUrl: string
- OptionalrequestorId: string
  Optional: the client ID of the app making the request. Becomes the appid claim, used in multi-tenant Azure Bot scenarios.
Returns ConversationBuilder
- Defined in packages/agents-hosting/src/app/proactive/conversationBuilder.ts:51

`Static`fromContext

fromContext(context: TurnContext): ConversationBuilder
Creates a builder pre-populated from a live TurnContext. Captures both the conversation reference and the JWT identity claims.
Parameters
- context: TurnContext
Returns ConversationBuilder
- Defined in packages/agents-hosting/src/app/proactive/conversationBuilder.ts:66

Class ConversationBuilder

Example

Index

Methods

Methods

build

Returns Conversation

withActivityId

Parameters

Returns this

withConversation

Parameters

Returns this

withConversationId

Parameters

Returns this

withReference

Parameters

Returns this

withUser

Parameters

Returns this

`Static`create

Parameters

Returns ConversationBuilder

`Static`fromContext

Parameters

Returns ConversationBuilder

Settings

On This Page

Class ConversationBuilder

Example

Index

Methods

Methods

build

Returns Conversation

withActivityId

Parameters

Returns this

withConversation

Parameters

Returns this

withConversationId

Parameters

Returns this

withReference

Parameters

Returns this

withUser

Parameters

Returns this

Staticcreate

Parameters

Returns ConversationBuilder

StaticfromContext

Parameters

Returns ConversationBuilder

Settings

On This Page

`Static`create

`Static`fromContext