OAuthPromptSettings Class

Package:
com.microsoft.bot.dialogs.prompts
Maven Artifact:
com.microsoft.bot:bot-dialogs:4.14.3
  • java.lang.Object
    • com.microsoft.bot.dialogs.prompts.OAuthPromptSettings

public class OAuthPromptSettings

Contains settings for an OAuthPrompt/>.

Constructor Summary

Constructor Description
OAuthPromptSettings()

Method Summary

Modifier and Type Method and Description
java.lang.String getConnectionName()

Gets the name of the OAuth connection.
boolean getEndOnInvalidMessage()

Gets a value indicating whether the OAuthPrompt should end upon receiving an invalid message.
AppCredentials getOAuthAppCredentials()

Gets the OAuthAppCredentials for OAuthPrompt.
java.lang.String getText()

Gets any additional text to include in the sign-in card.
java.lang.Integer getTimeout()

Gets the number of milliseconds the prompt waits for the user to authenticate.
java.lang.String getTitle()

Gets the title of the sign-in card.
void setConnectionName(String withConnectionName)

Sets the name of the OAuth connection.
void setEndOnInvalidMessage(boolean withEndOnInvalidMessage)

Sets a value indicating whether the OAuthPrompt should end upon receiving an invalid message.
void setOAuthAppCredentials(AppCredentials withOAuthAppCredentials)

Sets the OAuthAppCredentials for OAuthPrompt.
void setText(String withText)

Sets any additional text to include in the sign-in card.
void setTimeout(Integer withTimeout)

Sets the number of milliseconds the prompt waits for the user to authenticate.
void setTitle(String withTitle)

Sets the title of the sign-in card.

Methods inherited from 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

Constructor Details

OAuthPromptSettings

public OAuthPromptSettings()

Method Details

getConnectionName

public String getConnectionName()

Gets the name of the OAuth connection.

Returns:

the ConnectionName value as a String.

getEndOnInvalidMessage

public boolean getEndOnInvalidMessage()

Gets a value indicating whether the OAuthPrompt should end upon receiving an invalid message. Generally the OAuthPrompt will ignore incoming messages from the user during the auth flow, if they are not related to the auth flow. This flag enables ending the OAuthPrompt rather than ignoring the user's message. Typically, this flag will be set to 'true', but is 'false' by default for backwards compatibility.

Returns:

the EndOnInvalidMessage value as a boolean.

getOAuthAppCredentials

public AppCredentials getOAuthAppCredentials()

Gets the OAuthAppCredentials for OAuthPrompt.

Returns:

the OAuthAppCredentials value as a AppCredentials.

getText

public String getText()

Gets any additional text to include in the sign-in card.

Returns:

the Text value as a String.

getTimeout

public Integer getTimeout()

Gets the number of milliseconds the prompt waits for the user to authenticate. Default is 900,000 (15 minutes).

Returns:

the Timeout value as a int?.

getTitle

public String getTitle()

Gets the title of the sign-in card.

Returns:

the Title value as a String.

setConnectionName

public void setConnectionName(String withConnectionName)

Sets the name of the OAuth connection.

Parameters:

withConnectionName - The ConnectionName value.

setEndOnInvalidMessage

public void setEndOnInvalidMessage(boolean withEndOnInvalidMessage)

Sets a value indicating whether the OAuthPrompt should end upon receiving an invalid message. Generally the OAuthPrompt will ignore incoming messages from the user during the auth flow, if they are not related to the auth flow. This flag enables ending the OAuthPrompt rather than ignoring the user's message. Typically, this flag will be set to 'true', but is 'false' by default for backwards compatibility.

Parameters:

withEndOnInvalidMessage - The EndOnInvalidMessage value.

setOAuthAppCredentials

public void setOAuthAppCredentials(AppCredentials withOAuthAppCredentials)

Sets the OAuthAppCredentials for OAuthPrompt.

Parameters:

withOAuthAppCredentials - The OAuthAppCredentials value.

setText

public void setText(String withText)

Sets any additional text to include in the sign-in card.

Parameters:

withText - The Text value.

setTimeout

public void setTimeout(Integer withTimeout)

Sets the number of milliseconds the prompt waits for the user to authenticate. Default is 900,000 (15 minutes).

Parameters:

withTimeout - The Timeout value.

setTitle

public void setTitle(String withTitle)

Sets the title of the sign-in card.

Parameters:

withTitle - The Title value.

Applies to