botframework-schema package

Classi

CallerIdConstants

Costanti utilizzate per popolare la proprietà Activity.callerId.

SpeechConstants

Definisce le costanti che possono essere usate nell'elaborazione delle interazioni vocali.

Interfacce

CommandResultValue

Il campo valore di un oggetto ICommandResultActivity contiene metadati correlati a un risultato del comando. Un payload di dati estendibile facoltativo può essere incluso se definito dal nome dell'attività del comando. La presenza di un campo di errore indica che il comando originale non è stato completato.

CommandValue

Il campo valore di un oggetto ICommandActivity contiene metadati correlati a un comando. Un payload di dati estendibile facoltativo può essere incluso se definito dal nome dell'attività del comando.

IActivity
ICommandActivity

Comando esterno asincrono.

ICommandResultActivity

Risultato del comando esterno asincrono.

IContactRelationUpdateActivity
IConversationUpdateActivity
IEndOfConversationActivity
IEventActivity
IInstallationUpdateActivity
IInvokeActivity
IMessageActivity
IMessageReactionActivity
IMessageUpdateActivity
ISuggestionActivity
ITraceActivity
Activity

Un'attività è il tipo di comunicazione di base per il protocollo Bot Framework 3.0.

ActivityTimestamps

Questa interfaccia viene usata per mantenere i valori stringa originali delle date nelle attività. Quando viene ricevuta un'attività, i timestamp vengono convertiti in Date. A causa del modo in cui gli oggetti Date Javascript sono UTC, i valori di offset del fuso orario vengono persi.

AdaptiveCardAuthentication

Definisce la struttura che arriva nell'attività Activity.Value.Authentication per Invoke con nome 'adaptiveCard/action'.

AdaptiveCardInvokeAction

Definisce la struttura che arriva nell'attività Activity.Value.Action per Invoke con nome 'adaptiveCard/action'.

AdaptiveCardInvokeResponse

Definisce la struttura restituita come risultato di un'attività Invoke con nome 'adaptiveCard/action'.

AdaptiveCardInvokeValue

Definisce la struttura che arriva nell'attività Activity.Value per Invoke con nome 'adaptiveCard/action'.

AnimationCard

Scheda di animazione (ad esempio gif o clip video breve)

Attachment

Allegato all'interno di un'attività

AttachmentData

Dati allegati

AttachmentInfo

Metadati per un allegato

AttachmentView

Nome e dimensioni della visualizzazione allegati

AudioCard

Scheda audio

BasicCard

Scheda di base

CardAction

Azione selezionabile

CardImage

Immagine su una scheda

ChannelAccount

Informazioni sull'account del canale necessarie per instradare un messaggio

ConversationAccount

Informazioni sull'account del canale per una conversazione

ConversationMembers

Conversazione e i relativi membri

ConversationParameters

Parametri per la creazione di una nuova conversazione

ConversationReference

Oggetto relativo a un punto specifico in una conversazione

ConversationResourceResponse

Risposta contenente una risorsa

ConversationsResult

Risultato conversazioni

Entity

Oggetto metadati relativo a un'attività

ErrorModel

Oggetto che rappresenta le informazioni sull'errore

ErrorResponse

Risposta all'API HTTP

ExpectedReplies

Risposte previste in risposta a DeliveryModes.ExpectReplies

Fact

Set di coppie chiave-valore. Il vantaggio di questa sezione è che il rendering delle proprietà chiave e valore verrà eseguito con informazioni sullo stile predefinite con alcuni delimitatori tra di essi. Non è quindi necessario che lo sviluppatore specifichi le informazioni sullo stile.

GeoCoordinates

GeoCoordinates (tipo di entità: "https://schema.org/GeoCoordinates")

HeroCard

Scheda Hero (scheda con un'unica immagine grande)

IStatusCodeError
InnerHttpError

Oggetto che rappresenta l'errore HTTP interno

InvokeResponse

Rappresenta una risposta restituita da un bot quando riceve un'attività invoke . Questa interfaccia supporta il framework e non deve essere chiamata direttamente per il codice.

MediaCard

Scheda multimediale

MediaEventValue

Parametro supplementare per gli eventi multimediali

MediaUrl

URL multimediale

Mention

Informazioni sulle menzioni (tipo di entità: "mention")

MessageReaction

Oggetto reazione del messaggio

MicrosoftPayMethodData

Dati del metodo di pagamento W3C per Microsoft Pay

OAuthCard

Scheda che rappresenta una richiesta di accesso tramite OAuth

PagedMembersResult

Pagina dei membri.

PaymentAddress

Indirizzo all'interno di una richiesta di pagamento

PaymentCurrencyAmount

Fornisce importi monetari

PaymentDetails

Fornisce informazioni sulla transazione richiesta

PaymentDetailsModifier

Fornisce i dettagli che modificano PaymentDetails in base all'identificatore del metodo di pagamento

PaymentItem

Indica l'oggetto della richiesta di pagamento e il valore richiesto

PaymentMethodData

Indica un set di metodi di pagamento supportati ed eventuali dati specifici del metodo di pagamento associato per tali metodi

PaymentOptions

Fornisce informazioni sulle opzioni desiderate per la richiesta di pagamento

PaymentRequest

Richiesta di effettuare un pagamento

PaymentRequestComplete

Payload recapitato durante il completamento di una richiesta di pagamento

PaymentRequestCompleteResult

Risultato di una richiesta di pagamento completata

PaymentRequestUpdate

Aggiornamento a una richiesta di pagamento

PaymentRequestUpdateResult

Oggetto risultato da un'operazione di chiamata di Aggiornamento richiesta di pagamento

PaymentResponse

Un oggetto PaymentResponse viene restituito quando un utente ha selezionato un metodo di pagamento e approvato una richiesta di pagamento

PaymentShippingOption

Descrive un'opzione di spedizione

Place

Place (tipo di entità: "https://schema.org/Place")

ReceiptCard

Una scheda di ricevuta

ReceiptItem

Un articolo su una scheda di ricevuta

ResourceResponse

Risposta contenente un ID risorsa

SearchInvokeOptions

Fornisce informazioni sulle opzioni desiderate per searchInvokeValue

SearchInvokeResponse

Definisce la struttura restituita come risultato di un'attività Invoke con nome "applicazione/ricerca".

SearchInvokeValue

Definisce la struttura che arriva nell'attività Activity.Value for Invoke con nome 'application/search'.

SemanticAction

Rappresenta un riferimento a un'azione a livello di codice

SignInUrlResponse
SigninCard

Scheda che rappresenta una richiesta di accesso

SuggestedActions

SuggestedActions che è possibile eseguire

TextHighlight

Fa riferimento a una sottostringa del contenuto all'interno di un altro campo

Thing

Elemento (tipo di entità: "https://schema.org/Thing")

ThumbnailCard

Scheda di anteprima (scheda con un'unica immagine di anteprima piccola)

ThumbnailUrl

URL dell'anteprima

TokenExchangeRequest
TokenExchangeResource
TokenRequest

Richiesta di ricezione di un token utente

TokenResponse

Risposta che include un token utente

Transcript

Trascrizione

VideoCard

Scheda video

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

Richiesta di scambio di un token.

TokenExchangeInvokeResponse

Oggetto risposta di uno scambio di token invoke.

Alias tipo

IHandoffActivity
IMessageDeleteActivity
ITypingActivity
TokenExchangeState

Oggetto stato passato al servizio token bot.

TokenStatus

Stato di un token specifico.

FileDownloadInfoAttachment
O365ConnectorCardActionType

Definisce i valori per Type. I valori possibili includono: 'ViewAction', 'OpenUri', 'HttpPOST', 'ActionCard'

O365ConnectorCardInputType

Definisce i valori per O365ConnectorCardInputType. I valori possibili includono: 'textInput', 'dateInput', 'multichoiceInput'

Action

Definisce i valori per Action. I valori possibili includono: 'accept', 'decline'

ActivityImageType

Definisce i valori per ActivityImageType. I valori possibili includono: 'avatar', 'article'

ApplicationIdentityType

Definisce i valori per ApplicationIdentityType. I valori possibili includono: 'aadApplication', 'bot', 'tenantBot', 'office365Connector', 'webhook'

AttachmentLayout

Definisce i valori per AttachmentLayout. I valori possibili includono: 'list', 'grid'

BotMessagePreviewActionType

Definisce i valori per BotMessagePreviewActionType. I valori possibili includono: 'edit', 'send'

BotMessagePreviewType

Definisce i valori per BotMessagePreviewType. I valori possibili includono: 'message', 'continue'

CommandContext

Definisce i valori per CommandContext. I valori possibili includono: 'message', 'compose', 'commandbox'

ContentType

Definisce i valori per ContentType. I valori possibili includono: 'html', 'text'

ConversationIdentityType

Definisce i valori per ConversationIdentityType. I valori possibili includono: 'team', 'channel'

Importance

Definisce i valori per Importance. I valori possibili includono: 'normal', 'high', 'urgent'

MessageType

Definisce i valori per MessageType. I valori possibili includono: 'message'

MessagingExtensionResultType

Definisce i valori per MessagingExtensionResultType. I valori possibili includono: 'result', 'auth', 'config', 'message', 'botMessagePreview', 'silentAuth'.

O365ConnectorCardInputBaseType

Definisce i valori per O365ConnectorCardInputBaseType. I valori possibili includono: 'textInput', 'dateInput', 'multichoiceInput'

Os

Definisce i valori per Os. I valori possibili includono: 'default', 'iOS', 'android', 'windows'

ReactionType

Definisce i valori per ReactionType. I valori possibili includono: 'like', 'heart', 'laugh', 'sorpresa', 'triste', 'arrabbiato'

Style

Definisce i valori per Style. I valori possibili includono: 'compact', 'expanded'

Type

Definisce i valori per Type. I valori possibili includono: 'ViewAction', 'OpenUri', 'HttpPOST', 'ActionCard'

Type1
Type2
Type3
UserIdentityType

Definisce i valori per UserIdentityType. I valori possibili includono: 'aadUser', 'onPremiseAadUser', 'anonymousGuest', 'federatedUser'

Enumerazioni

ActionTypes

Definisce i valori per ActionTypes. I valori possibili includono: 'openUrl', 'imBack', 'postBack', 'playAudio', 'playVideo', 'showImage', 'downloadFile', 'signin', 'call', messageBack', 'openApp'

ActivityEventNames

Definisce i valori per ActivityEventNames. I valori possibili includono: 'continueConversation', 'createConversation'

ActivityImportance

Definisce i valori per ActivityImportance. I valori possibili includono: 'low', 'normal', 'high'

ActivityTypes

Definisce i valori per ActivityTypes. I valori possibili includono: 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff'

AttachmentLayoutTypes

Definisce i valori per AttachmentLayoutTypes. I valori possibili includono: 'list', 'carousel'

Channels

Definisce i valori per ChannelIds per Channels. I valori possibili includono: '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

Definisce i valori per ContactRelationUpdateActionTypes. I valori possibili includono: 'add', 'remove'

DeliveryModes

Definisce i valori per DeliveryModes. I valori possibili includono: 'normal', 'notification', 'expectReplies', 'ephemeral'

EndOfConversationCodes

Definisce i valori per EndOfConversationCodes. I valori possibili includono: 'unknown', 'completedSuccessly', 'userCancelled', 'botTimedOut', 'botIssuedInvalidMessage', 'channelFailed'

InputHints

Definisce i valori per InputHints. I valori possibili includono: 'acceptingInput', 'ignoringInput', 'expectingInput'

InstallationUpdateActionTypes

Definisce i valori per InstallationUpdateActionTypes. I valori possibili includono: 'add', 'remove'

MessageReactionTypes

Definisce i valori per MessageReactionTypes. I valori possibili includono: 'like', 'plusOne'

RoleTypes

Definisce i valori per RoleTypes. I valori possibili includono: 'user', 'bot', 'skill'

SemanticActionStateTypes

Definisce i valori per SemanticActionStateTypes. I valori possibili includono: 'start', 'continue', 'done'

StatusCodes

Definisce i valori per StatusCodes. I valori possibili includono: 200, 400, 401, 404, 405, 409, 426, 500, 501, 502

TextFormatTypes

Definisce i valori per TextFormatTypes. I valori possibili includono: 'markdown', 'plain', 'xml'

Funzioni

assertActivity(unknown, unknown[])
assertAttachment(unknown, unknown[])
assertAttachmentInfo(unknown, unknown[])
assertAttachmentView(unknown, unknown[])
assertCardAction(unknown, unknown[])
assertChannelAccount(unknown, unknown[])
assertConversationAccount(unknown, unknown[])
assertConversationReference(unknown, unknown[])
assertEntity(unknown, unknown[])
assertMessageReaction(unknown, unknown[])
assertSemanticAction(unknown, unknown[])
assertSuggestedActions(unknown, unknown[])
isActivity(unknown)
isAttachment(unknown)
isAttachmentInfo(unknown)
isAttachmentView(unknown)
isCardAction(unknown)
isChannelAccount(unknown)
isConversationAccount(unknown)
isConversationReference(unknown)
isEntity(unknown)
isMessageReaction(unknown)
isSemanticAction(unknown)
isSuggestedActions(unknown)

Dettagli funzione

assertActivity(unknown, unknown[])

function assertActivity(val: unknown, _args: unknown[]): asserts

Parametri

val

unknown

_args

unknown[]

Restituisce

asserts

assertAttachment(unknown, unknown[])

function assertAttachment(val: unknown, _args: unknown[]): asserts

Parametri

val

unknown

_args

unknown[]

Restituisce

asserts

assertAttachmentInfo(unknown, unknown[])

function assertAttachmentInfo(val: unknown, _args: unknown[]): asserts

Parametri

val

unknown

_args

unknown[]

Restituisce

asserts

assertAttachmentView(unknown, unknown[])

function assertAttachmentView(val: unknown, _args: unknown[]): asserts

Parametri

val

unknown

_args

unknown[]

Restituisce

asserts

assertCardAction(unknown, unknown[])

function assertCardAction(val: unknown, _args: unknown[]): asserts

Parametri

val

unknown

_args

unknown[]

Restituisce

asserts

assertChannelAccount(unknown, unknown[])

function assertChannelAccount(val: unknown, _args: unknown[]): asserts

Parametri

val

unknown

_args

unknown[]

Restituisce

asserts

assertConversationAccount(unknown, unknown[])

function assertConversationAccount(val: unknown, _args: unknown[]): asserts

Parametri

val

unknown

_args

unknown[]

Restituisce

asserts

assertConversationReference(unknown, unknown[])

function assertConversationReference(val: unknown, _args: unknown[]): asserts

Parametri

val

unknown

_args

unknown[]

Restituisce

asserts

assertEntity(unknown, unknown[])

function assertEntity(val: unknown, _args: unknown[]): asserts

Parametri

val

unknown

_args

unknown[]

Restituisce

asserts

assertMessageReaction(unknown, unknown[])

function assertMessageReaction(val: unknown, _args: unknown[]): asserts

Parametri

val

unknown

_args

unknown[]

Restituisce

asserts

assertSemanticAction(unknown, unknown[])

function assertSemanticAction(val: unknown, _args: unknown[]): asserts

Parametri

val

unknown

_args

unknown[]

Restituisce

asserts

assertSuggestedActions(unknown, unknown[])

function assertSuggestedActions(val: unknown, _args: unknown[]): asserts

Parametri

val

unknown

_args

unknown[]

Restituisce

asserts

isActivity(unknown)

function isActivity(val: unknown): boolean

Parametri

val

unknown

Restituisce

boolean

isAttachment(unknown)

function isAttachment(val: unknown): boolean

Parametri

val

unknown

Restituisce

boolean

isAttachmentInfo(unknown)

function isAttachmentInfo(val: unknown): boolean

Parametri

val

unknown

Restituisce

boolean

isAttachmentView(unknown)

function isAttachmentView(val: unknown): boolean

Parametri

val

unknown

Restituisce

boolean

isCardAction(unknown)

function isCardAction(val: unknown): boolean

Parametri

val

unknown

Restituisce

boolean

isChannelAccount(unknown)

function isChannelAccount(val: unknown): boolean

Parametri

val

unknown

Restituisce

boolean

isConversationAccount(unknown)

function isConversationAccount(val: unknown): boolean

Parametri

val

unknown

Restituisce

boolean

isConversationReference(unknown)

function isConversationReference(val: unknown): boolean

Parametri

val

unknown

Restituisce

boolean

isEntity(unknown)

function isEntity(val: unknown): boolean

Parametri

val

unknown

Restituisce

boolean

isMessageReaction(unknown)

function isMessageReaction(val: unknown): boolean

Parametri

val

unknown

Restituisce

boolean

isSemanticAction(unknown)

function isSemanticAction(val: unknown): boolean

Parametri

val

unknown

Restituisce

boolean

isSuggestedActions(unknown)

function isSuggestedActions(val: unknown): boolean

Parametri

val

unknown

Restituisce

boolean