UNPKG

2.43 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 declare 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
28 */
29 constructor(channelServiceHandler: ChannelServiceHandlerBase);
30 /**
31 * Registers all Channel Service paths on the provided WebServer.
32 * @param server WebServer
33 * @param basePath Optional basePath which is appended before the service's REST API is configured on the WebServer.
34 */
35 register(server: WebServer, basePath?: string): void;
36 /**
37 * @private
38 */
39 private processSendToConversation;
40 /**
41 * @private
42 */
43 private processReplyToActivity;
44 /**
45 * @private
46 */
47 private processUpdateActivity;
48 /**
49 * @private
50 */
51 private processDeleteActivity;
52 /**
53 * @private
54 */
55 private processGetActivityMembers;
56 /**
57 * @private
58 */
59 private processCreateConversation;
60 /**
61 * @private
62 */
63 private processGetConversations;
64 /**
65 * @private
66 */
67 private processGetConversationMembers;
68 /**
69 * @private
70 */
71 private processGetConversationPagedMembers;
72 /**
73 * @private
74 */
75 private processDeleteConversationMember;
76 /**
77 * @private
78 */
79 private processSendConversationHistory;
80 /**
81 * @private
82 */
83 private processUploadAttachment;
84 /**
85 * @private
86 */
87 private static readActivity;
88 /**
89 * @private
90 */
91 private static readBody;
92 /**
93 * @private
94 */
95 private static handleError;
96}
97//# sourceMappingURL=channelServiceRoutes.d.ts.map
\No newline at end of file