botframework-schema package
Classes
| CallerIdConstants |
Constantes usadas para preencher a propriedade Activity.callerId. |
| SpeechConstants |
Define constantes que podem ser usadas no processamento de interações de fala. |
Interfaces
| CommandResultValue |
O campo de valor de um ICommandResultActivity contém metadados relacionados a um resultado de comando. Uma carga de dados extensível opcional pode ser incluída se definida pelo nome da atividade de comando. A presença de um campo de erro indica que o comando original não foi concluído. |
| CommandValue |
O campo de valor de um ICommandActivity contém metadados relacionados a um comando. Uma carga de dados extensível opcional pode ser incluída se definida pelo nome da atividade de comando. |
| IActivity | |
| ICommandActivity |
Comando externo assíncrono. |
| ICommandResultActivity |
Resultado de comando externo assíncrono. |
| IContactRelationUpdateActivity | |
| IConversationUpdateActivity | |
| IEndOfConversationActivity | |
| IEventActivity | |
| IInstallationUpdateActivity | |
| IInvokeActivity | |
| IMessageActivity | |
| IMessageReactionActivity | |
| IMessageUpdateActivity | |
| ISuggestionActivity | |
| ITraceActivity | |
| Activity |
Uma Atividade é o tipo de comunicação básico para o protocolo Bot Framework 3.0. |
| ActivityTimestamps |
Essa interface é usada para preservar os valores de cadeia de caracteres originais de datas em Atividades. Quando uma atividade é recebida, os carimbos de data/hora são convertidos em Datas. Devido à forma como os objetos Data javascript são UTC, os valores de deslocamento de fuso horário são perdidos. |
| AdaptiveCardAuthentication |
Define a estrutura que chega na atividade Activity.Value.Authentication para Invoke com o Nome de 'adaptiveCard/action'. |
| AdaptiveCardInvokeAction |
Define a estrutura que chega na atividade Activity.Value.Action para Invoke com o Nome de 'adaptiveCard/action'. |
| AdaptiveCardInvokeResponse |
Define a estrutura retornada como resultado de uma atividade Invoke com o Nome de 'adaptiveCard/action'. |
| AdaptiveCardInvokeValue |
Define a estrutura que chega na atividade Activity.Value para a atividade Invoke com o Nome de 'adaptiveCard/action'. |
| AnimationCard |
Um cartão de animação (por exemplo: gif ou clipe de vídeo curto) |
| Attachment |
Um anexo dentro de uma atividade |
| AttachmentData |
Dados do anexo |
| AttachmentInfo |
Metadados de um anexo |
| AttachmentView |
Nome e tamanho da Exibição de Anexo |
| AudioCard |
Cartão de áudio |
| BasicCard |
Um cartão básico |
| CardAction |
Uma ação clicável |
| CardImage |
Uma imagem em um cartão |
| ChannelAccount |
Informações da conta de canal necessárias para rotear uma mensagem |
| ConversationAccount |
Informações da conta de canal para uma conversa |
| ConversationMembers |
Conversa e seus membros |
| ConversationParameters |
Parâmetros para criar uma nova conversa |
| ConversationReference |
Um objeto relacionado a um ponto específico em uma conversa |
| ConversationResourceResponse |
Uma resposta que contém um recurso |
| ConversationsResult |
Resultado das conversas |
| Entity |
Objeto de metadados relativo a uma atividade |
| ErrorModel |
Objeto que representa informações de erro |
| ErrorResponse |
Uma resposta da API HTTP |
| ExpectedReplies |
Respostas esperadas em resposta a DeliveryModes.ExpectReplies |
| Fact |
Conjunto de pares chave-valor. A vantagem desta seção é que as propriedades de chave e valor serão renderizadas com informações de estilo padrão com algum delimitador entre elas. Portanto, não é necessário que o desenvolvedor especifique informações de estilo. |
| GeoCoordinates |
GeoCoordinates (tipo de entidade: "https://schema.org/GeoCoordinates") |
| HeroCard |
Um cartão Hero (cartão com uma única imagem grande) |
| IStatusCodeError | |
| InnerHttpError |
Objeto que representa o erro http interno |
| InvokeResponse |
Representa uma resposta retornada por um bot quando ele recebe uma |
| MediaCard |
Cartão de mídia |
| MediaEventValue |
Parâmetro suplementar para eventos de mídia |
| MediaUrl |
URL de mídia |
| Mention |
Informações de menção (tipo de entidade: "menção") |
| MessageReaction |
Objeto de reação de mensagem |
| MicrosoftPayMethodData |
Dados da forma de pagamento W3C para Microsoft Pay |
| OAuthCard |
Um cartão que representa uma solicitação para executar uma entrada por meio do OAuth |
| PagedMembersResult |
Página de membros. |
| PaymentAddress |
Endereço em uma Solicitação de Pagamento |
| PaymentCurrencyAmount |
Fornece valores monetários |
| PaymentDetails |
Fornece informações sobre a transação solicitada |
| PaymentDetailsModifier |
Fornece detalhes que modificam o PaymentDetails com base no identificador da forma de pagamento |
| PaymentItem |
Indica para que serve a solicitação de pagamento e o valor solicitado |
| PaymentMethodData |
Indica um conjunto de formas de pagamento com suporte e quaisquer dados específicos da forma de pagamento associada para essas formas |
| PaymentOptions |
Fornece informações sobre as opções desejadas para a solicitação de pagamento |
| PaymentRequest |
Uma solicitação para fazer um pagamento |
| PaymentRequestComplete |
Conteúdo entregue ao concluir uma solicitação de pagamento |
| PaymentRequestCompleteResult |
Resultado de uma solicitação de pagamento concluída |
| PaymentRequestUpdate |
Uma atualização para uma solicitação de pagamento |
| PaymentRequestUpdateResult |
Um objeto de resultado de uma operação de invocação de Atualização de Solicitação de Pagamento |
| PaymentResponse |
Um PaymentResponse é retornado quando um usuário seleciona uma forma de pagamento e aprova uma solicitação de pagamento |
| PaymentShippingOption |
Descreve uma opção de envio |
| Place |
Local (tipo de entidade: "https://schema.org/Place") |
| ReceiptCard |
Um cartão de recibo |
| ReceiptItem |
Um item em um cartão de recibo |
| ResourceResponse |
Uma resposta que contém uma ID de recurso |
| SearchInvokeOptions |
Fornece informações sobre as opções desejadas para um SearchInvokeValue |
| SearchInvokeResponse |
Define a estrutura retornada como resultado de uma atividade Invoke com o Nome de 'aplicativo/pesquisa'. |
| SearchInvokeValue |
Define a estrutura que chega na atividade Activity.Value para a atividade Invoke com o Nome de 'aplicativo/pesquisa'. |
| SemanticAction |
Representa uma referência a uma ação programática |
| SignInUrlResponse | |
| SigninCard |
Um cartão que representa uma solicitação para entrar |
| SuggestedActions |
SuggestedActions que podem ser executadas |
| TextHighlight |
Refere-se a uma subcadeia de caracteres de conteúdo dentro de outro campo |
| Thing |
Coisa (tipo de entidade: "https://schema.org/Thing") |
| ThumbnailCard |
Um cartão em miniatura (cartão com uma imagem em miniatura única e pequena) |
| ThumbnailUrl |
URL da miniatura |
| TokenExchangeRequest | |
| TokenExchangeResource | |
| TokenRequest |
Uma solicitação para receber um token de usuário |
| TokenResponse |
Uma resposta que inclui um token de usuário |
| Transcript |
Transcrição |
| VideoCard |
Placa de vídeo |
| MessageActionsPayloadBody | |
| O365ConnectorCardActionBase | |
| O365ConnectorCardInputBase | |
| TeamsAttachment | |
| AppBasedLinkQuery | |
| CacheInfo | |
| ChannelInfo | |
| ConversationList | |
| FileConsentCard | |
| FileConsentCardResponse | |
| FileDownloadInfo | |
| FileInfoCard | |
| FileUploadInfo | |
| Meeting | |
| MeetingDetails | |
| MeetingDetailsBase | |
| MeetingEndEventDetails | |
| MeetingEventDetails | |
| MeetingInfo | |
| MeetingStartEventDetails | |
| MessageActionsPayload | |
| MessageActionsPayloadApp | |
| MessageActionsPayloadAttachment | |
| MessageActionsPayloadConversation | |
| MessageActionsPayloadFrom | |
| MessageActionsPayloadMention | |
| MessageActionsPayloadReaction | |
| MessageActionsPayloadUser | |
| MessagingExtensionAction | |
| MessagingExtensionActionResponse | |
| MessagingExtensionAttachment | |
| MessagingExtensionParameter | |
| MessagingExtensionQuery | |
| MessagingExtensionQueryOptions | |
| MessagingExtensionResponse | |
| MessagingExtensionResult | |
| MessagingExtensionSuggestedAction | |
| NotificationInfo | |
| O365ConnectorCard | |
| O365ConnectorCardActionCard | |
| O365ConnectorCardActionQuery | |
| O365ConnectorCardDateInput | |
| O365ConnectorCardFact | |
| O365ConnectorCardHttpPOST | |
| O365ConnectorCardImage | |
| O365ConnectorCardMultichoiceInput | |
| O365ConnectorCardMultichoiceInputChoice | |
| O365ConnectorCardOpenUri | |
| O365ConnectorCardOpenUriTarget | |
| O365ConnectorCardSection | |
| O365ConnectorCardTextInput | |
| O365ConnectorCardViewAction | |
| SigninStateVerificationQuery | |
| TabContext | |
| TabEntityContext | |
| TabRequest | |
| TabResponse | |
| TabResponseCard | |
| TabResponseCards | |
| TabResponsePayload | |
| TabSubmit | |
| TabSubmitData | |
| TabSuggestedActions | |
| TaskModuleCardResponse | |
| TaskModuleContinueResponse | |
| TaskModuleMessageResponse | |
| TaskModuleRequest | |
| TaskModuleRequestContext | |
| TaskModuleResponse | |
| TaskModuleResponseBase | |
| TaskModuleTaskInfo | |
| TeamDetails | |
| TeamInfo | |
| TeamsChannelAccount | |
| TeamsChannelData | |
| TeamsChannelDataSettings | |
| TeamsMeetingInfo | |
| TeamsMeetingParticipant | |
| TeamsPagedMembersResult | |
| TenantInfo | |
| TokenExchangeInvokeRequest |
Uma solicitação para trocar um token. |
| TokenExchangeInvokeResponse |
O objeto de resposta de uma invocação de troca de tokens. |
Aliases de tipo
| IHandoffActivity | |
| IMessageDeleteActivity | |
| ITypingActivity | |
| TokenExchangeState |
Objeto de estado passado para o serviço de token de bot. |
| TokenStatus |
O status de um token específico. |
| FileDownloadInfoAttachment | |
| O365ConnectorCardActionType |
Define valores para Type. Os valores possíveis incluem: 'ViewAction', 'OpenUri', 'HttpPOST', 'ActionCard' |
| O365ConnectorCardInputType |
Define valores para O365ConnectorCardInputType. Os valores possíveis incluem: 'textInput', 'dateInput', 'multichoiceInput' |
| Action |
Define valores para Action. Os valores possíveis incluem: 'accept', 'decline' |
| ActivityImageType |
Define valores para ActivityImageType. Os valores possíveis incluem: 'avatar', 'article' |
| ApplicationIdentityType |
Define valores para ApplicationIdentityType. Os valores possíveis incluem: 'aadApplication', 'bot', 'tenantBot', 'office365Connector', 'webhook' |
| AttachmentLayout |
Define valores para AttachmentLayout. Os valores possíveis incluem: 'list', 'grid' |
| BotMessagePreviewActionType |
Define valores para BotMessagePreviewActionType. Os valores possíveis incluem: 'edit', 'send' |
| BotMessagePreviewType |
Define valores para BotMessagePreviewType. Os valores possíveis incluem: 'message', 'continue' |
| CommandContext |
Define valores para CommandContext. Os valores possíveis incluem: 'message', 'compose', 'commandbox' |
| ContentType |
Define valores para ContentType. Os valores possíveis incluem: 'html', 'text' |
| ConversationIdentityType |
Define valores para ConversationIdentityType. Os valores possíveis incluem: 'team', 'channel' |
| Importance |
Define valores para Importance. Os valores possíveis incluem: 'normal', 'alto', 'urgente' |
| MessageType |
Define valores para MessageType. Os valores possíveis incluem: 'message' |
| MessagingExtensionResultType |
Define valores para MessagingExtensionResultType. Os valores possíveis incluem: 'result', 'auth', 'config', 'message', 'botMessagePreview', 'silentAuth'. |
| O365ConnectorCardInputBaseType |
Define valores para O365ConnectorCardInputBaseType. Os valores possíveis incluem: 'textInput', 'dateInput', 'multichoiceInput' |
| Os |
Define valores para so. Os valores possíveis incluem: 'default', 'iOS', 'android', 'windows' |
| ReactionType |
Define valores para ReactionType. Os valores possíveis incluem: 'like', 'heart', 'laugh', 'surprised', 'sad', 'angry' |
| Style |
Define valores para Style. Os valores possíveis incluem: 'compact', 'expanded' |
| Type |
Define valores para Type. Os valores possíveis incluem: 'ViewAction', 'OpenUri', 'HttpPOST', 'ActionCard' |
| Type1 | |
| Type2 | |
| Type3 | |
| UserIdentityType |
Define valores para UserIdentityType. Os valores possíveis incluem: 'aadUser', 'onPremiseAadUser', 'anonymousGuest', 'federatedUser' |
Enumerações
| ActionTypes |
Define valores para ActionTypes. Os valores possíveis incluem: 'openUrl', 'imBack', 'postBack', 'playAudio', 'playVideo', 'showImage', 'downloadFile', 'signin', 'call', messageBack', 'openApp' |
| ActivityEventNames |
Define valores para ActivityEventNames. Os valores possíveis incluem: 'continueConversation', 'createConversation' |
| ActivityImportance |
Define valores para ActivityImportance. Os valores possíveis incluem: 'low', 'normal', 'high' |
| ActivityTypes |
Define valores para ActivityTypes. Os valores possíveis incluem: 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff' |
| AttachmentLayoutTypes |
Define valores para AttachmentLayoutTypes. Os valores possíveis incluem: 'list', 'carousel' |
| Channels |
Define valores para ChannelIds para Canais. Os valores possíveis incluem: 'alexa', 'console', 'cortana', 'directline', 'directlinespeech', 'email', 'emulator', 'facebook', 'groupme', 'kik', 'line', 'msteams', 'onmichannel', 'outlook', 'skype', 'skypeforbusiness', 'slack', 'sms', 'telegram', 'test', 'twilio-sms', 'webchat' |
| ContactRelationUpdateActionTypes |
Define valores para ContactRelationUpdateActionTypes. Os valores possíveis incluem: 'add', 'remove' |
| DeliveryModes |
Define valores para DeliveryModes. Os valores possíveis incluem: 'normal', 'notification', 'expectReplies', 'efêmero' |
| EndOfConversationCodes |
Define valores para EndOfConversationCodes. Os valores possíveis incluem: 'unknown', 'completedSuccessfully', 'userCancelled', 'botTimedOut', 'botIssuedInvalidMessage', 'channelFailed' |
| InputHints |
Define valores para InputHints. Os valores possíveis incluem: 'acceptingInput', 'ignoringInput', 'expectingInput' |
| InstallationUpdateActionTypes |
Define valores para InstallationUpdateActionTypes. Os valores possíveis incluem: 'add', 'remove' |
| MessageReactionTypes |
Define valores para MessageReactionTypes. Os valores possíveis incluem: 'like', 'plusOne' |
| RoleTypes |
Define valores para RoleTypes. Os valores possíveis incluem: 'user', 'bot', 'skill' |
| SemanticActionStateTypes |
Define valores para SemanticActionStateTypes. Os valores possíveis incluem: 'start', 'continue', 'done' |
| StatusCodes |
Define valores para StatusCodes. Os valores possíveis incluem: 200, 400, 401, 404, 405, 409, 426, 500, 501, 502 |
| TextFormatTypes |
Define valores para TextFormatTypes. Os valores possíveis incluem: 'markdown', 'plain', 'xml' |
Funções
Detalhes da função
assertActivity(unknown, unknown[])
function assertActivity(val: unknown, _args: unknown[]): assertsParâmetros
- val
-
unknown
- _args
-
unknown[]
Retornos
asserts
assertAttachment(unknown, unknown[])
function assertAttachment(val: unknown, _args: unknown[]): assertsParâmetros
- val
-
unknown
- _args
-
unknown[]
Retornos
asserts
assertAttachmentInfo(unknown, unknown[])
function assertAttachmentInfo(val: unknown, _args: unknown[]): assertsParâmetros
- val
-
unknown
- _args
-
unknown[]
Retornos
asserts
assertAttachmentView(unknown, unknown[])
function assertAttachmentView(val: unknown, _args: unknown[]): assertsParâmetros
- val
-
unknown
- _args
-
unknown[]
Retornos
asserts
assertCardAction(unknown, unknown[])
function assertCardAction(val: unknown, _args: unknown[]): assertsParâmetros
- val
-
unknown
- _args
-
unknown[]
Retornos
asserts
assertChannelAccount(unknown, unknown[])
function assertChannelAccount(val: unknown, _args: unknown[]): assertsParâmetros
- val
-
unknown
- _args
-
unknown[]
Retornos
asserts
assertConversationAccount(unknown, unknown[])
function assertConversationAccount(val: unknown, _args: unknown[]): assertsParâmetros
- val
-
unknown
- _args
-
unknown[]
Retornos
asserts
assertConversationReference(unknown, unknown[])
function assertConversationReference(val: unknown, _args: unknown[]): assertsParâmetros
- val
-
unknown
- _args
-
unknown[]
Retornos
asserts
assertEntity(unknown, unknown[])
function assertEntity(val: unknown, _args: unknown[]): assertsParâmetros
- val
-
unknown
- _args
-
unknown[]
Retornos
asserts
assertMessageReaction(unknown, unknown[])
function assertMessageReaction(val: unknown, _args: unknown[]): assertsParâmetros
- val
-
unknown
- _args
-
unknown[]
Retornos
asserts
assertSemanticAction(unknown, unknown[])
function assertSemanticAction(val: unknown, _args: unknown[]): assertsParâmetros
- val
-
unknown
- _args
-
unknown[]
Retornos
asserts
assertSuggestedActions(unknown, unknown[])
function assertSuggestedActions(val: unknown, _args: unknown[]): assertsParâmetros
- val
-
unknown
- _args
-
unknown[]
Retornos
asserts
isActivity(unknown)
function isActivity(val: unknown): booleanParâmetros
- val
-
unknown
Retornos
boolean
isAttachment(unknown)
function isAttachment(val: unknown): booleanParâmetros
- val
-
unknown
Retornos
boolean
isAttachmentInfo(unknown)
function isAttachmentInfo(val: unknown): booleanParâmetros
- val
-
unknown
Retornos
boolean
isAttachmentView(unknown)
function isAttachmentView(val: unknown): booleanParâmetros
- val
-
unknown
Retornos
boolean
isCardAction(unknown)
function isCardAction(val: unknown): booleanParâmetros
- val
-
unknown
Retornos
boolean
isChannelAccount(unknown)
function isChannelAccount(val: unknown): booleanParâmetros
- val
-
unknown
Retornos
boolean
isConversationAccount(unknown)
function isConversationAccount(val: unknown): booleanParâmetros
- val
-
unknown
Retornos
boolean
isConversationReference(unknown)
function isConversationReference(val: unknown): booleanParâmetros
- val
-
unknown
Retornos
boolean
isEntity(unknown)
function isEntity(val: unknown): booleanParâmetros
- val
-
unknown
Retornos
boolean
isMessageReaction(unknown)
function isMessageReaction(val: unknown): booleanParâmetros
- val
-
unknown
Retornos
boolean
isSemanticAction(unknown)
function isSemanticAction(val: unknown): booleanParâmetros
- val
-
unknown
Retornos
boolean
isSuggestedActions(unknown)
function isSuggestedActions(val: unknown): booleanParâmetros
- val
-
unknown
Retornos
boolean