UNPKG

2.53 kBTypeScriptView Raw
1/**
2 * @module botbuilder
3 */
4/**
5 * Copyright (c) Microsoft Corporation. All rights reserved.
6 * Licensed under the MIT License.
7 */
8import type { ChannelServiceHandlerBase } from './channelServiceHandlerBase';
9import { WebRequest, WebResponse } from './interfaces';
10export type RouteHandler = (request: WebRequest, response: WebResponse) => void;
11/**
12 * Interface representing an Express Application or a Restify Server.
13 */
14export interface WebServer {
15 get: (path: string, handler: RouteHandler) => void;
16 post: (path: string, handler: RouteHandler) => void;
17 put: (path: string, handler: RouteHandler) => void;
18 del?: (path: string, handler: RouteHandler) => void;
19 delete?: (path: string, handler: RouteHandler) => void;
20}
21/**
22 * Routes the API calls with the ChannelServiceHandler methods.
23 */
24export declare class ChannelServiceRoutes {
25 private readonly channelServiceHandler;
26 /**
27 * @param channelServiceHandler The channel service handler.
28 */
29 constructor(channelServiceHandler: ChannelServiceHandlerBase);
30 /**
31 * Registers all Channel Service paths on the provided WebServer.
32 *
33 * @param server WebServer
34 * @param basePath Optional basePath which is appended before the service's REST API is configured on the WebServer.
35 */
36 register(server: WebServer, basePath?: string): void;
37 /**
38 * @private
39 */
40 private processSendToConversation;
41 /**
42 * @private
43 */
44 private processReplyToActivity;
45 /**
46 * @private
47 */
48 private processUpdateActivity;
49 /**
50 * @private
51 */
52 private processDeleteActivity;
53 /**
54 * @private
55 */
56 private processGetActivityMembers;
57 /**
58 * @private
59 */
60 private processCreateConversation;
61 /**
62 * @private
63 */
64 private processGetConversations;
65 /**
66 * @private
67 */
68 private processGetConversationMembers;
69 /**
70 * @private
71 */
72 private processGetConversationMember;
73 /**
74 * @private
75 */
76 private processGetConversationPagedMembers;
77 /**
78 * @private
79 */
80 private processDeleteConversationMember;
81 /**
82 * @private
83 */
84 private processSendConversationHistory;
85 /**
86 * @private
87 */
88 private processUploadAttachment;
89 /**
90 * @private
91 */
92 private static readActivity;
93 /**
94 * @private
95 */
96 private static readBody;
97 /**
98 * @private
99 */
100 private static handleError;
101}
102//# sourceMappingURL=channelServiceRoutes.d.ts.map
\No newline at end of file