ChatConnector class
Bot Framework を使用して、UniversalBot を複数のチャネルに接続します。
コンストラクター
| Chat |
ChatConnector の新しいインスタンスを作成します。 |
メソッド
コンストラクターの詳細
ChatConnector(IChatConnectorSettings)
ChatConnector の新しいインスタンスを作成します。
new ChatConnector(settings?: IChatConnectorSettings)パラメーター
- settings
- IChatConnectorSettings
(省略可能) Bot Frameworks 開発者ポータルで割り当てたボットアプリ ID & パスワードを指定できる構成パラメーター。
メソッドの詳細
delete(IAddress, (err: Error) => void)
既存のメッセージを削除します。
function delete(address: IAddress, done: (err: Error) => void)パラメーター
- address
- IAddress
- done
-
(err: Error) => void
deleteConversationMember(string, string, string, (err: Error) => void)
会話内の個々のユーザーのデータを削除します。
function deleteConversationMember(serviceUrl: string, conversationId: string, memberId: string, done: (err: Error) => void)パラメーター
- serviceUrl
-
string
更新するチャネルのサービス URL。 これは、ボットに送信されたメッセージの address.serviceUrl にあります。
- conversationId
-
string
削除するメンバーとの会話の ID。
- memberId
-
string
削除するメンバーの ID。
- done
-
(err: Error) => void
削除操作の完了時に呼び出されるコールバック。
emulateOAuthCards(string, boolean, (err: Error) => void)
OAuthCard の送信をエミュレートするようにトークン サービスに指示します。
function emulateOAuthCards(serviceUrl: string, emulate: boolean, done: (err: Error) => void)パラメーター
- serviceUrl
-
string
クエリを実行するチャネルのサービス URL。 これは、ボットに送信されたメッセージの address.serviceUrl にあります。
- emulate
-
boolean
true 場合、トークン サービスは OAuthCard の送信をエミュレートします。
- done
-
(err: Error) => void
操作の完了時に呼び出されるコールバック。
exportBotStateData(string, string, string | undefined, (err: Error, results: IBotStateDataResult) => void)
特定のチャネルに対して永続化されたボット状態データをエクスポートします。
function exportBotStateData(serviceUrl: string, channelId: string, continuationToken: string | undefined, done: (err: Error, results: IBotStateDataResult) => void)パラメーター
- serviceUrl
-
string
クエリを実行するチャネルのサービス URL。 これは、ボットに送信されたメッセージの address.serviceUrl にあります。
- channelId
-
string
エクスポートするチャネルの ID。 これは、ボットに送信されたメッセージの address.channelId にあります。
- continuationToken
-
string | undefined
取得する結果の次のページの継続トークン。 これは、要求された最初のページに対して undefined する必要があります。
- done
-
(err: Error, results: IBotStateDataResult) => void
結果の次のページを受け取るコールバック。
getAccessToken((err: Error, accessToken: string) => void)
ボットの現在のアクセス トークンを取得します。
function getAccessToken(callback: (err: Error, accessToken: string) => void)パラメーター
- callback
-
(err: Error, accessToken: string) => void
getConversationPagedMembers(string, string, number | undefined, string | undefined, (err: Error, result?: IPagedMembersResult) => void)
会話のメンバーを一度に 1 ページずつ列挙します。 この REST API は ConversationId を受け取ります。 必要に応じて、pageSize または continuationToken を指定できます。 これは、会話のメンバーを表す ChannelAccounts の配列と、より多くの値を取得するために使用できる継続トークンを含む PagedMembersResult を返します。
呼び出しごとに ChannelAccounts レコードの 1 ページが返されます。 ページ内のレコードの数は、チャネルと呼び出しによって異なる場合があります。 pageSize パラメーターは、候補として使用できます。 追加の結果がない場合、応答には継続トークンは含まれません。 会話にメンバーが存在しない場合、メンバーは空であるか、応答に存在しません。
前の要求からの継続トークンを持つ要求に対する応答では、前の要求からメンバーを返す可能性はほとんどありません。
function getConversationPagedMembers(serviceUrl: string, conversationId: string, pageSize: number | undefined, continuationToken: string | undefined, done: (err: Error, result?: IPagedMembersResult) => void)パラメーター
- serviceUrl
-
string
クエリを実行するチャネルのサービス URL。 これは、ボットに送信されたメッセージの address.serviceUrl にあります。
- conversationId
-
string
conversationId
- pageSize
-
number | undefined
取得する結果の数 (既定値は 20)
- continuationToken
-
string | undefined
取得する結果の次のページの継続トークン。 これは、要求された最初のページに対して undefined する必要があります。
- done
-
(err: Error, result?: IPagedMembersResult) => void
結果の次のページを受け取るコールバック。
getConversations(string, string | undefined, (err: Error, result?: IConversationsResult) => void)
特定のチャネルでボットが持つすべての会話の一覧を取得します。 結果は、会話の次のページをフェッチするために使用できる continuationToken と共に、ページ単位でボットに送り返されます。 このデータを使用すると、deleteConversationMember() メソッドを使用して、ユーザーのすべての会話データを削除できます。
function getConversations(serviceUrl: string, continuationToken: string | undefined, done: (err: Error, result?: IConversationsResult) => void)パラメーター
- serviceUrl
-
string
クエリを実行するチャネルのサービス URL。 これは、ボットに送信されたメッセージの address.serviceUrl にあります。
- continuationToken
-
string | undefined
取得する結果の次のページの継続トークン。 これは、要求された最初のページに対して undefined する必要があります。
- done
-
(err: Error, result?: IConversationsResult) => void
結果の次のページを受け取るコールバック。
getData(IBotStorageContext, (err: Error, data: IBotStorageData) => void)
Bot Frameworks 状態サービスからデータを読み取ります。
function getData(context: IBotStorageContext, callback: (err: Error, data: IBotStorageData) => void)パラメーター
- context
- IBotStorageContext
- callback
-
(err: Error, data: IBotStorageData) => void
getSignInLink(IChatConnectorAddress, string, (err: Error, link: string) => void)
SigninCard の一部として送信できるトークン サーバーからサインイン リンクを取得します。
function getSignInLink(address: IChatConnectorAddress, connectionName: string, done: (err: Error, link: string) => void)パラメーター
- address
- IChatConnectorAddress
サインイン リンクを取得するユーザーとチャネルのアドレス。
- connectionName
-
string
使用する認証接続の名前。
- done
-
(err: Error, link: string) => void
リンクを取得するためのコールバック。
getUserToken(IChatConnectorAddress, string, string | undefined, (err: Error, results: ITokenResponse) => void)
サインイン フロー内のユーザーのトークンの取得を試みます。
function getUserToken(address: IChatConnectorAddress, connectionName: string, magicCode: string | undefined, done: (err: Error, results: ITokenResponse) => void)パラメーター
- address
- IChatConnectorAddress
ログインするユーザーとチャネルのアドレス。
- connectionName
-
string
使用する認証接続の名前。
- magicCode
-
string | undefined
(省略可能)検証する省略可能なユーザー入力コード。
- done
-
(err: Error, results: ITokenResponse) => void
ユーザー トークンを取得するためのコールバック。
listen()
Express または Restify スタイルのフックを登録して、新しいメッセージをリッスンします。
function listen()戻り値
(req: any, res: any) => void
onEvent((events: IEvent[], callback?: (err: Error) => void) => void)
登録時に UniversalBot によって呼び出され、チャネルから受信イベントを受信するためのハンドラーを登録します。
function onEvent(handler: (events: IEvent[], callback?: (err: Error) => void) => void)パラメーター
- handler
-
(events: IEvent[], callback?: (err: Error) => void) => void
onInvoke((event: IEvent, cb?: (err: Error, body: any, status?: number) => void) => void)
着信呼び出しイベントを受信するためのハンドラーを登録するために使用されます。
function onInvoke(handler: (event: IEvent, cb?: (err: Error, body: any, status?: number) => void) => void)パラメーター
- handler
-
(event: IEvent, cb?: (err: Error, body: any, status?: number) => void) => void
saveData(IBotStorageContext, IBotStorageData, (err: Error) => void)
Bot Frameworks 状態サービスにデータを書き込みます。
function saveData(context: IBotStorageContext, data: IBotStorageData, callback?: (err: Error) => void)パラメーター
- context
- IBotStorageContext
- data
- IBotStorageData
- callback
-
(err: Error) => void
send(IMessage[], (err: Error, addresses?: IAddress[]) => void)
ユーザーに送信メッセージを配信するために UniversalBot によって呼び出されます。
function send(messages: IMessage[], done: (err: Error, addresses?: IAddress[]) => void)パラメーター
- messages
-
IMessage[]
- done
-
(err: Error, addresses?: IAddress[]) => void
sendConversationHistory(string, string, ITranscript, (err: Error, results: any) => void)
このメソッドを使用すると、履歴アクティビティを会話にアップロードできます。 送信者は、履歴アクティビティに一意の ID と適切なタイムスタンプがあることを確認する必要があります。 ID は、重複するアクティビティを処理するためにクライアントによって使用され、タイムスタンプはクライアントによって適切な順序でアクティビティをレンダリングするために使用されます。
function sendConversationHistory(serviceUrl: string, conversationId: string, transcript: ITranscript, done: (err: Error, results: any) => void)パラメーター
- serviceUrl
-
string
クエリを実行するチャネルのサービス URL。 これは、ボットに送信されたメッセージの address.serviceUrl にあります。
- conversationId
-
string
送信する履歴を含む会話の ID。
- transcript
- ITranscript
- done
-
(err: Error, results: any) => void
signOutUser(IChatConnectorAddress, string, (err: Error, results: ITokenResponse) => void)
トークン サーバーを使用してユーザーをサインアウトします。
function signOutUser(address: IChatConnectorAddress, connectionName: string, done: (err: Error, results: ITokenResponse) => void)パラメーター
- address
- IChatConnectorAddress
サインアウトするユーザーとチャネルのアドレス。
- connectionName
-
string
使用する認証接続の名前。
- done
-
(err: Error, results: ITokenResponse) => void
ユーザー トークンを取得するためのコールバック。
startConversation(IAddress, (err: Error, address?: IAddress) => void)
UniversalBot がユーザーとの新しいプロアクティブな会話を開始する場合に呼び出されます。 コネクタは、入力された 会話 フィールドを持つ適切に書式設定された アドレス オブジェクトを返す必要があります。
function startConversation(address: IAddress, done: (err: Error, address?: IAddress) => void)パラメーター
- address
- IAddress
- done
-
(err: Error, address?: IAddress) => void
update(IMessage, (err: Error, address?: IAddress) => void)
既存のメッセージを新しいメッセージに置き換えます。
function update(message: IMessage, done: (err: Error, address?: IAddress) => void)パラメーター
- message
- IMessage
- done
-
(err: Error, address?: IAddress) => void