OAuthPromptSettings クラス

  • リファレンス
パッケージ:
com.microsoft.bot.dialogs.prompts
Maven 成果物:
com.microsoft.bot:bot-dialogs:4.14.3
  • java.lang.Object
    • com.microsoft.bot.dialogs.prompts.OAuthPromptSettings

public class OAuthPromptSettings

OAuthPrompt/>の設定が含まれています。

コンストラクターの概要

コンストラクター 説明
OAuthPromptSettings()

メソッドの概要

修飾子と型 メソッドと説明
java.lang.String getConnectionName()

OAuth 接続の名前を取得します。
boolean getEndOnInvalidMessage()

無効なメッセージを受信したときに OAuthPrompt を終了するかどうかを示す値を取得します。
AppCredentials getOAuthAppCredentials()

OAuthプロンプトの OAuthアプリ資格情報を取得します。
java.lang.String getText()

サインイン カードに含める追加のテキストを取得します。
java.lang.Integer getTimeout()

プロンプトがユーザーの認証を待機するミリ秒数を取得します。
java.lang.String getTitle()

サインイン カードのタイトルを取得します。
void setConnectionName(String withConnectionName)

OAuth 接続の名前を設定します。
void setEndOnInvalidMessage(boolean withEndOnInvalidMessage)

OAuthPrompt が無効なメッセージを受信したときに終了するかどうかを示す値を設定します。
void setOAuthAppCredentials(AppCredentials withOAuthAppCredentials)

OAuthプロンプトの OAuthアプリ資格情報を設定します。
void setText(String withText)

サインイン カードに含める追加のテキストを設定します。
void setTimeout(Integer withTimeout)

プロンプトがユーザーの認証を待機するミリ秒数を設定します。
void setTitle(String withTitle)

サインイン カードのタイトルを設定します。

メソッドの継承元: java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

コンストラクターの詳細

OAuthPromptSettings

public OAuthPromptSettings()

メソッドの詳細

getConnectionName

public String getConnectionName()

OAuth 接続の名前を取得します。

戻り値:

ConnectionName 値を文字列として指定します。

getEndOnInvalidMessage

public boolean getEndOnInvalidMessage()

無効なメッセージを受信したときに OAuthPrompt を終了するかどうかを示す値を取得します。 通常、OAuthPrompt は、認証フローに関連していない場合、認証フロー中にユーザーからの受信メッセージを無視します。 このフラグを使用すると、ユーザーのメッセージを無視するのではなく、OAuthPrompt を終了できます。 通常、このフラグは 'true' に設定されますが、下位互換性のために既定では 'false' です。

戻り値:

EndOnInvalidMessage 値をブール値として指定します。

getOAuthAppCredentials

public AppCredentials getOAuthAppCredentials()

OAuthPrompt の OAuthAppCredentials を取得します。

戻り値:

OAuthAppCredentials 値を AppCredentials として指定します。

getText

public String getText()

サインイン カードに含める追加のテキストを取得します。

戻り値:

文字列としてのテキスト値。

getTimeout

public Integer getTimeout()

プロンプトがユーザーの認証を待機するミリ秒数を取得します。 既定値は 900,000 (15 分) です。

戻り値:

タイムアウト値を int として指定します。

getTitle

public String getTitle()

サインイン カードのタイトルを取得します。

戻り値:

Title 値を文字列として指定します。

setConnectionName

public void setConnectionName(String withConnectionName)

OAuth 接続の名前を設定します。

パラメーター:

withConnectionName - ConnectionName 値。

setEndOnInvalidMessage

public void setEndOnInvalidMessage(boolean withEndOnInvalidMessage)

OAuthPrompt が無効なメッセージを受信したときに終了するかどうかを示す値を設定します。 通常、OAuthPrompt は、認証フローに関連していない場合、認証フロー中にユーザーからの受信メッセージを無視します。 このフラグを使用すると、ユーザーのメッセージを無視するのではなく、OAuthPrompt を終了できます。 通常、このフラグは 'true' に設定されますが、下位互換性のために既定では 'false' です。

パラメーター:

withEndOnInvalidMessage - EndOnInvalidMessage 値。

setOAuthAppCredentials

public void setOAuthAppCredentials(AppCredentials withOAuthAppCredentials)

OAuthPrompt の OAuthAppCredentials を設定します。

パラメーター:

withOAuthAppCredentials - OAuthAppCredentials 値。

setText

public void setText(String withText)

サインイン カードに含める追加のテキストを設定します。

パラメーター:

withText - テキスト値。

setTimeout

public void setTimeout(Integer withTimeout)

プロンプトがユーザーの認証を待機するミリ秒数を設定します。 既定値は 900,000 (15 分) です。

パラメーター:

withTimeout - タイムアウト値。

setTitle

public void setTitle(String withTitle)

サインイン カードのタイトルを設定します。

パラメーター:

withTitle - Title 値。

適用対象