Class ConversationReferenceBuilder

Fluent builder for ConversationReference.

Index

Methods

build withActivityId withAgent withConversationId withLocale withServiceUrl withUser create serviceUrlForChannel

Methods

build

build(): ConversationReference
Builds and returns the ConversationReference.

Returns ConversationReference
- Defined in packages/agents-hosting/src/app/proactive/conversationReferenceBuilder.ts:132

withActivityId

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

withAgent

withAgent(agentClientId: string, agentName?: string): this
Sets reference.agent from an id + optional name. Role defaults to RoleTypes.Agent. On Teams, id is prefixed with 28:.
Parameters
- agentClientId: string
- OptionalagentName: string
Returns this
- Defined in packages/agents-hosting/src/app/proactive/conversationReferenceBuilder.ts:97
withAgent(account: ChannelAccount): this
Sets reference.agent from a full ChannelAccount.
Parameters
- account: ChannelAccount
Returns this
- Defined in packages/agents-hosting/src/app/proactive/conversationReferenceBuilder.ts:99

withConversationId

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

withLocale

withLocale(locale: string): this
Sets reference.locale.
Parameters
- locale: string
Returns this
- Defined in packages/agents-hosting/src/app/proactive/conversationReferenceBuilder.ts:126

withServiceUrl

withServiceUrl(serviceUrl: string): this
Sets reference.serviceUrl.
Parameters
- serviceUrl: string
Returns this
- Defined in packages/agents-hosting/src/app/proactive/conversationReferenceBuilder.ts:108

withUser

withUser(userId: string, userName?: string): this
Sets reference.user from an id + optional name. Role defaults to RoleTypes.User.
Parameters
- userId: string
- OptionaluserName: string
Returns this
- Defined in packages/agents-hosting/src/app/proactive/conversationReferenceBuilder.ts:86
withUser(account: ChannelAccount): this
Sets reference.user from a full ChannelAccount.
Parameters
- account: ChannelAccount
Returns this
- Defined in packages/agents-hosting/src/app/proactive/conversationReferenceBuilder.ts:88

`Static`create

create(
    agentClientId: string,
    channelId: string,
    serviceUrl?: string,
): ConversationReferenceBuilder
Creates a new builder seeded with the agent identity and channel. On Teams, the agent id is prefixed with 28: automatically.
Parameters
- agentClientId: string
  The agent's client (app) ID.
- channelId: string
  The target channel (e.g. 'msteams', 'webchat').
- OptionalserviceUrl: string
  Optional override. If omitted, build() fills in the channel default via serviceUrlForChannel().
Returns ConversationReferenceBuilder
- Defined in packages/agents-hosting/src/app/proactive/conversationReferenceBuilder.ts:56

`Static`serviceUrlForChannel

serviceUrlForChannel(channelId: string): string
Returns the default service URL for a channel. Teams returns the public global endpoint; all other channels use the https://{channelId}.botframework.com/ pattern (matching C# behavior).
Parameters
- channelId: string
Returns string
- Defined in packages/agents-hosting/src/app/proactive/conversationReferenceBuilder.ts:73