CreateConversationOptionsBuilder.Create Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Name | Description |
|---|---|
| Create(IDictionary<String,String>, ChannelId, String, ConversationParameters) |
Creates a new instance of the CreateConversationOptionsBuilder class for initializing a conversation with the specified identity, channel, and parameters. |
| Create(String, ChannelId, String, ConversationParameters) |
Creates a new instance of the CreateConversationOptionsBuilder class for initializing a conversation with the specified agent and channel. |
Create(IDictionary<String,String>, ChannelId, String, ConversationParameters)
Creates a new instance of the CreateConversationOptionsBuilder class for initializing a conversation with the specified identity, channel, and parameters.
public static Microsoft.Agents.Builder.App.Proactive.CreateConversationOptionsBuilder Create(System.Collections.Generic.IDictionary<string,string> claims, Microsoft.Agents.Core.Models.ChannelId channelId, string serviceUrl = default, Microsoft.Agents.Core.Models.ConversationParameters parameters = default);static member Create : System.Collections.Generic.IDictionary<string, string> * Microsoft.Agents.Core.Models.ChannelId * string * Microsoft.Agents.Core.Models.ConversationParameters -> Microsoft.Agents.Builder.App.Proactive.CreateConversationOptionsBuilderPublic Shared Function Create (claims As IDictionary(Of String, String), channelId As ChannelId, Optional serviceUrl As String = Nothing, Optional parameters As ConversationParameters = Nothing) As CreateConversationOptionsBuilderParameters
- claims
- IDictionary<String,String>
The ClaimsIdentity.Claims representing the agent or user initiating the conversation. Cannot be null.
- channelId
- ChannelId
The identifier of the channel where the conversation will be created. Cannot be null or whitespace.
- serviceUrl
- String
The service URL for the channel. If null, the default service URL is used.
- parameters
- ConversationParameters
Optional parameters for the conversation, such as participants or conversation metadata. If null, default parameters are used.
Returns
A CreateConversationBuilder instance configured with the specified identity, channel, and parameters.
Exceptions
Thrown if required parameters are missing or invalid.
Applies to
Create(String, ChannelId, String, ConversationParameters)
Creates a new instance of the CreateConversationOptionsBuilder class for initializing a conversation with the specified agent and channel.
public static Microsoft.Agents.Builder.App.Proactive.CreateConversationOptionsBuilder Create(string agentClientId, Microsoft.Agents.Core.Models.ChannelId channelId, string serviceUrl = default, Microsoft.Agents.Core.Models.ConversationParameters parameters = default);static member Create : string * Microsoft.Agents.Core.Models.ChannelId * string * Microsoft.Agents.Core.Models.ConversationParameters -> Microsoft.Agents.Builder.App.Proactive.CreateConversationOptionsBuilderPublic Shared Function Create (agentClientId As String, channelId As ChannelId, Optional serviceUrl As String = Nothing, Optional parameters As ConversationParameters = Nothing) As CreateConversationOptionsBuilderParameters
- agentClientId
- String
The unique identifier of the agent client to associate with the conversation. Cannot be null or whitespace.
- channelId
- ChannelId
The identifier of the channel where the conversation will take place. Cannot be null or whitespace.
- serviceUrl
- String
The service URL to use for the conversation. If null, a default value may be used.
- parameters
- ConversationParameters
Optional parameters for configuring the conversation. If null, default parameters are used.
Returns
A CreateConversationBuilder instance configured with the specified agent, channel, and parameters.
Exceptions
Thrown if required parameters are missing or invalid.
Remarks
If the parameters argument is null, default conversation parameters are used. If the Agent property of parameters is not set, it is initialized with the provided agentClientId.