GetConversationMembers class
Chama BotFrameworkAdapter.getConversationMembers() e define o resultado como uma propriedade de memória.
- Extends
-
Dialog<O>
Construtores
| Get |
Propriedades
| $kind | |
| disabled | Uma expressão opcional que, se for true, desabilitará essa ação. |
| property | Caminho da propriedade para colocar o valor. |
Propriedades herdadas
| End |
Obtém um resultado de fim de turno padrão. |
| id | |
| telemetry |
Métodos
| begin |
Inicia uma nova caixa de diálogo e a envia por push para a pilha de diálogos. |
| get |
Métodos herdados
| configure(Record<string, unknown>) | Método fluente para configurar o objeto. |
| continue |
Quando substituído em uma classe derivada, continua a caixa de diálogo. |
| end |
Quando substituído em uma classe derivada, executa a limpeza da caixa de diálogo antes de terminar. |
| get |
Uma cadeia de caracteres codificada usada para ajudar na detecção de alterações de bot na re-implantação. |
| on |
Chamado quando um evento foi gerado, usando |
| reprompt |
Quando substituído em uma classe derivada, reprompta o usuário para entrada. |
| resume |
Quando substituído em uma classe derivada, retoma a caixa de diálogo após a caixa de diálogo acima dela na pilha ser concluída. |
Detalhes do construtor
GetConversationMembers()
new GetConversationMembers()Detalhes da propriedade
$kind
static $kind: stringValor da propriedade
string
disabled
Uma expressão opcional que, se for true, desabilitará essa ação.
disabled?: BoolExpressionValor da propriedade
BoolExpression
property
Caminho da propriedade para colocar o valor.
property: StringExpressionValor da propriedade
StringExpression
Detalhes das propriedades herdadas
EndOfTurn
Obtém um resultado de fim de turno padrão.
static EndOfTurn: DialogTurnResultValor da propriedade
DialogTurnResult
Comentários
Esse resultado indica que uma caixa de diálogo (ou uma etapa lógica em uma caixa de diálogo) concluiu o processamento para a curva atual, ainda está ativa e está aguardando mais entrada.
herdado de dialog.EndOfTurn
id
id: stringValor da propriedade
string
herdado de Dialog.id
telemetryClient
telemetryClient: BotTelemetryClientValor da propriedade
BotTelemetryClient
Herdado de Dialog.telemetryClient
Detalhes do método
beginDialog(DialogContext, O)
Inicia uma nova caixa de diálogo e a envia por push para a pilha de diálogos.
function beginDialog(dc: DialogContext, _options?: O): Promise<DialogTurnResult>Parâmetros
- dc
-
DialogContext
O dialogContext
- _options
-
O
Opcional. Informações iniciais a serem passadas para a caixa de diálogo.
Retornos
Promise<DialogTurnResult>
Um Promise que representa a operação assíncrona.
getConverter(Object)
function getConverter(property: Object): Converter | ConverterFactoryParâmetros
- property
-
Object
A chave da configuração do seletor condicional.
Retornos
Converter | ConverterFactory
O conversor para a configuração do seletor.
Detalhes do método herdado
configure(Record<string, unknown>)
Método fluente para configurar o objeto.
function configure(config: Record<string, unknown>): thisParâmetros
- config
-
Record<string, unknown>
Configurações a serem aplicadas.
Retornos
this
O configurável após a conclusão da operação.
Herdado de Configurble.configure
continueDialog(DialogContext)
Quando substituído em uma classe derivada, continua a caixa de diálogo.
function continueDialog(dc: DialogContext): Promise<DialogTurnResult>Parâmetros
- dc
-
DialogContext
O contexto da curva de diálogo atual.
Retornos
Promise<DialogTurnResult>
Uma promessa de resolução para o resultado da curva da caixa de diálogo.
Comentários
Caixas de diálogo derivadas que dão suporte a conversas de várias voltas devem substituir esse método. Por padrão, esse método sinaliza que a caixa de diálogo está concluída e retorna.
O DialogContext chama esse método quando ele continua a caixa de diálogo.
Para sinalizar para o contexto da caixa de diálogo que essa caixa de diálogo foi concluída, aguarde DialogContext.endDialog antes de sair desse método.
Consulte também
Herdado de Dialog.continueDialog
endDialog(TurnContext, DialogInstance, DialogReason)
Quando substituído em uma classe derivada, executa a limpeza da caixa de diálogo antes de terminar.
function endDialog(_context: TurnContext, _instance: DialogInstance, _reason: DialogReason): Promise<void>Parâmetros
- _context
-
TurnContext
O objeto de contexto para a curva.
- _instance
-
DialogInstance
Informações de estado atuais para essa caixa de diálogo.
- _reason
-
DialogReason
O motivo pelo qual a caixa de diálogo está terminando.
Retornos
Promise<void>
Comentários
As caixas de diálogo derivadas que precisam executar o registro em log ou a limpeza antes de terminar devem substituir esse método. Por padrão, esse método não tem efeito.
O dialogContext
Consulte também
- DialogContext.cancelAllDialogs
- dialogContext.endDialog
-
DialogContext.replaceDialog
Herdado de Dialog.endDialog
getVersion()
Uma cadeia de caracteres codificada usada para ajudar na detecção de alterações de bot na re-implantação.
function getVersion(): stringRetornos
string
Cadeia de caracteres exclusiva que só deve ser alterada quando a caixa de diálogo foi alterada de uma maneira que deve reiniciar a caixa de diálogo.
Comentários
Esse padrão é retornar as caixas de diálogo id mas pode ser substituído para fornecer uma lógica de detecção de alterações mais precisa. Qualquer caixa de diálogo na pilha que tenha sua alteração de versão resultará em um evento versionChanged será gerado. Se esse evento não for tratado pelo bot, um erro será gerado, resultando na execução da lógica do manipulador de erros de bots.
Retornar uma cadeia de caracteres vazia desabilitará o acompanhamento de versão para o componente.
Herdado de Dialog.getVersion
onDialogEvent(DialogContext, DialogEvent)
Chamado quando um evento foi gerado, usando DialogContext.emitEvent(), pela caixa de diálogo atual ou por uma caixa de diálogo iniciada pela caixa de diálogo atual.
function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>Parâmetros
- dc
-
DialogContext
O contexto da caixa de diálogo para a virada atual da conversa.
- e
-
DialogEvent
O evento que está sendo gerado.
Retornos
Promise<boolean>
True se o evento for tratado pela caixa de diálogo atual e o borbulhamento deve parar.
herdado da caixa de diálogo.onDialogEvent
repromptDialog(TurnContext, DialogInstance)
Quando substituído em uma classe derivada, reprompta o usuário para entrada.
function repromptDialog(_context: TurnContext, _instance: DialogInstance): Promise<void>Parâmetros
- _context
-
TurnContext
O objeto de contexto para a curva.
- _instance
-
DialogInstance
Informações de estado atuais para essa caixa de diálogo.
Retornos
Promise<void>
Comentários
Caixas de diálogo derivadas que dão suporte à validação e à lógica de nova solicitação devem substituir esse método. Por padrão, esse método não tem efeito.
O
Consulte também
Herdado de Dialog.repromptDialog
resumeDialog(DialogContext, DialogReason, any)
Quando substituído em uma classe derivada, retoma a caixa de diálogo após a caixa de diálogo acima dela na pilha ser concluída.
function resumeDialog(dc: DialogContext, reason: DialogReason, result?: any): Promise<DialogTurnResult>Parâmetros
- dc
-
DialogContext
O contexto da curva de diálogo atual.
- reason
-
DialogReason
O motivo pelo qual a caixa de diálogo está sendo retomada. Normalmente, isso será dialogReason.endCalled
- result
-
any
Opcional. O valor retornado, se houver, da caixa de diálogo que terminou.
Retornos
Promise<DialogTurnResult>
Uma promessa de resolução para o resultado da curva da caixa de diálogo.
Comentários
Caixas de diálogo derivadas que dão suporte a conversas de várias voltas devem substituir esse método. Por padrão, esse método sinaliza que a caixa de diálogo está concluída e retorna.
O DialogContext chama esse método quando ele retoma a caixa de diálogo. Se a caixa de diálogo anterior na pilha retornar um valor, esse valor estará no parâmetro result.
Para iniciar uma caixa de diálogo filho
Consulte também
Herdado de Dialog.resumeDialog