OAuthPromptSettings interface

Package:

botbuilder-dialogs

Settings used to configure an OAuthPrompt instance.

Properties

connectionName	Name of the OAuth connection being used.
endOnInvalidMessage	(Optional) 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.
oAuthAppCredentials	AppCredentials for OAuth.
showSignInLink	(Optional) value to force the display of a Sign In link overriding the default behavior. True to display the SignInLink.
text	(Optional) additional text to include on the signin card.
timeout	(Optional) number of milliseconds the prompt will wait for the user to authenticate. Defaults to a value 900,000 (15 minutes.)
title	Title of the cards signin button.

Property Details

connectionName

Name of the OAuth connection being used.

connectionName: string

Property Value

string

endOnInvalidMessage

(Optional) 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.

endOnInvalidMessage?: boolean

Property Value

boolean

oAuthAppCredentials

AppCredentials for OAuth.

oAuthAppCredentials?: CoreAppCredentials

Property Value

CoreAppCredentials

showSignInLink

(Optional) value to force the display of a Sign In link overriding the default behavior. True to display the SignInLink.

showSignInLink?: boolean

Property Value

boolean

text

(Optional) additional text to include on the signin card.

text?: string

Property Value

string

timeout

(Optional) number of milliseconds the prompt will wait for the user to authenticate. Defaults to a value 900,000 (15 minutes.)

timeout?: number

Property Value

number

title

Title of the cards signin button.

title: string

Property Value

string