UNPKG

3.36 kBTypeScriptView Raw
1/**
2 * @module botbuilder
3 */
4/**
5 * Copyright (c) Microsoft Corporation. All rights reserved.
6 * Licensed under the MIT License.
7 */
8import { ActivityHandler, InvokeResponse, AceRequest, TurnContext, CardViewResponse, QuickViewResponse, GetPropertyPaneConfigurationResponse, SetPropertyPaneConfigurationResponse, HandleActionResponse } from 'botbuilder-core';
9/**
10 * The SharePointActivityHandler is derived from ActivityHandler. It adds support for
11 * the SharePoint specific events and interactions
12 */
13export declare class SharePointActivityHandler extends ActivityHandler {
14 /**
15 * Invoked when an invoke activity is received from the connector.
16 * Invoke activities can be used to communicate many different things.
17 * * Invoke activities communicate programmatic commands from a client or channel to a bot.
18 *
19 * @param context A strongly-typed context object for this turn
20 * @returns A task that represents the work queued to execute
21 */
22 protected onInvokeActivity(context: TurnContext): Promise<InvokeResponse>;
23 /**
24 * Override this in a derived class to provide logic for when a card view is fetched
25 *
26 * @param _context - A strongly-typed context object for this turn
27 * @param _aceRequest - The Ace invoke request value payload
28 * @returns A Card View Response for the request
29 */
30 protected onSharePointTaskGetCardViewAsync(_context: TurnContext, _aceRequest: AceRequest): Promise<CardViewResponse>;
31 /**
32 * Override this in a derived class to provide logic for when a quick view is fetched
33 *
34 * @param _context - A strongly-typed context object for this turn
35 * @param _aceRequest - The Ace invoke request value payload
36 * @returns A Quick View Response for the request
37 */
38 protected onSharePointTaskGetQuickViewAsync(_context: TurnContext, _aceRequest: AceRequest): Promise<QuickViewResponse>;
39 /**
40 * Override this in a derived class to provide logic for getting configuration pane properties.
41 *
42 * @param _context - A strongly-typed context object for this turn
43 * @param _aceRequest - The Ace invoke request value payload
44 * @returns A Property Pane Configuration Response for the request
45 */
46 protected onSharePointTaskGetPropertyPaneConfigurationAsync(_context: TurnContext, _aceRequest: AceRequest): Promise<GetPropertyPaneConfigurationResponse>;
47 /**
48 * Override this in a derived class to provide logic for setting configuration pane properties.
49 *
50 * @param _context - A strongly-typed context object for this turn
51 * @param _aceRequest - The Ace invoke request value payload
52 * @returns A Card view or no-op action response
53 */
54 protected onSharePointTaskSetPropertyPaneConfigurationAsync(_context: TurnContext, _aceRequest: AceRequest): Promise<SetPropertyPaneConfigurationResponse>;
55 /**
56 * Override this in a derived class to provide logic for setting configuration pane properties.
57 *
58 * @param _context - A strongly-typed context object for this turn
59 * @param _aceRequest - The Ace invoke request value payload
60 * @returns A handle action response
61 */
62 protected onSharePointTaskHandleActionAsync(_context: TurnContext, _aceRequest: AceRequest): Promise<HandleActionResponse>;
63}
64//# sourceMappingURL=sharePointActivityHandler.d.ts.map
\No newline at end of file