ConversationReferenceBuilder class

Package:

@microsoft/agents-hosting

Fluent builder for ConversationReference.

Methods

build()	Builds and returns the ConversationReference.
create(string, string, string)	Creates a new builder seeded with the agent identity and channel. On Teams, the agent id is prefixed with 28: automatically.
serviceUrlForChannel(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).
withActivityId(string)	Sets reference.activityId.
withAgent(ChannelAccount)	Sets reference.agent from a full ChannelAccount.
withAgent(string, string)	Sets reference.agent from an id + optional name. Role defaults to RoleTypes.Agent. On Teams, id is prefixed with 28:.
withConversationId(string)	Sets reference.conversation.id.
withLocale(string)	Sets reference.locale.
withServiceUrl(string)	Sets reference.serviceUrl.
withUser(ChannelAccount)	Sets reference.user from a full ChannelAccount.
withUser(string, string)	Sets reference.user from an id + optional name. Role defaults to RoleTypes.User.

Method Details

build()

Builds and returns the ConversationReference.

function build(): ConversationReference

Returns

ConversationReference

create(string, string, string)

Creates a new builder seeded with the agent identity and channel. On Teams, the agent id is prefixed with 28: automatically.

static function create(agentClientId: string, channelId: string, serviceUrl?: string): ConversationReferenceBuilder

Parameters

agentClientId

string

The agent's client (app) ID.

channelId

string

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

serviceUrl

string

Optional override. If omitted, build() fills in the channel default via serviceUrlForChannel().

Returns

ConversationReferenceBuilder

serviceUrlForChannel(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).

static function serviceUrlForChannel(channelId: string): string

Parameters

channelId

string

Returns

string

withActivityId(string)

Sets reference.activityId.

function withActivityId(activityId: string): ConversationReferenceBuilder

Parameters

activityId

string

Returns

ConversationReferenceBuilder

withAgent(ChannelAccount)

Sets reference.agent from a full ChannelAccount.

function withAgent(account: ChannelAccount): ConversationReferenceBuilder

Parameters

account

ChannelAccount

Returns

ConversationReferenceBuilder

withAgent(string, string)

Sets reference.agent from an id + optional name. Role defaults to RoleTypes.Agent. On Teams, id is prefixed with 28:.

function withAgent(agentClientId: string, agentName?: string): ConversationReferenceBuilder

Parameters

agentClientId

string

agentName

string

Returns

ConversationReferenceBuilder

withConversationId(string)

Sets reference.conversation.id.

function withConversationId(id: string): ConversationReferenceBuilder

Parameters

id

string

Returns

ConversationReferenceBuilder

withLocale(string)

Sets reference.locale.

function withLocale(locale: string): ConversationReferenceBuilder

Parameters

locale

string

Returns

ConversationReferenceBuilder

withServiceUrl(string)

Sets reference.serviceUrl.

function withServiceUrl(serviceUrl: string): ConversationReferenceBuilder

Parameters

serviceUrl

string

Returns

ConversationReferenceBuilder

withUser(ChannelAccount)

Sets reference.user from a full ChannelAccount.

function withUser(account: ChannelAccount): ConversationReferenceBuilder

Parameters

account

ChannelAccount

Returns

ConversationReferenceBuilder

withUser(string, string)

Sets reference.user from an id + optional name. Role defaults to RoleTypes.User.

function withUser(userId: string, userName?: string): ConversationReferenceBuilder

Parameters

userId

string

userName

string

Returns

ConversationReferenceBuilder