ChannelServiceController Class

Package:
com.microsoft.bot.integration.spring
Maven Artifact:
com.microsoft.bot:bot-integration-spring:4.14.3
  • java.lang.Object
    • com.microsoft.bot.integration.spring.ChannelServiceController

public abstract class ChannelServiceController

A super.class for a skill controller.

Constructor Summary

Modifier Constructor Description
protected ChannelServiceController(ChannelServiceHandler handler)

Initializes a new instance of the ChannelServiceController class.

Method Summary

Modifier and Type Method and Description
java.util.concurrent.CompletableFuture<org.springframework.http.ResponseEntity<ConversationResourceResponse>> createConversation(ConversationParameters parameters, String authHeader)

CreateConversation.
java.util.concurrent.CompletableFuture<org.springframework.http.ResponseEntity<java.lang.Void>> deleteActivity(String conversationId, String activityId, String authHeader)

DeleteActivity.
java.util.concurrent.CompletableFuture<org.springframework.http.ResponseEntity<java.lang.Void>> deleteConversationMember(String conversationId, String memberId, String authHeader)

DeleteConversationMember.
java.util.concurrent.CompletableFuture<org.springframework.http.ResponseEntity<java.util.List<ChannelAccount>>> getActivityMembers(String conversationId, String activityId, String authHeader)

GetActivityMembers.
java.util.concurrent.CompletableFuture<org.springframework.http.ResponseEntity<java.util.List<ChannelAccount>>> getConversationMembers(String conversationId, String authHeader)

GetConversationMembers.
java.util.concurrent.CompletableFuture<org.springframework.http.ResponseEntity<PagedMembersResult>> getConversationPagedMembers(String conversationId, int pageSize, String continuationToken, String authHeader)

GetConversationPagedMembers.
java.util.concurrent.CompletableFuture<org.springframework.http.ResponseEntity<ConversationsResult>> getConversations(String conversationId, String continuationToken, String authHeader)

GetConversations.
java.util.concurrent.CompletableFuture<org.springframework.http.ResponseEntity<ResourceResponse>> replyToActivity(String conversationId, String activityId, Activity activity, String authHeader)

ReplyToActivity.
java.util.concurrent.CompletableFuture<org.springframework.http.ResponseEntity<ResourceResponse>> sendConversationHistory(String conversationId, Transcript history, String authHeader)

SendConversationHistory.
java.util.concurrent.CompletableFuture<org.springframework.http.ResponseEntity<ResourceResponse>> sendToConversation(String conversationId, Activity activity, String authHeader)

SendToConversation.
java.util.concurrent.CompletableFuture<org.springframework.http.ResponseEntity<ResourceResponse>> updateActivity(String conversationId, String activityId, Activity activity, String authHeader)

UpdateActivity.
java.util.concurrent.CompletableFuture<org.springframework.http.ResponseEntity<ResourceResponse>> uploadAttachment(String conversationId, AttachmentData attachmentUpload, String authHeader)

UploadAttachment.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

ChannelServiceController

protected ChannelServiceController(ChannelServiceHandler handler)

Initializes a new instance of the ChannelServiceController class.

Parameters:

handler - A ChannelServiceHandler that will handle the incoming request.

Method Details

createConversation

public CompletableFuture> createConversation(ConversationParameters parameters, String authHeader)

CreateConversation.

Parameters:

parameters - Parameters to create the conversation from.
authHeader - Authentication header.

Returns:

A ConversationResourceResponse.

deleteActivity

public CompletableFuture> deleteActivity(String conversationId, String activityId, String authHeader)

DeleteActivity.

Parameters:

conversationId - Conversation Id.
activityId - activityId to delete.
authHeader - Authentication header.

Returns:

A void result if successful.

deleteConversationMember

public CompletableFuture> deleteConversationMember(String conversationId, String memberId, String authHeader)

DeleteConversationMember.

Parameters:

conversationId - Conversation Id.
memberId - D of the member to delete from this conversation.
authHeader - Authentication header.

Returns:

A void result.

getActivityMembers

public CompletableFuture>> getActivityMembers(String conversationId, String activityId, String authHeader)

GetActivityMembers. Markdown=Content\Methods\GetActivityMembers.getmd().

Parameters:

conversationId - Conversation Id.
activityId - Activity Id.
authHeader - Authentication header.

Returns:

A list of ChannelAccount.

getConversationMembers

public CompletableFuture>> getConversationMembers(String conversationId, String authHeader)

GetConversationMembers.

Parameters:

conversationId - Conversation Id.
authHeader - Authentication header.

Returns:

A List of ChannelAccount.

getConversationPagedMembers

public CompletableFuture> getConversationPagedMembers(String conversationId, int pageSize, String continuationToken, String authHeader)

GetConversationPagedMembers.

Parameters:

conversationId - Conversation Id.
pageSize - Suggested page size.
continuationToken - Continuation Token.
authHeader - Authentication header.

Returns:

A PagedMembersResult.

getConversations

public CompletableFuture> getConversations(String conversationId, String continuationToken, String authHeader)

GetConversations.

Parameters:

conversationId - the conversation id to get conversations for.
continuationToken - skip or continuation token.
authHeader - Authentication header.

Returns:

A ConversationsResult.

replyToActivity

public CompletableFuture> replyToActivity(String conversationId, String activityId, Activity activity, String authHeader)

ReplyToActivity.

Parameters:

conversationId - Conversation Id.
activityId - activityId the reply is to (OPTONAL).
activity - Activity to send.
authHeader - Authentication header.

Returns:

A ResourceResponse.

sendConversationHistory

public CompletableFuture> sendConversationHistory(String conversationId, Transcript history, String authHeader)

SendConversationHistory.

Parameters:

conversationId - Conversation Id.
history - Historic activities.
authHeader - Authentication header.

Returns:

A ResourceResponse.

sendToConversation

public CompletableFuture> sendToConversation(String conversationId, Activity activity, String authHeader)

SendToConversation.

Parameters:

conversationId - Conversation Id.
activity - Activity to send.
authHeader - Authentication header.

Returns:

A ResourceResponse.

updateActivity

public CompletableFuture> updateActivity(String conversationId, String activityId, Activity activity, String authHeader)

UpdateActivity.

Parameters:

conversationId - Conversation Id.
activityId - activityId to update.
activity - replacement Activity.
authHeader - Authentication header.

Returns:

A ResourceResponse.

uploadAttachment

public CompletableFuture> uploadAttachment(String conversationId, AttachmentData attachmentUpload, String authHeader)

UploadAttachment.

Parameters:

conversationId - Conversation Id.
attachmentUpload - Attachment data.
authHeader - Authentication header.

Returns:

A ResourceResponse.

Applies to