CredentialProvider インターフェイス

  • リファレンス
パッケージ:
com.microsoft.bot.connector.authentication
Maven 成果物:
com.microsoft.bot:bot-connector:4.14.3

public interface CredentialProvider

CredentialProvider インターフェイス。 このインターフェイスを使用すると、ボットは、有効な appId とパスワードとは何か、そうでないものの独自の実装を提供できます。 これは、特定の appid/password ペアが有効かどうかを判断するために、ボットがサービスに呼び出す必要があるマルチテナント ボットの場合に役立ちます。 シングル テナント ボット (大部分) では、単純な静的プロバイダーで十分です。

メソッドの概要

修飾子と型 メソッドと説明
abstract java.util.concurrent.CompletableFuture<java.lang.String> getAppPassword(String appId)

特定のボット アプリ ID のアプリ パスワードを取得します。
abstract java.util.concurrent.CompletableFuture<java.lang.Boolean> isAuthenticationDisabled()

ボット認証が無効になっているかどうかを確認します。
abstract java.util.concurrent.CompletableFuture<java.lang.Boolean> isValidAppId(String appId)

アプリ ID を検証します。

メソッドの詳細

getAppPassword

public abstract CompletableFuture getAppPassword(String appId)

特定のボット アプリ ID のアプリ パスワードを取得します。

パラメーター:

appId - パスワードを取得するアプリの ID。

戻り値:

実行するキューに登録された作業を表すタスク。 タスクが成功し、アプリ ID が有効な場合、結果にはパスワードが含まれます。それ以外の場合は null。 このメソッドは非同期であり、appId とパスワードのペアを検証するためにサービスを提供するために呼び出す必要があるカスタム実装を有効にします。

isAuthenticationDisabled

public abstract CompletableFuture isAuthenticationDisabled()

ボット認証が無効になっているかどうかを確認します。

戻り値:

実行するキューに登録された作業を表すタスク。 タスクが成功し、ボット認証が無効になっている場合、結果は true になります。それ以外の場合は false。 このメソッドは非同期であり、appId とパスワードのペアを検証するためにサービスを提供するために呼び出す必要があるカスタム実装を有効にします。

isValidAppId

public abstract CompletableFuture isValidAppId(String appId)

アプリ ID を検証します。

パラメーター:

appId - 検証するアプリ ID。

戻り値:

実行するキューに登録された作業を表すタスク。 タスクが成功した場合、appId がコントローラーに対して有効な場合、結果は true になります。それ以外の場合は false。

適用対象