Class CreateConversationOptionsBuilder

Fluent builder for CreateConversationOptions.

Example

const opts = CreateConversationOptionsBuilder
  .create('my-client-id', 'msteams')
  .withUser('user-aad-id')
  .withTenantId('tenant-id')
  .build()

Index

Methods

build isGroup storeConversation withActivity withChannelData withScope withTeamsChannelId withTenantId withTopicName withUser create

Methods

build

build(): CreateConversationOptions
Builds and returns CreateConversationOptions.

Returns CreateConversationOptions
Throws
if no members were added via withUser().
- Defined in packages/agents-hosting/src/app/proactive/createConversationOptionsBuilder.ts:162

isGroup

isGroup(value: boolean): this
Sets parameters.isGroup.
Parameters
- value: boolean
Returns this
- Defined in packages/agents-hosting/src/app/proactive/createConversationOptionsBuilder.ts:141

storeConversation

storeConversation(value: boolean): this
Controls whether the resulting conversation is stored after creation.
Parameters
- value: boolean
Returns this
- Defined in packages/agents-hosting/src/app/proactive/createConversationOptionsBuilder.ts:153

withActivity

withActivity(activity: Partial<Activity>): this
Sets parameters.activity. Defaults activity.type to 'message' if not provided.
Parameters
- activity: Partial<Activity>
Returns this
- Defined in packages/agents-hosting/src/app/proactive/createConversationOptionsBuilder.ts:97

withChannelData

withChannelData(data: object): this
Merges additional channel-specific data into parameters.channelData.
Parameters
- data: object
Returns this
- Defined in packages/agents-hosting/src/app/proactive/createConversationOptionsBuilder.ts:103

withScope

withScope(scope: string): this
Overrides the default AzureBotScope OAuth scope.
Parameters
- scope: string
Returns this
- Defined in packages/agents-hosting/src/app/proactive/createConversationOptionsBuilder.ts:147

withTeamsChannelId

withTeamsChannelId(teamsChannelId: string): this
Sets parameters.isGroup = true and channelData.channel.id. Only has effect on msteams channels.
Parameters
- teamsChannelId: string
Returns this
- Defined in packages/agents-hosting/src/app/proactive/createConversationOptionsBuilder.ts:127

withTenantId

withTenantId(tenantId: string): this
Sets parameters.tenantId. On msteams channels, also sets channelData.tenant.id.
Parameters
- tenantId: string
Returns this
- Defined in packages/agents-hosting/src/app/proactive/createConversationOptionsBuilder.ts:115

withTopicName

withTopicName(name: string): this
Sets parameters.topicName.
Parameters
- name: string
Returns this
- Defined in packages/agents-hosting/src/app/proactive/createConversationOptionsBuilder.ts:135

withUser

withUser(userId: string, userName?: string): this
Adds a member (the target user) to parameters.members.
Parameters
- userId: string
- OptionaluserName: string
Returns this
- Defined in packages/agents-hosting/src/app/proactive/createConversationOptionsBuilder.ts:83
withUser(account: ChannelAccount): this
Adds a member (the target user) to parameters.members.
Parameters
- account: ChannelAccount
Returns this
- Defined in packages/agents-hosting/src/app/proactive/createConversationOptionsBuilder.ts:84

`Static`create

create(
    agentClientId: string,
    channelId: string,
    serviceUrl?: string,
    parameters?: Partial<ConversationParameters>,
): CreateConversationOptionsBuilder
Creates a new builder from an agent client ID string.
Parameters
- agentClientId: string
  The agent's client (app) ID.
- channelId: string
  The target channel (e.g. 'msteams').
- OptionalserviceUrl: string
  Optional service URL override.
- Optionalparameters: Partial<ConversationParameters>
Returns CreateConversationOptionsBuilder
- Defined in packages/agents-hosting/src/app/proactive/createConversationOptionsBuilder.ts:48
create(
    claims: ConversationClaims,
    channelId: string,
    serviceUrl?: string,
    parameters?: Partial<ConversationParameters>,
): CreateConversationOptionsBuilder
Creates a new builder from an existing claims object (e.g. from a stored Conversation).
Parameters
- claims: ConversationClaims
  JWT claims — aud must be the agent's client ID.
- channelId: string
  The target channel (e.g. 'msteams').
- OptionalserviceUrl: string
  Optional service URL override.
- Optionalparameters: Partial<ConversationParameters>
Returns CreateConversationOptionsBuilder
- Defined in packages/agents-hosting/src/app/proactive/createConversationOptionsBuilder.ts:55

Class CreateConversationOptionsBuilder

Example

Index

Methods

Methods

build

Returns CreateConversationOptions

Throws

isGroup

Parameters

Returns this

storeConversation

Parameters

Returns this

withActivity

Parameters

Returns this

withChannelData

Parameters

Returns this

withScope

Parameters

Returns this

withTeamsChannelId

Parameters

Returns this

withTenantId

Parameters

Returns this

withTopicName

Parameters

Returns this

withUser

Parameters

Returns this

Parameters

Returns this

Staticcreate

Parameters

Returns CreateConversationOptionsBuilder

Parameters

Returns CreateConversationOptionsBuilder

Settings

On This Page

`Static`create