AttachmentInput class

Package:

botbuilder-dialogs-adaptive

Input dialog which prompts the user to send a file.

Extends

InputDialog

Constructors

AttachmentInput(string, Partial<Activity> | string)

Initializes a new instance of the InputDialog class

Properties

$kind
outputFormat

Inherited Properties

allowInterruptions	Interruption policy.
alwaysPrompt	A value indicating whether the input should always prompt the user regardless of there being a value or not.
defaultValue	The default value for the input dialog when maxTurnCount is exceeded.
defaultValueResponse	The activity template to send when maxTurnCount has be reached and the default value is used.
disabled	An optional expression which if is true will disable this action.
EndOfTurn	Gets a default end-of-turn result.
id
invalidPrompt	The activity template to send to the user whenever the value provided is invalid or not.
maxTurnCount	Maximum number of times to ask the user for this value before the dialog gives up.
OPTIONS_PROPERTY
prompt	The activity to send to the user.
property	The value expression which the input will be bound to.
telemetryClient
TURN_COUNT_PROPERTY
unrecognizedPrompt	The activity template for retrying prompt.
validations	The expressions to run to validate the input.
value	A value expression which can be used to initialize the input prompt.
VALUE_PROPERTY

Methods

getConverter(Object)

Inherited Methods

beginDialog(DialogContext, any)	Called when the Dialog is started and pushed onto the dialog stack.
configure(Record<string, unknown>)	Fluent method for configuring the object.
continueDialog(DialogContext)	Called when the Dialog is continued, where it is the active dialog and the user replies with a new activity.
endDialog(TurnContext, DialogInstance, DialogReason)	When overridden in a derived class, performs clean up for the dialog before it ends.
getVersion()	An encoded string used to aid in the detection of bot changes on re-deployment.
onDialogEvent(DialogContext, DialogEvent)	Called when an event has been raised, using DialogContext.emitEvent(), by either the current dialog or a dialog that the current dialog started.
repromptDialog(TurnContext, DialogInstance)	When overridden in a derived class, reprompts the user for input.
resumeDialog(DialogContext, DialogReason, any)	Called when a child Dialog completes its turn, returning control to this dialog.

Constructor Details

AttachmentInput(string, Partial<Activity> | string)

Initializes a new instance of the InputDialog class

new AttachmentInput(property?: string, prompt?: Partial<Activity> | string)

Parameters

property

string

Optional. The value expression which the input will be bound to.

prompt

Partial<Activity> | string

Optional. The Activity to send to the user, if a string is specified it will instantiates an ActivityTemplate.

Property Details

$kind

static $kind: string

Property Value

string

outputFormat

outputFormat: EnumExpression<AttachmentOutputFormat>

Property Value

EnumExpression<AttachmentOutputFormat>

Inherited Property Details

allowInterruptions

Interruption policy.

allowInterruptions: BoolExpression

Property Value

BoolExpression

Inherited From InputDialog.allowInterruptions

alwaysPrompt

A value indicating whether the input should always prompt the user regardless of there being a value or not.

alwaysPrompt: BoolExpression

Property Value

BoolExpression

Inherited From InputDialog.alwaysPrompt

defaultValue

The default value for the input dialog when maxTurnCount is exceeded.

defaultValue?: ValueExpression

Property Value

ValueExpression

Inherited From InputDialog.defaultValue

defaultValueResponse

The activity template to send when maxTurnCount has be reached and the default value is used.

defaultValueResponse: TemplateInterface<Partial<Activity>, DialogStateManager>

Property Value

TemplateInterface<Partial<Activity>, DialogStateManager>

Inherited From InputDialog.defaultValueResponse

disabled

An optional expression which if is true will disable this action.

disabled?: BoolExpression

Property Value

BoolExpression

Inherited From InputDialog.disabled

EndOfTurn

Gets a default end-of-turn result.

static EndOfTurn: DialogTurnResult

Property Value

DialogTurnResult

Remarks

This result indicates that a dialog (or a logical step within a dialog) has completed processing for the current turn, is still active, and is waiting for more input.

Inherited From Dialog.EndOfTurn

id

id: string

Property Value

string

Inherited From Dialog.id

invalidPrompt

The activity template to send to the user whenever the value provided is invalid or not.

invalidPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Property Value

TemplateInterface<Partial<Activity>, DialogStateManager>

Inherited From InputDialog.invalidPrompt

maxTurnCount

Maximum number of times to ask the user for this value before the dialog gives up.

maxTurnCount?: IntExpression

Property Value

IntExpression

Inherited From InputDialog.maxTurnCount

OPTIONS_PROPERTY

static OPTIONS_PROPERTY: string

Property Value

string

Inherited From InputDialog.OPTIONS_PROPERTY

prompt

The activity to send to the user.

prompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Property Value

TemplateInterface<Partial<Activity>, DialogStateManager>

Inherited From InputDialog.prompt

property

The value expression which the input will be bound to.

property: StringExpression

Property Value

StringExpression

Inherited From InputDialog.property

telemetryClient

telemetryClient: BotTelemetryClient

Property Value

BotTelemetryClient

Inherited From Dialog.telemetryClient

TURN_COUNT_PROPERTY

static TURN_COUNT_PROPERTY: string

Property Value

string

Inherited From InputDialog.TURN_COUNT_PROPERTY

unrecognizedPrompt

The activity template for retrying prompt.

unrecognizedPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Property Value

TemplateInterface<Partial<Activity>, DialogStateManager>

Inherited From InputDialog.unrecognizedPrompt

validations

The expressions to run to validate the input.

validations: string[]

Property Value

string[]

Inherited From InputDialog.validations

value

A value expression which can be used to initialize the input prompt.

value: ValueExpression

Property Value

ValueExpression

Inherited From InputDialog.value

VALUE_PROPERTY

static VALUE_PROPERTY: string

Property Value

string

Inherited From InputDialog.VALUE_PROPERTY

Method Details

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

Parameters

property

Object

The key of the conditional selector configuration.

Returns

Converter | ConverterFactory

The converter for the selector configuration.

Inherited Method Details

beginDialog(DialogContext, any)

Called when the Dialog is started and pushed onto the dialog stack.

function beginDialog(dc: DialogContext, options?: any): Promise<DialogTurnResult>

Parameters

dc

DialogContext

The DialogContext for the current turn of conversation.

options

any

Optional. Initial information to pass to the Dialog.

Returns

Promise<DialogTurnResult>

A DialogTurnResult Promise representing the asynchronous operation.

Inherited From InputDialog.beginDialog

configure(Record<string, unknown>)

Fluent method for configuring the object.

function configure(config: Record<string, unknown>): this

Parameters

config

Record<string, unknown>

Configuration settings to apply.

Returns

this

The Configurable after the operation is complete.

Inherited From Configurable.configure

continueDialog(DialogContext)

Called when the Dialog is continued, where it is the active dialog and the user replies with a new activity.

function continueDialog(dc: DialogContext): Promise<DialogTurnResult>

Parameters

dc

DialogContext

The DialogContext for the current turn of conversation.

Returns

Promise<DialogTurnResult>

A DialogTurnResult Promise representing the asynchronous operation.

Inherited From InputDialog.continueDialog

endDialog(TurnContext, DialogInstance, DialogReason)

When overridden in a derived class, performs clean up for the dialog before it ends.

function endDialog(_context: TurnContext, _instance: DialogInstance, _reason: DialogReason): Promise<void>

Parameters

_context

TurnContext

The context object for the turn.

_instance

DialogInstance

Current state information for this dialog.

_reason

DialogReason

The reason the dialog is ending.

Returns

Promise<void>

Remarks

Derived dialogs that need to perform logging or cleanup before ending should override this method. By default, this method has no effect.

The DialogContext calls this method when the current dialog is ending.

See also

• DialogContext.cancelAllDialogs
• DialogContext.endDialog
• DialogContext.replaceDialog

Inherited From Dialog.endDialog

getVersion()

An encoded string used to aid in the detection of bot changes on re-deployment.

function getVersion(): string

Returns

string

Unique string which should only change when dialog has changed in a way that should restart the dialog.

Remarks

This defaults to returning the dialogs id but can be overridden to provide more precise change detection logic. Any dialog on the stack that has its version change will result in a versionChanged event will be raised. If this event is not handled by the bot, an error will be thrown resulting in the bots error handler logic being run.

Returning an empty string will disable version tracking for the component all together.

Inherited From Dialog.getVersion

onDialogEvent(DialogContext, DialogEvent)

Called when an event has been raised, using DialogContext.emitEvent(), by either the current dialog or a dialog that the current dialog started.

function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>

Parameters

dc

DialogContext

The dialog context for the current turn of conversation.

e

DialogEvent

The event being raised.

Returns

Promise<boolean>

True if the event is handled by the current dialog and bubbling should stop.

Inherited From Dialog.onDialogEvent

repromptDialog(TurnContext, DialogInstance)

When overridden in a derived class, reprompts the user for input.

function repromptDialog(_context: TurnContext, _instance: DialogInstance): Promise<void>

Parameters

_context

TurnContext

The context object for the turn.

_instance

DialogInstance

Current state information for this dialog.

Returns

Promise<void>

Remarks

Derived dialogs that support validation and re-prompt logic should override this method. By default, this method has no effect.

The DialogContext calls this method when the current dialog should re-request input from the user. This method is implemented for prompt dialogs.

See also

• DialogContext.repromptDialog
• Prompt

Inherited From Dialog.repromptDialog

resumeDialog(DialogContext, DialogReason, any)

Called when a child Dialog completes its turn, returning control to this dialog.

function resumeDialog(dc: DialogContext, _reason: DialogReason, _result?: any): Promise<DialogTurnResult>

Parameters

dc

DialogContext

The DialogContext for the current turn of conversation.

_reason

DialogReason

(xref:botbuilder-dialogs.DialogReason), reason why the dialog resumed.

_result

any

Optional. Value returned from the Dialog that was called. The type of the value returned is dependent on the child dialog.

Returns

Promise<DialogTurnResult>

A DialogTurnResult Promise representing the asynchronous operation.

Inherited From InputDialog.resumeDialog