botframework-schema package
Clases
| CallerIdConstants |
Constantes usadas para rellenar la propiedad Activity.callerId. |
| SpeechConstants |
Define constantes que se pueden usar en el procesamiento de interacciones de voz. |
Interfaces
| CommandResultValue |
El campo de valor de ICommandResultActivity contiene metadatos relacionados con un resultado de comando. Se puede incluir una carga de datos extensible opcional si se define mediante el nombre de la actividad del comando. La presencia de un campo de error indica que el comando original no se pudo completar. |
| CommandValue |
El campo de valor de un ICommandActivity contiene metadatos relacionados con un comando. Se puede incluir una carga de datos extensible opcional si se define mediante el nombre de la actividad del comando. |
| IActivity | |
| ICommandActivity |
Comando externo asincrónico. |
| ICommandResultActivity |
Resultado del comando externo asincrónico. |
| IContactRelationUpdateActivity | |
| IConversationUpdateActivity | |
| IEndOfConversationActivity | |
| IEventActivity | |
| IInstallationUpdateActivity | |
| IInvokeActivity | |
| IMessageActivity | |
| IMessageReactionActivity | |
| IMessageUpdateActivity | |
| ISuggestionActivity | |
| ITraceActivity | |
| Activity |
Una actividad es el tipo de comunicación básico para el protocolo Bot Framework 3.0. |
| ActivityTimestamps |
Esta interfaz se usa para conservar los valores de cadena originales de fechas en Activities. Cuando se recibe una actividad, las marcas de tiempo se convierten en Fechas. Debido a cómo los objetos Date de Javascript son UTC, se pierden los valores de desplazamiento de zona horaria. |
| AdaptiveCardAuthentication |
Define la estructura que llega a la actividad Activity.Value.Authentication para invocar con el nombre de "adaptiveCard/action". |
| AdaptiveCardInvokeAction |
Define la estructura que llega a la actividad Activity.Value.Action for Invoke con el nombre de "adaptiveCard/action". |
| AdaptiveCardInvokeResponse |
Define la estructura que se devuelve como resultado de una actividad Invoke con el nombre "adaptiveCard/action". |
| AdaptiveCardInvokeValue |
Define la estructura que llega a la actividad Activity.Value for Invoke con el nombre de "adaptiveCard/action". |
| AnimationCard |
Una tarjeta de animación (por ejemplo: gif o clip de vídeo corto) |
| Attachment |
Datos adjuntos dentro de una actividad |
| AttachmentData |
Datos adjuntos |
| AttachmentInfo |
Metadatos de datos adjuntos |
| AttachmentView |
Nombre y tamaño de la vista de datos adjuntos |
| AudioCard |
Tarjeta de audio |
| BasicCard |
Una tarjeta básica |
| CardAction |
Una acción en la que se puede hacer clic |
| CardImage |
Imagen en una tarjeta |
| ChannelAccount |
Información de la cuenta de canal necesaria para enrutar un mensaje |
| ConversationAccount |
Información de la cuenta de canal para una conversación |
| ConversationMembers |
Conversación y sus miembros |
| ConversationParameters |
Parámetros para crear una nueva conversación |
| ConversationReference |
Objeto relacionado con un punto determinado de una conversación |
| ConversationResourceResponse |
Una respuesta que contiene un recurso |
| ConversationsResult |
Resultado de conversaciones |
| Entity |
Objeto de metadatos que pertenece a una actividad |
| ErrorModel |
Objeto que representa información de error |
| ErrorResponse |
Una respuesta de LA API HTTP |
| ExpectedReplies |
Respuestas esperadas en respuesta a DeliveryModes.ExpectReplies |
| Fact |
Conjunto de pares clave-valor. La ventaja de esta sección es que las propiedades de clave y valor se representarán con información de estilo predeterminada con algún delimitador entre ellos. Por lo tanto, no es necesario que el desarrollador especifique información de estilo. |
| GeoCoordinates |
GeoCoordinates (tipo de entidad: "https://schema.org/GeoCoordinates") |
| HeroCard |
Una tarjeta prominente (tarjeta con una sola imagen grande) |
| IStatusCodeError | |
| InnerHttpError |
Objeto que representa un error http interno |
| InvokeResponse |
Representa una respuesta devuelta por un bot cuando recibe una actividad de |
| MediaCard |
Tarjeta multimedia |
| MediaEventValue |
Parámetro complementario para eventos multimedia |
| MediaUrl |
Dirección URL de medios |
| Mention |
Información de mención (tipo de entidad: "mención") |
| MessageReaction |
Objeto de reacción de mensaje |
| MicrosoftPayMethodData |
Datos del método de pago W3C para Microsoft Pay |
| OAuthCard |
Tarjeta que representa una solicitud para realizar un inicio de sesión a través de OAuth |
| PagedMembersResult |
Página de miembros. |
| PaymentAddress |
Dirección dentro de una solicitud de pago |
| PaymentCurrencyAmount |
Suministros de importes monetarios |
| PaymentDetails |
Proporciona información sobre la transacción solicitada. |
| PaymentDetailsModifier |
Proporciona detalles que modifican PaymentDetails en función del identificador del método de pago. |
| PaymentItem |
Indica para qué es la solicitud de pago y el valor solicitado |
| PaymentMethodData |
Indica un conjunto de métodos de pago admitidos y cualquier dato específico del método de pago asociado para esos métodos. |
| PaymentOptions |
Proporciona información sobre las opciones deseadas para la solicitud de pago. |
| PaymentRequest |
Solicitud para realizar un pago |
| PaymentRequestComplete |
Carga entregada al completar una solicitud de pago |
| PaymentRequestCompleteResult |
Resultado de una solicitud de pago completada |
| PaymentRequestUpdate |
Una actualización de una solicitud de pago |
| PaymentRequestUpdateResult |
Objeto de resultado de una operación de invocación de actualización de solicitud de pago |
| PaymentResponse |
Se devuelve un paymentResponse cuando un usuario ha seleccionado un método de pago y ha aprobado una solicitud de pago. |
| PaymentShippingOption |
Describe una opción de envío |
| Place |
Place (tipo de entidad: "https://schema.org/Place") |
| ReceiptCard |
Una tarjeta de recibo |
| ReceiptItem |
Un elemento en una tarjeta de recibo |
| ResourceResponse |
Respuesta que contiene un identificador de recurso |
| SearchInvokeOptions |
Proporciona información sobre las opciones deseadas para una SearchInvokeValue |
| SearchInvokeResponse |
Define la estructura que se devuelve como resultado de una actividad Invoke con el nombre de "application/search". |
| SearchInvokeValue |
Define la estructura que llega a la actividad Activity.Value for Invoke con el nombre de "application/search". |
| SemanticAction |
Representa una referencia a una acción mediante programación. |
| SignInUrlResponse | |
| SigninCard |
Tarjeta que representa una solicitud para iniciar sesión |
| SuggestedActions |
SuggestedActions que se pueden realizar |
| TextHighlight |
Hace referencia a una subcadena de contenido dentro de otro campo |
| Thing |
Thing (tipo de entidad: "https://schema.org/Thing") |
| ThumbnailCard |
Una tarjeta en miniatura (tarjeta con una sola imagen en miniatura pequeña) |
| ThumbnailUrl |
Url de miniatura |
| TokenExchangeRequest | |
| TokenExchangeResource | |
| TokenRequest |
Solicitud para recibir un token de usuario |
| TokenResponse |
Respuesta que incluye un token de usuario |
| Transcript |
Transcripción |
| VideoCard |
Tarjeta 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 |
Solicitud para intercambiar un token. |
| TokenExchangeInvokeResponse |
Objeto de respuesta de una invocación de intercambio de tokens. |
Alias de tipos
| IHandoffActivity | |
| IMessageDeleteActivity | |
| ITypingActivity | |
| TokenExchangeState |
Objeto de estado pasado al servicio de token de bot. |
| TokenStatus |
Estado de un token determinado. |
| FileDownloadInfoAttachment | |
| O365ConnectorCardActionType |
Define valores para Type. Los valores posibles son: 'ViewAction', 'OpenUri', 'HttpPOST', 'ActionCard' |
| O365ConnectorCardInputType |
Define valores para O365ConnectorCardInputType. Los valores posibles son: 'textInput', 'dateInput', 'multichoiceInput' |
| Action |
Define los valores de Action. Entre los valores posibles se incluyen: 'accept', 'decline' |
| ActivityImageType |
Define valores para ActivityImageType. Entre los valores posibles se incluyen: 'avatar', 'article' |
| ApplicationIdentityType |
Define valores para ApplicationIdentityType. Los valores posibles son: "aadApplication", "bot", "tenantBot", "office365Connector", "webhook". |
| AttachmentLayout |
Define valores para AttachmentLayout. Entre los valores posibles se incluyen: 'list', 'grid' |
| BotMessagePreviewActionType |
Define valores para BotMessagePreviewActionType. Entre los valores posibles se incluyen: 'edit', 'send' |
| BotMessagePreviewType |
Define valores para BotMessagePreviewType. Entre los valores posibles se incluyen: 'message', 'continue' |
| CommandContext |
Define valores para CommandContext. Entre los valores posibles se incluyen: 'message', 'compose', 'commandbox' |
| ContentType |
Define valores para ContentType. Entre los valores posibles se incluyen: 'html', 'text' |
| ConversationIdentityType |
Define valores para ConversationIdentityType. Entre los valores posibles se incluyen: "team", "channel" |
| Importance |
Define los valores de Importance. Entre los valores posibles se incluyen: 'normal', 'high', 'urgent' |
| MessageType |
Define valores para MessageType. Entre los valores posibles se incluyen: 'message' |
| MessagingExtensionResultType |
Define valores para MessagingExtensionResultType. Los valores posibles son: 'result', 'auth', 'config', 'message', 'botMessagePreview', 'silentAuth'. |
| O365ConnectorCardInputBaseType |
Define valores para O365ConnectorCardInputBaseType. Los valores posibles son: 'textInput', 'dateInput', 'multichoiceInput' |
| Os |
Define valores para el sistema operativo. Entre los valores posibles se incluyen: 'default', 'iOS', 'android', 'windows' |
| ReactionType |
Define valores para ReactionType. Entre los valores posibles se incluyen: 'like', 'heart', 'laugh', 'surprised', 'sad', 'angry' |
| Style |
Define valores para Style. Entre los valores posibles se incluyen: 'compact', 'expandida' |
| Type |
Define valores para Type. Los valores posibles son: 'ViewAction', 'OpenUri', 'HttpPOST', 'ActionCard' |
| Type1 | |
| Type2 | |
| Type3 | |
| UserIdentityType |
Define valores para UserIdentityType. Los valores posibles son: "aadUser", "onPremiseAadUser", "anonymousGuest", "federatedUser". |
Enumeraciones
| ActionTypes |
Define valores para ActionTypes. Los valores posibles son: 'openUrl', 'imBack', 'postBack', 'playAudio', 'playVideo', 'showImage', 'downloadFile', 'signin', 'call', messageBack', 'openApp' |
| ActivityEventNames |
Define valores para ActivityEventNames. Entre los valores posibles se incluyen: 'continueConversation', 'createConversation' |
| ActivityImportance |
Define valores para ActivityImportance. Entre los valores posibles se incluyen: 'low', 'normal', 'high' |
| ActivityTypes |
Define valores para ActivityTypes. Los valores posibles son: 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff' |
| AttachmentLayoutTypes |
Define valores para AttachmentLayoutTypes. Entre los valores posibles se incluyen: 'list', 'carousel' |
| Channels |
Define valores para ChannelIds para Channels. Entre los valores posibles se incluyen: "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. Entre los valores posibles se incluyen: 'add', 'remove' |
| DeliveryModes |
Define valores para DeliveryModes. Los valores posibles son: 'normal', 'notification', 'expectReplies', 'efímero' |
| EndOfConversationCodes |
Define valores para EndOfConversationCodes. Los valores posibles son: 'unknown', 'completedSuccessfully', 'userCancelled', 'botTimedOut', 'botIssuedInvalidMessage', 'channelFailed' |
| InputHints |
Define valores para InputHints. Los valores posibles son: 'acceptingInput', 'ignoreingInput', 'expectingInput' |
| InstallationUpdateActionTypes |
Define valores para InstallationUpdateActionTypes. Entre los valores posibles se incluyen: 'add', 'remove' |
| MessageReactionTypes |
Define valores para MessageReactionTypes. Entre los valores posibles se incluyen: "like", "plusOne" |
| RoleTypes |
Define valores para RoleTypes. Entre los valores posibles se incluyen: "user", "bot", "skill" |
| SemanticActionStateTypes |
Define valores para SemanticActionStateTypes. Entre los valores posibles se incluyen: 'start', 'continue', 'done' |
| StatusCodes |
Define valores para StatusCodes. Los valores posibles incluyen: 200, 400, 401, 404, 405, 409, 426, 500, 501, 502 |
| TextFormatTypes |
Define valores para TextFormatTypes. Entre los valores posibles se incluyen: 'Markdown', 'plain', 'xml' |
Funciones
Detalles de la función
assertActivity(unknown, unknown[])
function assertActivity(val: unknown, _args: unknown[]): assertsParámetros
- val
-
unknown
- _args
-
unknown[]
Devoluciones
asserts
assertAttachment(unknown, unknown[])
function assertAttachment(val: unknown, _args: unknown[]): assertsParámetros
- val
-
unknown
- _args
-
unknown[]
Devoluciones
asserts
assertAttachmentInfo(unknown, unknown[])
function assertAttachmentInfo(val: unknown, _args: unknown[]): assertsParámetros
- val
-
unknown
- _args
-
unknown[]
Devoluciones
asserts
assertAttachmentView(unknown, unknown[])
function assertAttachmentView(val: unknown, _args: unknown[]): assertsParámetros
- val
-
unknown
- _args
-
unknown[]
Devoluciones
asserts
assertCardAction(unknown, unknown[])
function assertCardAction(val: unknown, _args: unknown[]): assertsParámetros
- val
-
unknown
- _args
-
unknown[]
Devoluciones
asserts
assertChannelAccount(unknown, unknown[])
function assertChannelAccount(val: unknown, _args: unknown[]): assertsParámetros
- val
-
unknown
- _args
-
unknown[]
Devoluciones
asserts
assertConversationAccount(unknown, unknown[])
function assertConversationAccount(val: unknown, _args: unknown[]): assertsParámetros
- val
-
unknown
- _args
-
unknown[]
Devoluciones
asserts
assertConversationReference(unknown, unknown[])
function assertConversationReference(val: unknown, _args: unknown[]): assertsParámetros
- val
-
unknown
- _args
-
unknown[]
Devoluciones
asserts
assertEntity(unknown, unknown[])
function assertEntity(val: unknown, _args: unknown[]): assertsParámetros
- val
-
unknown
- _args
-
unknown[]
Devoluciones
asserts
assertMessageReaction(unknown, unknown[])
function assertMessageReaction(val: unknown, _args: unknown[]): assertsParámetros
- val
-
unknown
- _args
-
unknown[]
Devoluciones
asserts
assertSemanticAction(unknown, unknown[])
function assertSemanticAction(val: unknown, _args: unknown[]): assertsParámetros
- val
-
unknown
- _args
-
unknown[]
Devoluciones
asserts
assertSuggestedActions(unknown, unknown[])
function assertSuggestedActions(val: unknown, _args: unknown[]): assertsParámetros
- val
-
unknown
- _args
-
unknown[]
Devoluciones
asserts
isActivity(unknown)
function isActivity(val: unknown): booleanParámetros
- val
-
unknown
Devoluciones
boolean
isAttachment(unknown)
function isAttachment(val: unknown): booleanParámetros
- val
-
unknown
Devoluciones
boolean
isAttachmentInfo(unknown)
function isAttachmentInfo(val: unknown): booleanParámetros
- val
-
unknown
Devoluciones
boolean
isAttachmentView(unknown)
function isAttachmentView(val: unknown): booleanParámetros
- val
-
unknown
Devoluciones
boolean
isCardAction(unknown)
function isCardAction(val: unknown): booleanParámetros
- val
-
unknown
Devoluciones
boolean
isChannelAccount(unknown)
function isChannelAccount(val: unknown): booleanParámetros
- val
-
unknown
Devoluciones
boolean
isConversationAccount(unknown)
function isConversationAccount(val: unknown): booleanParámetros
- val
-
unknown
Devoluciones
boolean
isConversationReference(unknown)
function isConversationReference(val: unknown): booleanParámetros
- val
-
unknown
Devoluciones
boolean
isEntity(unknown)
function isEntity(val: unknown): booleanParámetros
- val
-
unknown
Devoluciones
boolean
isMessageReaction(unknown)
function isMessageReaction(val: unknown): booleanParámetros
- val
-
unknown
Devoluciones
boolean
isSemanticAction(unknown)
function isSemanticAction(val: unknown): booleanParámetros
- val
-
unknown
Devoluciones
boolean
isSuggestedActions(unknown)
function isSuggestedActions(val: unknown): booleanParámetros
- val
-
unknown
Devoluciones
boolean