ChannelServiceHandlerBase.OnGetConversationsAsync 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.
OnGetConversationsAsync() API for Skill.
protected virtual System.Threading.Tasks.Task<Microsoft.Bot.Schema.ConversationsResult> OnGetConversationsAsync (System.Security.Claims.ClaimsIdentity claimsIdentity, string conversationId, string continuationToken = default, System.Threading.CancellationToken cancellationToken = default);abstract member OnGetConversationsAsync : System.Security.Claims.ClaimsIdentity * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Bot.Schema.ConversationsResult>
override this.OnGetConversationsAsync : System.Security.Claims.ClaimsIdentity * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Bot.Schema.ConversationsResult>Protected Overridable Function OnGetConversationsAsync (claimsIdentity As ClaimsIdentity, conversationId As String, Optional continuationToken As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ConversationsResult)Parameters
- claimsIdentity
- ClaimsIdentity
claimsIdentity for the bot, should have AudienceClaim, AppIdClaim and ServiceUrlClaim.
- conversationId
- String
conversationId.
- continuationToken
- String
skip or continuation token.
- cancellationToken
- CancellationToken
The cancellation token.
Returns
task for ConversationsResult.
Remarks
Override this method to list the Conversations in which this bot has participated.
GET from this method with a skip token
The return value is a ConversationsResult, which contains an array of ConversationMembers and a skip token. If the skip token is not empty, then there are further values to be returned. Call this method again with the returned token to get more values.
Each ConversationMembers object contains the ID of the conversation and an array of ChannelAccounts that describe the members of the conversation.