botbuilder
Version:
Bot Builder is a framework for building rich bots on virtually any platform.
147 lines • 7.24 kB
JavaScript
;
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.SkillHandler = void 0;
const channelServiceHandler_1 = require("../channelServiceHandler");
const skillHandlerImpl_1 = require("./skillHandlerImpl");
const botframework_connector_1 = require("botframework-connector");
const botbuilder_core_1 = require("botbuilder-core");
/**
* @deprecated Use `CloudSkillHandler` instead.
* A Bot Framework Handler for skills.
*/
class SkillHandler extends channelServiceHandler_1.ChannelServiceHandler {
/**
* Initializes a new instance of the SkillHandler class.
*
* @param adapter An instance of the BotAdapter that will handle the request.
* @param bot The ActivityHandlerBase instance.
* @param conversationIdFactory A SkillConversationIdFactoryBase to unpack the conversation ID and map it to the calling bot.
* @param credentialProvider The credential provider.
* @param authConfig The authentication configuration.
* @param channelService The string indicating if the bot is working in Public Azure or in Azure Government (https://aka.ms/AzureGovDocs).
*/
constructor(adapter, bot, conversationIdFactory, credentialProvider, authConfig, channelService) {
super(credentialProvider, authConfig, channelService);
/**
* Used to access the CovnersationReference sent from the Skill to the Parent.
*
* @remarks
* The value is the same as the SkillConversationReferenceKey exported from botbuilder-core.
*/
this.SkillConversationReferenceKey = botbuilder_core_1.SkillConversationReferenceKey;
if (!adapter) {
throw new Error('missing adapter.');
}
if (!bot) {
throw new Error('missing bot.');
}
if (!conversationIdFactory) {
throw new Error('missing conversationIdFactory.');
}
this.inner = new skillHandlerImpl_1.SkillHandlerImpl(this.SkillConversationReferenceKey, adapter, (context) => bot.run(context), conversationIdFactory, () => botframework_connector_1.JwtTokenValidation.isGovernment(channelService)
? botframework_connector_1.GovernmentConstants.ToChannelFromBotOAuthScope
: botframework_connector_1.AuthenticationConstants.ToChannelFromBotOAuthScope);
}
/**
* sendToConversation() API for Skill.
*
* @remarks
* This method allows you to send an activity to the end of a conversation.
*
* This is slightly different from replyToActivity().
* * sendToConversation(conversationId) - will append the activity to the end
* of the conversation according to the timestamp or semantics of the channel.
* * replyToActivity(conversationId,ActivityId) - adds the activity as a reply
* to another activity, if the channel supports it. If the channel does not
* support nested replies, replyToActivity falls back to sendToConversation.
*
* Use replyToActivity when replying to a specific activity in the conversation.
*
* Use sendToConversation in all other cases.
* @param claimsIdentity ClaimsIdentity for the bot, should have AudienceClaim, AppIdClaim and ServiceUrlClaim.
* @param conversationId Conversation ID.
* @param activity Activity to send.
* @returns A Promise with a ResourceResponse.
*/
onSendToConversation(claimsIdentity, conversationId, activity) {
return this.inner.onSendToConversation(claimsIdentity, conversationId, activity);
}
/**
* replyToActivity() API for Skill.
*
* @remarks
* This method allows you to reply to an activity.
*
* This is slightly different from sendToConversation().
* * sendToConversation(conversationId) - will append the activity to the end
* of the conversation according to the timestamp or semantics of the channel.
* * replyToActivity(conversationId,ActivityId) - adds the activity as a reply
* to another activity, if the channel supports it. If the channel does not
* support nested replies, replyToActivity falls back to sendToConversation.
*
* Use replyToActivity when replying to a specific activity in the conversation.
*
* Use sendToConversation in all other cases.
* @param claimsIdentity ClaimsIdentity for the bot, should have AudienceClaim, AppIdClaim and ServiceUrlClaim.
* @param conversationId Conversation ID.
* @param activityId activityId the reply is to.
* @param activity Activity to send.
* @returns A Promise with a ResourceResponse.
*/
onReplyToActivity(claimsIdentity, conversationId, activityId, activity) {
return this.inner.onReplyToActivity(claimsIdentity, conversationId, activityId, activity);
}
/**
*
* UpdateActivity() API for Skill.
*
* @remarks
* Edit an existing activity.
*
* Some channels allow you to edit an existing activity to reflect the new
* state of a bot conversation.
*
* For example, you can remove buttons after someone has clicked "Approve" button.
* @param claimsIdentity ClaimsIdentity for the bot, should have AudienceClaim, AppIdClaim and ServiceUrlClaim.
* @param conversationId Conversation ID.
* @param activityId activityId to update.
* @param activity replacement Activity.
* @returns a promise resolving to the underlying resource response
*/
onUpdateActivity(claimsIdentity, conversationId, activityId, activity) {
return this.inner.onUpdateActivity(claimsIdentity, conversationId, activityId, activity);
}
/**
* DeleteActivity() API for Skill.
*
* @remarks
* Delete an existing activity.
*
* Some channels allow you to delete an existing activity, and if successful
* this method will remove the specified activity.
*
*
* @param claimsIdentity ClaimsIdentity for the bot, should have AudienceClaim, AppIdClaim and ServiceUrlClaim.
* @param conversationId Conversation ID.
* @param activityId activityId to delete.
* @returns a promise representing the async operation
*/
onDeleteActivity(claimsIdentity, conversationId, activityId) {
return __awaiter(this, void 0, void 0, function* () {
return this.inner.onDeleteActivity(claimsIdentity, conversationId, activityId);
});
}
}
exports.SkillHandler = SkillHandler;
//# sourceMappingURL=skillHandler.js.map