botframework-schema package
Classes
| CallerIdConstants |
Constants used to populate the Activity.callerId property. |
| SpeechConstants |
Defines constants that can be used in the processing of speech interactions. |
Interfaces
| CommandResultValue |
The value field of a ICommandResultActivity contains metadata related to a command result. An optional extensible data payload may be included if defined by the command activity name. The presence of an error field indicates that the original command failed to complete. |
| CommandValue |
The value field of a ICommandActivity contains metadata related to a command. An optional extensible data payload may be included if defined by the command activity name. |
| IActivity | |
| ICommandActivity |
Asynchronous external command. |
| ICommandResultActivity |
Asynchronous external command result. |
| IContactRelationUpdateActivity | |
| IConversationUpdateActivity | |
| IEndOfConversationActivity | |
| IEventActivity | |
| IInstallationUpdateActivity | |
| IInvokeActivity | |
| IMessageActivity | |
| IMessageReactionActivity | |
| IMessageUpdateActivity | |
| ISuggestionActivity | |
| ITraceActivity | |
| Activity |
An Activity is the basic communication type for the Bot Framework 3.0 protocol. |
| ActivityTimestamps |
This interface is used to preserve the original string values of dates on Activities. When an Activity is received, timestamps are converted to Dates. Due to how Javascript Date objects are UTC, timezone offset values are lost. |
| AdaptiveCardAuthentication |
Defines the structure that arrives in the Activity.Value.Authentication for Invoke activity with Name of 'adaptiveCard/action'. |
| AdaptiveCardInvokeAction |
Defines the structure that arrives in the Activity.Value.Action for Invoke activity with Name of 'adaptiveCard/action'. |
| AdaptiveCardInvokeResponse |
Defines the structure that is returned as the result of an Invoke activity with Name of 'adaptiveCard/action'. |
| AdaptiveCardInvokeValue |
Defines the structure that arrives in the Activity.Value for Invoke activity with Name of 'adaptiveCard/action'. |
| AnimationCard |
An animation card (Ex: gif or short video clip) |
| Attachment |
An attachment within an activity |
| AttachmentData |
Attachment data |
| AttachmentInfo |
Metadata for an attachment |
| AttachmentView |
Attachment View name and size |
| AudioCard |
Audio card |
| BasicCard |
A basic card |
| CardAction |
A clickable action |
| CardImage |
An image on a card |
| ChannelAccount |
Channel account information needed to route a message |
| ConversationAccount |
Channel account information for a conversation |
| ConversationMembers |
Conversation and its members |
| ConversationParameters |
Parameters for creating a new conversation |
| ConversationReference |
An object relating to a particular point in a conversation |
| ConversationResourceResponse |
A response containing a resource |
| ConversationsResult |
Conversations result |
| Entity |
Metadata object pertaining to an activity |
| ErrorModel |
Object representing error information |
| ErrorResponse |
An HTTP API response |
| ExpectedReplies |
Expected Replies in response to DeliveryModes.ExpectReplies |
| Fact |
Set of key-value pairs. Advantage of this section is that key and value properties will be rendered with default style information with some delimiter between them. So there is no need for developer to specify style information. |
| GeoCoordinates |
GeoCoordinates (entity type: "https://schema.org/GeoCoordinates") |
| HeroCard |
A Hero card (card with a single, large image) |
| IStatusCodeError | |
| InnerHttpError |
Object representing inner http error |
| InvokeResponse |
Represents a response returned by a bot when it receives an |
| MediaCard |
Media card |
| MediaEventValue |
Supplementary parameter for media events |
| MediaUrl |
Media URL |
| Mention |
Mention information (entity type: "mention") |
| MessageReaction |
Message reaction object |
| MicrosoftPayMethodData |
W3C Payment Method Data for Microsoft Pay |
| OAuthCard |
A card representing a request to perform a sign in via OAuth |
| PagedMembersResult |
Page of members. |
| PaymentAddress |
Address within a Payment Request |
| PaymentCurrencyAmount |
Supplies monetary amounts |
| PaymentDetails |
Provides information about the requested transaction |
| PaymentDetailsModifier |
Provides details that modify the PaymentDetails based on payment method identifier |
| PaymentItem |
Indicates what the payment request is for and the value asked for |
| PaymentMethodData |
Indicates a set of supported payment methods and any associated payment method specific data for those methods |
| PaymentOptions |
Provides information about the options desired for the payment request |
| PaymentRequest |
A request to make a payment |
| PaymentRequestComplete |
Payload delivered when completing a payment request |
| PaymentRequestCompleteResult |
Result from a completed payment request |
| PaymentRequestUpdate |
An update to a payment request |
| PaymentRequestUpdateResult |
A result object from a Payment Request Update invoke operation |
| PaymentResponse |
A PaymentResponse is returned when a user has selected a payment method and approved a payment request |
| PaymentShippingOption |
Describes a shipping option |
| Place |
Place (entity type: "https://schema.org/Place") |
| ReceiptCard |
A receipt card |
| ReceiptItem |
An item on a receipt card |
| ResourceResponse |
A response containing a resource ID |
| SearchInvokeOptions |
Provides information about the options desired for a SearchInvokeValue |
| SearchInvokeResponse |
Defines the structure that is returned as the result of an Invoke activity with Name of 'application/search'. |
| SearchInvokeValue |
Defines the structure that arrives in the Activity.Value for Invoke activity with Name of 'application/search'. |
| SemanticAction |
Represents a reference to a programmatic action |
| SignInUrlResponse | |
| SigninCard |
A card representing a request to sign in |
| SuggestedActions |
SuggestedActions that can be performed |
| TextHighlight |
Refers to a substring of content within another field |
| Thing |
Thing (entity type: "https://schema.org/Thing") |
| ThumbnailCard |
A thumbnail card (card with a single, small thumbnail image) |
| ThumbnailUrl |
Thumbnail URL |
| TokenExchangeRequest | |
| TokenExchangeResource | |
| TokenRequest |
A request to receive a user token |
| TokenResponse |
A response that includes a user token |
| Transcript |
Transcript |
| VideoCard |
Video card |
| 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 |
A request to exchange a token. |
| TokenExchangeInvokeResponse |
The response object of a token exchange invoke. |
Type Aliases
| IHandoffActivity | |
| IMessageDeleteActivity | |
| ITypingActivity | |
| TokenExchangeState |
State object passed to the bot token service. |
| TokenStatus |
The status of a particular token. |
| FileDownloadInfoAttachment | |
| O365ConnectorCardActionType |
Defines values for Type. Possible values include: 'ViewAction', 'OpenUri', 'HttpPOST', 'ActionCard' |
| O365ConnectorCardInputType |
Defines values for O365ConnectorCardInputType. Possible values include: 'textInput', 'dateInput', 'multichoiceInput' |
| Action |
Defines values for Action. Possible values include: 'accept', 'decline' |
| ActivityImageType |
Defines values for ActivityImageType. Possible values include: 'avatar', 'article' |
| ApplicationIdentityType |
Defines values for ApplicationIdentityType. Possible values include: 'aadApplication', 'bot', 'tenantBot', 'office365Connector', 'webhook' |
| AttachmentLayout |
Defines values for AttachmentLayout. Possible values include: 'list', 'grid' |
| BotMessagePreviewActionType |
Defines values for BotMessagePreviewActionType. Possible values include: 'edit', 'send' |
| BotMessagePreviewType |
Defines values for BotMessagePreviewType. Possible values include: 'message', 'continue' |
| CommandContext |
Defines values for CommandContext. Possible values include: 'message', 'compose', 'commandbox' |
| ContentType |
Defines values for ContentType. Possible values include: 'html', 'text' |
| ConversationIdentityType |
Defines values for ConversationIdentityType. Possible values include: 'team', 'channel' |
| Importance |
Defines values for Importance. Possible values include: 'normal', 'high', 'urgent' |
| MessageType |
Defines values for MessageType. Possible values include: 'message' |
| MessagingExtensionResultType |
Defines values for MessagingExtensionResultType. Possible values include: 'result', 'auth', 'config', 'message', 'botMessagePreview', 'silentAuth'. |
| O365ConnectorCardInputBaseType |
Defines values for O365ConnectorCardInputBaseType. Possible values include: 'textInput', 'dateInput', 'multichoiceInput' |
| Os |
Defines values for Os. Possible values include: 'default', 'iOS', 'android', 'windows' |
| ReactionType |
Defines values for ReactionType. Possible values include: 'like', 'heart', 'laugh', 'surprised', 'sad', 'angry' |
| Style |
Defines values for Style. Possible values include: 'compact', 'expanded' |
| Type |
Defines values for Type. Possible values include: 'ViewAction', 'OpenUri', 'HttpPOST', 'ActionCard' |
| Type1 | |
| Type2 | |
| Type3 | |
| UserIdentityType |
Defines values for UserIdentityType. Possible values include: 'aadUser', 'onPremiseAadUser', 'anonymousGuest', 'federatedUser' |
Enums
| ActionTypes |
Defines values for ActionTypes. Possible values include: 'openUrl', 'imBack', 'postBack', 'playAudio', 'playVideo', 'showImage', 'downloadFile', 'signin', 'call', messageBack', 'openApp' |
| ActivityEventNames |
Defines values for ActivityEventNames. Possible values include: 'continueConversation', 'createConversation' |
| ActivityImportance |
Defines values for ActivityImportance. Possible values include: 'low', 'normal', 'high' |
| ActivityTypes |
Defines values for ActivityTypes. Possible values include: 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff' |
| AttachmentLayoutTypes |
Defines values for AttachmentLayoutTypes. Possible values include: 'list', 'carousel' |
| Channels |
Defines values for ChannelIds for Channels. Possible values include: 'alexa', 'console', 'cortana', 'directline', 'directlinespeech', 'email', 'emulator', 'facebook', 'groupme', 'kik', 'line', 'msteams', 'onmichannel', 'outlook', 'skype', 'skypeforbusiness', 'slack', 'sms', 'telegram', 'test', 'twilio-sms', 'webchat' |
| ContactRelationUpdateActionTypes |
Defines values for ContactRelationUpdateActionTypes. Possible values include: 'add', 'remove' |
| DeliveryModes |
Defines values for DeliveryModes. Possible values include: 'normal', 'notification', 'expectReplies', 'ephemeral' |
| EndOfConversationCodes |
Defines values for EndOfConversationCodes. Possible values include: 'unknown', 'completedSuccessfully', 'userCancelled', 'botTimedOut', 'botIssuedInvalidMessage', 'channelFailed' |
| InputHints |
Defines values for InputHints. Possible values include: 'acceptingInput', 'ignoringInput', 'expectingInput' |
| InstallationUpdateActionTypes |
Defines values for InstallationUpdateActionTypes. Possible values include: 'add', 'remove' |
| MessageReactionTypes |
Defines values for MessageReactionTypes. Possible values include: 'like', 'plusOne' |
| RoleTypes |
Defines values for RoleTypes. Possible values include: 'user', 'bot', 'skill' |
| SemanticActionStateTypes |
Defines values for SemanticActionStateTypes. Possible values include: 'start', 'continue', 'done' |
| StatusCodes |
Defines values for StatusCodes. Possible values include: 200, 400, 401, 404, 405, 409, 426, 500, 501, 502 |
| TextFormatTypes |
Defines values for TextFormatTypes. Possible values include: 'markdown', 'plain', 'xml' |
Functions
Function Details
assertActivity(unknown, unknown[])
function assertActivity(val: unknown, _args: unknown[]): assertsParameters
- val
-
unknown
- _args
-
unknown[]
Returns
asserts
assertAttachment(unknown, unknown[])
function assertAttachment(val: unknown, _args: unknown[]): assertsParameters
- val
-
unknown
- _args
-
unknown[]
Returns
asserts
assertAttachmentInfo(unknown, unknown[])
function assertAttachmentInfo(val: unknown, _args: unknown[]): assertsParameters
- val
-
unknown
- _args
-
unknown[]
Returns
asserts
assertAttachmentView(unknown, unknown[])
function assertAttachmentView(val: unknown, _args: unknown[]): assertsParameters
- val
-
unknown
- _args
-
unknown[]
Returns
asserts
assertCardAction(unknown, unknown[])
function assertCardAction(val: unknown, _args: unknown[]): assertsParameters
- val
-
unknown
- _args
-
unknown[]
Returns
asserts
assertChannelAccount(unknown, unknown[])
function assertChannelAccount(val: unknown, _args: unknown[]): assertsParameters
- val
-
unknown
- _args
-
unknown[]
Returns
asserts
assertConversationAccount(unknown, unknown[])
function assertConversationAccount(val: unknown, _args: unknown[]): assertsParameters
- val
-
unknown
- _args
-
unknown[]
Returns
asserts
assertConversationReference(unknown, unknown[])
function assertConversationReference(val: unknown, _args: unknown[]): assertsParameters
- val
-
unknown
- _args
-
unknown[]
Returns
asserts
assertEntity(unknown, unknown[])
function assertEntity(val: unknown, _args: unknown[]): assertsParameters
- val
-
unknown
- _args
-
unknown[]
Returns
asserts
assertMessageReaction(unknown, unknown[])
function assertMessageReaction(val: unknown, _args: unknown[]): assertsParameters
- val
-
unknown
- _args
-
unknown[]
Returns
asserts
assertSemanticAction(unknown, unknown[])
function assertSemanticAction(val: unknown, _args: unknown[]): assertsParameters
- val
-
unknown
- _args
-
unknown[]
Returns
asserts
assertSuggestedActions(unknown, unknown[])
function assertSuggestedActions(val: unknown, _args: unknown[]): assertsParameters
- val
-
unknown
- _args
-
unknown[]
Returns
asserts
isActivity(unknown)
function isActivity(val: unknown): booleanParameters
- val
-
unknown
Returns
boolean
isAttachment(unknown)
function isAttachment(val: unknown): booleanParameters
- val
-
unknown
Returns
boolean
isAttachmentInfo(unknown)
function isAttachmentInfo(val: unknown): booleanParameters
- val
-
unknown
Returns
boolean
isAttachmentView(unknown)
function isAttachmentView(val: unknown): booleanParameters
- val
-
unknown
Returns
boolean
isCardAction(unknown)
function isCardAction(val: unknown): booleanParameters
- val
-
unknown
Returns
boolean
isChannelAccount(unknown)
function isChannelAccount(val: unknown): booleanParameters
- val
-
unknown
Returns
boolean
isConversationAccount(unknown)
function isConversationAccount(val: unknown): booleanParameters
- val
-
unknown
Returns
boolean
isConversationReference(unknown)
function isConversationReference(val: unknown): booleanParameters
- val
-
unknown
Returns
boolean
isEntity(unknown)
function isEntity(val: unknown): booleanParameters
- val
-
unknown
Returns
boolean
isMessageReaction(unknown)
function isMessageReaction(val: unknown): booleanParameters
- val
-
unknown
Returns
boolean
isSemanticAction(unknown)
function isSemanticAction(val: unknown): booleanParameters
- val
-
unknown
Returns
boolean
isSuggestedActions(unknown)
function isSuggestedActions(val: unknown): booleanParameters
- val
-
unknown
Returns
boolean