botframework-schema package
Classes
| CallerIdConstants |
Constantes utilisées pour remplir la propriété Activity.callerId. |
| SpeechConstants |
Définit des constantes qui peuvent être utilisées dans le traitement des interactions vocales. |
Interfaces
| CommandResultValue |
Le champ valeur d’un ICommandResultActivity contient des métadonnées liées à un résultat de commande. Une charge utile de données extensible facultative peut être incluse si elle est définie par le nom de l’activité de commande. La présence d’un champ d’erreur indique que la commande d’origine n’a pas pu se terminer. |
| CommandValue |
Le champ valeur d’un ICommandActivity contient des métadonnées liées à une commande. Une charge utile de données extensible facultative peut être incluse si elle est définie par le nom de l’activité de commande. |
| IActivity | |
| ICommandActivity |
Commande externe asynchrone. |
| ICommandResultActivity |
Résultat de la commande externe asynchrone. |
| IContactRelationUpdateActivity | |
| IConversationUpdateActivity | |
| IEndOfConversationActivity | |
| IEventActivity | |
| IInstallationUpdateActivity | |
| IInvokeActivity | |
| IMessageActivity | |
| IMessageReactionActivity | |
| IMessageUpdateActivity | |
| ISuggestionActivity | |
| ITraceActivity | |
| Activity |
Une activité est le type de communication de base pour le protocole Bot Framework 3.0. |
| ActivityTimestamps |
Cette interface est utilisée pour conserver les valeurs de chaîne d’origine des dates sur Les activités. Lorsqu’une activité est reçue, les horodatages sont convertis en dates. En raison de la façon dont les objets Date Javascript sont UTC, les valeurs de décalage de fuseau horaire sont perdues. |
| AdaptiveCardAuthentication |
Définit la structure qui arrive dans l’activité Activity.Value.Authentication for Invoke avec le nom « adaptiveCard/action ». |
| AdaptiveCardInvokeAction |
Définit la structure qui arrive dans l’activité Activity.Value.Action pour Invoke avec le nom « adaptiveCard/action ». |
| AdaptiveCardInvokeResponse |
Définit la structure retournée comme résultat d’une activité Invoke avec le nom « adaptiveCard/action ». |
| AdaptiveCardInvokeValue |
Définit la structure qui arrive dans l’activité Activity.Value pour Invoke avec le nom « adaptiveCard/action ». |
| AnimationCard |
Une carte d’animation (par exemple, gif ou court clip vidéo) |
| Attachment |
Pièce jointe au sein d’une activité |
| AttachmentData |
Données de pièce jointe |
| AttachmentInfo |
Métadonnées d’une pièce jointe |
| AttachmentView |
Nom et taille de la vue pièce jointe |
| AudioCard |
Carte audio |
| BasicCard |
Une carte de base |
| CardAction |
Action cliquable |
| CardImage |
Image sur une carte |
| ChannelAccount |
Informations de compte de canal nécessaires pour acheminer un message |
| ConversationAccount |
Informations de compte de canal pour une conversation |
| ConversationMembers |
Conversation et ses membres |
| ConversationParameters |
Paramètres pour la création d’une conversation |
| ConversationReference |
Objet relatif à un point particulier d’une conversation |
| ConversationResourceResponse |
Réponse contenant une ressource |
| ConversationsResult |
Résultat des conversations |
| Entity |
Objet de métadonnées relatif à une activité |
| ErrorModel |
Objet représentant des informations d’erreur |
| ErrorResponse |
Réponse de l’API HTTP |
| ExpectedReplies |
Réponses attendues en réponse à DeliveryModes.ExpectReplies |
| Fact |
Ensemble de paires clé-valeur. L’avantage de cette section est que les propriétés de clé et de valeur sont affichées avec des informations de style par défaut avec un délimiteur entre elles. Il n’est donc pas nécessaire pour le développeur de spécifier des informations de style. |
| GeoCoordinates |
GeoCoordinates (type d’entité : «https://schema.org/GeoCoordinates" ;) |
| HeroCard |
Une carte Hero (carte avec une seule image volumineuse) |
| IStatusCodeError | |
| InnerHttpError |
Objet représentant une erreur HTTP interne |
| InvokeResponse |
Représente une réponse retournée par un bot lorsqu’il reçoit une |
| MediaCard |
Carte multimédia |
| MediaEventValue |
Paramètre supplémentaire pour les événements multimédias |
| MediaUrl |
URL du média |
| Mention |
Informations de mention (type d’entité : « mention ») |
| MessageReaction |
Objet de réaction de message |
| MicrosoftPayMethodData |
Données de mode de paiement W3C pour Microsoft Pay |
| OAuthCard |
Carte représentant une demande de connexion via OAuth |
| PagedMembersResult |
Page des membres. |
| PaymentAddress |
Adresse dans une demande de paiement |
| PaymentCurrencyAmount |
Fournit des montants monétaires |
| PaymentDetails |
Fournit des informations sur la transaction demandée |
| PaymentDetailsModifier |
Fournit des détails qui modifient l’identificateur PaymentDetails en fonction de l’identificateur du mode de paiement |
| PaymentItem |
Indique à quoi correspond la demande de paiement et la valeur demandée |
| PaymentMethodData |
Indique un ensemble de modes de paiement pris en charge et toutes les données spécifiques aux méthodes de paiement associées pour ces méthodes |
| PaymentOptions |
Fournit des informations sur les options souhaitées pour la demande de paiement |
| PaymentRequest |
Demande d’effectuer un paiement |
| PaymentRequestComplete |
Charge utile fournie lors de l’exécution d’une demande de paiement |
| PaymentRequestCompleteResult |
Résultat d’une demande de paiement terminée |
| PaymentRequestUpdate |
Mise à jour d’une demande de paiement |
| PaymentRequestUpdateResult |
Objet résultat d’une opération d’appel de mise à jour de demande de paiement |
| PaymentResponse |
Un PaymentResponse est retourné lorsqu’un utilisateur a sélectionné un mode de paiement et approuvé une demande de paiement |
| PaymentShippingOption |
Décrit une option d’expédition |
| Place |
Place (type d’entité : «https://schema.org/Place" ;) |
| ReceiptCard |
Carte de reçu |
| ReceiptItem |
Élément sur une carte de reçu |
| ResourceResponse |
Réponse contenant un ID de ressource |
| SearchInvokeOptions |
Fournit des informations sur les options souhaitées pour un SearchInvokeValue |
| SearchInvokeResponse |
Définit la structure retournée comme résultat d’une activité Invoke avec le nom « application/search ». |
| SearchInvokeValue |
Définit la structure qui arrive dans l’activité Activity.Value pour Invoke avec le nom « application/search ». |
| SemanticAction |
Représente une référence à une action par programmation |
| SignInUrlResponse | |
| SigninCard |
Carte représentant une demande de connexion |
| SuggestedActions |
SuggestedActions qui peuvent être effectuées |
| TextHighlight |
Fait référence à une sous-chaîne de contenu dans un autre champ |
| Thing |
Thing (type d’entité : «https://schema.org/Thing" ;) |
| ThumbnailCard |
Carte miniature (carte avec une image miniature unique et petite) |
| ThumbnailUrl |
URL de miniature |
| TokenExchangeRequest | |
| TokenExchangeResource | |
| TokenRequest |
Demande de réception d’un jeton utilisateur |
| TokenResponse |
Réponse qui inclut un jeton utilisateur |
| Transcript |
Transcription |
| VideoCard |
Carte vidéo |
| 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 |
Demande d’échange d’un jeton. |
| TokenExchangeInvokeResponse |
Objet de réponse d’un appel d’échange de jetons. |
Alias de type
| IHandoffActivity | |
| IMessageDeleteActivity | |
| ITypingActivity | |
| TokenExchangeState |
Objet d’état passé au service de jeton de bot. |
| TokenStatus |
État d’un jeton particulier. |
| FileDownloadInfoAttachment | |
| O365ConnectorCardActionType |
Définit des valeurs pour Type. Les valeurs possibles sont les suivantes : « ViewAction », « OpenUri », « HttpPOST », « ActionCard » |
| O365ConnectorCardInputType |
Définit des valeurs pour O365ConnectorCardInputType. Les valeurs possibles sont les suivantes : 'textInput', 'dateInput', 'multichoiceInput' |
| Action |
Définit des valeurs pour Action. Les valeurs possibles sont les suivantes : « accept », « decline » |
| ActivityImageType |
Définit des valeurs pour ActivityImageType. Les valeurs possibles sont les suivantes : « avatar », « article » |
| ApplicationIdentityType |
Définit des valeurs pour ApplicationIdentityType. Les valeurs possibles sont les suivantes : « aadApplication », « bot », « tenantBot », « office365Connector », « webhook » |
| AttachmentLayout |
Définit les valeurs de AttachmentLayout. Les valeurs possibles sont les suivantes : 'list', 'grid' |
| BotMessagePreviewActionType |
Définit des valeurs pour BotMessagePreviewActionType. Les valeurs possibles sont les suivantes : 'edit', 'send' |
| BotMessagePreviewType |
Définit des valeurs pour BotMessagePreviewType. Les valeurs possibles sont les suivantes : 'message', 'continue' |
| CommandContext |
Définit les valeurs de CommandContext. Les valeurs possibles sont les suivantes : 'message', 'compose', 'commandbox' |
| ContentType |
Définit des valeurs pour ContentType. Les valeurs possibles sont les suivantes : 'html', 'text' |
| ConversationIdentityType |
Définit les valeurs de ConversationIdentityType. Les valeurs possibles sont les suivantes : « team », « channel » |
| Importance |
Définit des valeurs pour Importance. Les valeurs possibles sont les suivantes : « normal », « high », « urgent » |
| MessageType |
Définit les valeurs de MessageType. Les valeurs possibles sont les suivantes : 'message' |
| MessagingExtensionResultType |
Définit des valeurs pour MessagingExtensionResultType. Les valeurs possibles sont les suivantes : « result », « auth », « config », « message », « botMessagePreview », « silentAuth ». |
| O365ConnectorCardInputBaseType |
Définit des valeurs pour O365ConnectorCardInputBaseType. Les valeurs possibles sont les suivantes : 'textInput', 'dateInput', 'multichoiceInput' |
| Os |
Définit des valeurs pour le système d’exploitation. Les valeurs possibles sont les suivantes : 'default', 'iOS', 'android', 'windows' |
| ReactionType |
Définit des valeurs pour ReactionType. Les valeurs possibles sont les suivantes : « like », « heart », « laugh », « surprise », « sad », « angry » |
| Style |
Définit des valeurs pour Style. Les valeurs possibles sont les suivantes : 'compact', 'expanded' |
| Type |
Définit des valeurs pour Type. Les valeurs possibles sont les suivantes : 'ViewAction', 'OpenUri', 'HttpPOST', 'ActionCard' |
| Type1 | |
| Type2 | |
| Type3 | |
| UserIdentityType |
Définit des valeurs pour UserIdentityType. Les valeurs possibles sont les suivantes : 'aadUser', 'onPremiseAadUser', 'anonymousGuest', 'federatedUser' |
Énumérations
| ActionTypes |
Définit des valeurs pour ActionTypes. Les valeurs possibles sont les suivantes : 'openUrl', 'imBack', 'postBack', 'playAudio', 'playVideo', 'showImage', 'downloadFile', 'signin', 'call', messageBack', 'openApp' |
| ActivityEventNames |
Définit des valeurs pour ActivityEventNames. Les valeurs possibles sont les suivantes : « continueConversation », « createConversation » |
| ActivityImportance |
Définit des valeurs pour ActivityImportance. Les valeurs possibles sont les suivantes : 'low', 'normal', 'high' |
| ActivityTypes |
Définit des valeurs pour ActivityTypes. Les valeurs possibles sont les suivantes : « message », « contactRelationUpdate », « conversationUpdate », « typing », « endOfConversation », « event », « invoke », « deleteUserData », « messageUpdate », « messageDelete », « installationUpdate », « messageReaction », « suggestion », « trace », « handoff » |
| AttachmentLayoutTypes |
Définit les valeurs de AttachmentLayoutTypes. Les valeurs possibles sont les suivantes : 'list', 'carrouel' |
| Channels |
Définit des valeurs pour ChannelIds pour Channels. Les valeurs possibles sont les suivantes : « alexa », 'console', 'cortana', 'directline', 'directlinespeech', 'email', 'emulator', 'facebook', 'groupme', 'kik', 'line', 'msteams', 'onmichannel', 'outlook', 'skype', 'skype', 'skypeforbusiness', 'slack', 'sms', 'telegram', 'test', 'twilio-sms', 'webchat' |
| ContactRelationUpdateActionTypes |
Définit des valeurs pour ContactRelationUpdateActionTypes. Les valeurs possibles sont les suivantes : 'add', 'remove' |
| DeliveryModes |
Définit des valeurs pour DeliveryModes. Les valeurs possibles sont les suivantes : 'normal', 'notification', 'expectReplies', 'éphémère' |
| EndOfConversationCodes |
Définit des valeurs pour EndOfConversationCodes. Les valeurs possibles sont les suivantes : « unknown », « completedSuccessfully », « userCancelled », « botTimedOut », « botIssuedInvalidMessage », « channelFailed » |
| InputHints |
Définit des valeurs pour InputHints. Les valeurs possibles sont les suivantes : « acceptInput », « ignoringInput », « expectingInput » |
| InstallationUpdateActionTypes |
Définit des valeurs pour InstallationUpdateActionTypes. Les valeurs possibles sont les suivantes : 'add', 'remove' |
| MessageReactionTypes |
Définit des valeurs pour MessageReactionTypes. Les valeurs possibles sont les suivantes : « like », « plusOne » |
| RoleTypes |
Définit des valeurs pour les RoleTypes. Les valeurs possibles sont les suivantes : 'user', 'bot', 'skill' |
| SemanticActionStateTypes |
Définit des valeurs pour SemanticActionStateTypes. Les valeurs possibles sont les suivantes : 'start', 'continue', 'done' |
| StatusCodes |
Définit des valeurs pour StatusCodes. Les valeurs possibles incluent : 200, 400, 401, 404, 405, 409, 426, 500, 501, 502 |
| TextFormatTypes |
Définit des valeurs pour TextFormatTypes. Les valeurs possibles sont les suivantes : 'markdown', 'plain', 'xml' |
Fonctions
Informations relatives à la fonction
assertActivity(unknown, unknown[])
function assertActivity(val: unknown, _args: unknown[]): assertsParamètres
- val
-
unknown
- _args
-
unknown[]
Retours
asserts
assertAttachment(unknown, unknown[])
function assertAttachment(val: unknown, _args: unknown[]): assertsParamètres
- val
-
unknown
- _args
-
unknown[]
Retours
asserts
assertAttachmentInfo(unknown, unknown[])
function assertAttachmentInfo(val: unknown, _args: unknown[]): assertsParamètres
- val
-
unknown
- _args
-
unknown[]
Retours
asserts
assertAttachmentView(unknown, unknown[])
function assertAttachmentView(val: unknown, _args: unknown[]): assertsParamètres
- val
-
unknown
- _args
-
unknown[]
Retours
asserts
assertCardAction(unknown, unknown[])
function assertCardAction(val: unknown, _args: unknown[]): assertsParamètres
- val
-
unknown
- _args
-
unknown[]
Retours
asserts
assertChannelAccount(unknown, unknown[])
function assertChannelAccount(val: unknown, _args: unknown[]): assertsParamètres
- val
-
unknown
- _args
-
unknown[]
Retours
asserts
assertConversationAccount(unknown, unknown[])
function assertConversationAccount(val: unknown, _args: unknown[]): assertsParamètres
- val
-
unknown
- _args
-
unknown[]
Retours
asserts
assertConversationReference(unknown, unknown[])
function assertConversationReference(val: unknown, _args: unknown[]): assertsParamètres
- val
-
unknown
- _args
-
unknown[]
Retours
asserts
assertEntity(unknown, unknown[])
function assertEntity(val: unknown, _args: unknown[]): assertsParamètres
- val
-
unknown
- _args
-
unknown[]
Retours
asserts
assertMessageReaction(unknown, unknown[])
function assertMessageReaction(val: unknown, _args: unknown[]): assertsParamètres
- val
-
unknown
- _args
-
unknown[]
Retours
asserts
assertSemanticAction(unknown, unknown[])
function assertSemanticAction(val: unknown, _args: unknown[]): assertsParamètres
- val
-
unknown
- _args
-
unknown[]
Retours
asserts
assertSuggestedActions(unknown, unknown[])
function assertSuggestedActions(val: unknown, _args: unknown[]): assertsParamètres
- val
-
unknown
- _args
-
unknown[]
Retours
asserts
isActivity(unknown)
function isActivity(val: unknown): booleanParamètres
- val
-
unknown
Retours
boolean
isAttachment(unknown)
function isAttachment(val: unknown): booleanParamètres
- val
-
unknown
Retours
boolean
isAttachmentInfo(unknown)
function isAttachmentInfo(val: unknown): booleanParamètres
- val
-
unknown
Retours
boolean
isAttachmentView(unknown)
function isAttachmentView(val: unknown): booleanParamètres
- val
-
unknown
Retours
boolean
isCardAction(unknown)
function isCardAction(val: unknown): booleanParamètres
- val
-
unknown
Retours
boolean
isChannelAccount(unknown)
function isChannelAccount(val: unknown): booleanParamètres
- val
-
unknown
Retours
boolean
isConversationAccount(unknown)
function isConversationAccount(val: unknown): booleanParamètres
- val
-
unknown
Retours
boolean
isConversationReference(unknown)
function isConversationReference(val: unknown): booleanParamètres
- val
-
unknown
Retours
boolean
isEntity(unknown)
function isEntity(val: unknown): booleanParamètres
- val
-
unknown
Retours
boolean
isMessageReaction(unknown)
function isMessageReaction(val: unknown): booleanParamètres
- val
-
unknown
Retours
boolean
isSemanticAction(unknown)
function isSemanticAction(val: unknown): booleanParamètres
- val
-
unknown
Retours
boolean
isSuggestedActions(unknown)
function isSuggestedActions(val: unknown): booleanParamètres
- val
-
unknown
Retours
boolean