ActivityEx module

Package:

botframework-schema

Functions

asCommandActivity<T>(Partial<Activity>)	Returns the source activity as an ICommandActivity object; or null, if this is not that type of activity.
asCommandResultActivity<T>(Partial<Activity>)	Returns the source activity as an ICommandResultActivity object; or null, if this is not that type of activity.
asContactRelationUpdateActivity(Partial<Activity>)	Returns the source activity as an IContactRelationUpdateActivity object; or null, if this is not that type of activity.
asConversationUpdateActivity(Partial<Activity>)	Returns the source activity as an IConversationUpdateActivity object; or null, if this is not that type of activity.
asEndOfConversationActivity(Partial<Activity>)	Returns the source activity as an IEndOfConversationActivity object; or null, if this is not that type of activity.
asEventActivity(Partial<Activity>)	Returns the source activity as an IEventActivity object; or null, if this is not that type of activity.
asHandoffActivity(Partial<Activity>)	Returns the source activity as an IHandoffActivity object; or null, if this is not that type of activity.
asInstallationUpdateActivity(Partial<Activity>)	Returns the source activity as an IInstallationUpdateActivity object; or null, if this is not that type of activity.
asInvokeActivity(Partial<Activity>)	Returns the source activity as an IInvokeActivity object; or null, if this is not that type of activity.
asMessageActivity(Partial<Activity>)	Returns the source activity as an IMessageActivity object; or null, if this is not that type of activity.
asMessageDeleteActivity(Partial<Activity>)	Returns the source activity as an IMessageDeleteActivity object; or null, if this is not that type of activity.
asMessageReactionActivity(Partial<Activity>)	Returns the source activity as an IMessageReactionActivity object; or null, if this is not that type of activity.
asMessageUpdateActivity(Partial<Activity>)	Returns the source activity as an IMessageUpdateActivity object; or null, if this is not that type of activity.
asSuggestionActivity(Partial<Activity>)	Returns the source activity as an ISuggestionActivity object; or null, if this is not that type of activity.
asTraceActivity(Partial<Activity>)	Returns the source activity as an ITraceActivity object; or null, if this is not that type of activity.
asTypingActivity(Partial<Activity>)	Returns the source activity as an ITypingActivity object; or null, if this is not that type of activity.
createContactRelationUpdateActivity()	Creates an Activity as an IContactRelationUpdateActivity object.
createConversationUpdateActivity()	Creates an Activity as an IConversationUpdateActivity object.
createEndOfConversationActivity()	Creates an Activity as an IEndOfConversationActivity object.
createEventActivity()	Creates an Activity as an IEventActivity object.
createHandoffActivity()	Creates an Activity as an IHandoffActivity object.
createInvokeActivity()	Creates an Activity as an IInvokeActivity object.
createMessageActivity()	Creates an Activity as an IMessageActivity object.
createReply(Activity, string, string)	Creates a new message activity as a response to this activity.
createTrace(Activity, string, unknown, string, string)	Creates a new trace activity based on the source activity.
createTraceActivity(string, string, unknown, string)	Creates an Activity as an ITraceActivity object.
createTypingActivity()	Creates an Activity as an ITypingActivity object.
getContinuationActivity(Partial<ConversationReference>)	Creates an Activity from conversation reference as it is posted to bot.
getConversationReference(Partial<Activity>)	Creates a ConversationReference based on the source activity.
getMentions(Partial<Activity>)	Resolves the mentions from the entities of the source activity. See cref="entities" . See cref="mention" .
hasContent(Partial<Activity>)	Indicates whether the source activity has content.
isActivity(Partial<Activity>, string)	Indicates whether this activity is of a specified activity type.
isFromStreamingConnection(Partial<Activity>)	Determines if the Activity was sent via an Http/Https connection or Streaming. This can be determined by looking at the ServiceUrl property: (1) All channels that send messages via http/https are not streaming (2) Channels that send messages via streaming have a ServiceUrl that does not begin with http/https.

Function Details

asCommandActivity<T>(Partial<Activity>)

Returns the source activity as an ICommandActivity object; or null, if this is not that type of activity.

function asCommandActivity<T>(source: Partial<Activity>): Partial<ICommandActivity<T>>

Parameters

source

Partial<Activity>

The source activity.

Returns

Partial<ICommandActivity<T>>

This activity as a command activity; or null.

asCommandResultActivity<T>(Partial<Activity>)

Returns the source activity as an ICommandResultActivity object; or null, if this is not that type of activity.

function asCommandResultActivity<T>(source: Partial<Activity>): Partial<ICommandResultActivity<T>>

Parameters

source

Partial<Activity>

The source activity.

Returns

Partial<ICommandResultActivity<T>>

This activity as a command result activity; or null.

asContactRelationUpdateActivity(Partial<Activity>)

Returns the source activity as an IContactRelationUpdateActivity object; or null, if this is not that type of activity.

function asContactRelationUpdateActivity(source: Partial<Activity>): Partial<IContactRelationUpdateActivity>

Parameters

source

Partial<Activity>

The source activity.

Returns

Partial<IContactRelationUpdateActivity>

This activity as a contact relation update activity; or null.

asConversationUpdateActivity(Partial<Activity>)

Returns the source activity as an IConversationUpdateActivity object; or null, if this is not that type of activity.

function asConversationUpdateActivity(source: Partial<Activity>): Partial<IConversationUpdateActivity>

Parameters

source

Partial<Activity>

The source activity.

Returns

Partial<IConversationUpdateActivity>

This activity as an conversation update activity; or null.

asEndOfConversationActivity(Partial<Activity>)

Returns the source activity as an IEndOfConversationActivity object; or null, if this is not that type of activity.

function asEndOfConversationActivity(source: Partial<Activity>): Partial<IEndOfConversationActivity>

Parameters

source

Partial<Activity>

The source activity.

Returns

Partial<IEndOfConversationActivity>

This activity as an end of conversation activity; or null.

asEventActivity(Partial<Activity>)

Returns the source activity as an IEventActivity object; or null, if this is not that type of activity.

function asEventActivity(source: Partial<Activity>): Partial<IEventActivity>

Parameters

source

Partial<Activity>

The source activity.

Returns

Partial<IEventActivity>

This activity as an event activity; or null.

asHandoffActivity(Partial<Activity>)

Returns the source activity as an IHandoffActivity object; or null, if this is not that type of activity.

function asHandoffActivity(source: Partial<Activity>): Partial<IHandoffActivity>

Parameters

source

Partial<Activity>

The source activity.

Returns

Partial<IHandoffActivity>

This activity as a handoff activity; or null.

asInstallationUpdateActivity(Partial<Activity>)

Returns the source activity as an IInstallationUpdateActivity object; or null, if this is not that type of activity.

function asInstallationUpdateActivity(source: Partial<Activity>): Partial<IInstallationUpdateActivity>

Parameters

source

Partial<Activity>

The source activity.

Returns

Partial<IInstallationUpdateActivity>

This activity as an installation update activity; or null.

asInvokeActivity(Partial<Activity>)

Returns the source activity as an IInvokeActivity object; or null, if this is not that type of activity.

function asInvokeActivity(source: Partial<Activity>): Partial<IInvokeActivity>

Parameters

source

Partial<Activity>

The source activity.

Returns

Partial<IInvokeActivity>

This activity as an invoke activity; or null.

asMessageActivity(Partial<Activity>)

Returns the source activity as an IMessageActivity object; or null, if this is not that type of activity.

function asMessageActivity(source: Partial<Activity>): Partial<IMessageActivity>

Parameters

source

Partial<Activity>

The source activity.

Returns

Partial<IMessageActivity>

This activity as a message activity; or null.

asMessageDeleteActivity(Partial<Activity>)

Returns the source activity as an IMessageDeleteActivity object; or null, if this is not that type of activity.

function asMessageDeleteActivity(source: Partial<Activity>): Partial<IMessageDeleteActivity>

Parameters

source

Partial<Activity>

The source activity.

Returns

Partial<IMessageDeleteActivity>

This activity as a message delete request; or null.

asMessageReactionActivity(Partial<Activity>)

Returns the source activity as an IMessageReactionActivity object; or null, if this is not that type of activity.

function asMessageReactionActivity(source: Partial<Activity>): Partial<IMessageReactionActivity>

Parameters

source

Partial<Activity>

The source activity.

Returns

Partial<IMessageReactionActivity>

This activity as a message reaction activity; or null.

asMessageUpdateActivity(Partial<Activity>)

Returns the source activity as an IMessageUpdateActivity object; or null, if this is not that type of activity.

function asMessageUpdateActivity(source: Partial<Activity>): Partial<IMessageUpdateActivity>

Parameters

source

Partial<Activity>

The source activity.

Returns

Partial<IMessageUpdateActivity>

This activity as a message update request; or null.

asSuggestionActivity(Partial<Activity>)

Returns the source activity as an ISuggestionActivity object; or null, if this is not that type of activity.

function asSuggestionActivity(source: Partial<Activity>): Partial<ISuggestionActivity>

Parameters

source

Partial<Activity>

The source activity.

Returns

Partial<ISuggestionActivity>

This activity as a suggestion activity; or null.

asTraceActivity(Partial<Activity>)

Returns the source activity as an ITraceActivity object; or null, if this is not that type of activity.

function asTraceActivity(source: Partial<Activity>): Partial<ITraceActivity>

Parameters

source

Partial<Activity>

The source activity.

Returns

Partial<ITraceActivity>

This activity as a trace activity; or null.

asTypingActivity(Partial<Activity>)

Returns the source activity as an ITypingActivity object; or null, if this is not that type of activity.

function asTypingActivity(source: Partial<Activity>): Partial<ITypingActivity>

Parameters

source

Partial<Activity>

The source activity.

Returns

Partial<ITypingActivity>

This activity as a typing activity; or null.

createContactRelationUpdateActivity()

Creates an Activity as an IContactRelationUpdateActivity object.

function createContactRelationUpdateActivity(): Partial<IContactRelationUpdateActivity>

Returns

Partial<IContactRelationUpdateActivity>

The new contact relation update activity.

createConversationUpdateActivity()

Creates an Activity as an IConversationUpdateActivity object.

function createConversationUpdateActivity(): Partial<IConversationUpdateActivity>

Returns

Partial<IConversationUpdateActivity>

The new conversation update activity.

createEndOfConversationActivity()

Creates an Activity as an IEndOfConversationActivity object.

function createEndOfConversationActivity(): Partial<IEndOfConversationActivity>

Returns

Partial<IEndOfConversationActivity>

The new end of conversation activity.

createEventActivity()

Creates an Activity as an IEventActivity object.

function createEventActivity(): Partial<IEventActivity>

Returns

Partial<IEventActivity>

The new event activity.

createHandoffActivity()

Creates an Activity as an IHandoffActivity object.

function createHandoffActivity(): Partial<IHandoffActivity>

Returns

Partial<IHandoffActivity>

The new handoff activity.

createInvokeActivity()

Creates an Activity as an IInvokeActivity object.

function createInvokeActivity(): Partial<IInvokeActivity>

Returns

Partial<IInvokeActivity>

The new invoke activity.

createMessageActivity()

Creates an Activity as an IMessageActivity object.

function createMessageActivity(): Partial<IMessageActivity>

Returns

Partial<IMessageActivity>

The new message activity.

createReply(Activity, string, string)

Creates a new message activity as a response to this activity.

function createReply(source: Activity, text?: string, locale?: string): Activity

Parameters

source

Activity

The activity to respond.

text

string

The text of the reply.

locale

string

The language code for the @param text .

Returns

Activity

The new message activity.

Remarks

The new activity sets up routing information based on this activity.

createTrace(Activity, string, unknown, string, string)

Creates a new trace activity based on the source activity.

function createTrace(source: Activity, name: string, value?: unknown, valueType?: string, label?: string): ITraceActivity

Parameters

source

Activity

The activity to base the trace.

name

string

The name of the trace operation to create.

value

unknown

Optional, the content for this trace operation.

valueType

string

Optional, identifier for the format of the @param value . Default is the name of type of the @param value .

label

string

Optional, a descriptive label for this trace operation.

Returns

ITraceActivity

The new trace activity.

createTraceActivity(string, string, unknown, string)

Creates an Activity as an ITraceActivity object.

function createTraceActivity(name: string, valueType?: string, value?: unknown, label?: string): Partial<ITraceActivity>

Parameters

name

string

The name of the trace operation to create.

valueType

string

Optional, identifier for the format of the @param value . Default is the name of type of the @param value .

value

unknown

Optional, the content for this trace operation.

label

string

Optional, a descriptive label for this trace operation.

Returns

Partial<ITraceActivity>

The new trace activity.

createTypingActivity()

Creates an Activity as an ITypingActivity object.

function createTypingActivity(): Partial<ITypingActivity>

Returns

Partial<ITypingActivity>

The new typing activity.

getContinuationActivity(Partial<ConversationReference>)

Creates an Activity from conversation reference as it is posted to bot.

function getContinuationActivity(reference: Partial<ConversationReference>): Partial<Activity>

Parameters

reference

Partial<ConversationReference>

the conversation reference

Returns

Partial<Activity>

the activity

getConversationReference(Partial<Activity>)

Creates a ConversationReference based on the source activity.

function getConversationReference(source: Partial<Activity>): ConversationReference

Parameters

source

Partial<Activity>

The source activity.

Returns

ConversationReference

A conversation reference for the conversation that contains the activity.

getMentions(Partial<Activity>)

Resolves the mentions from the entities of the source activity.

See cref="entities" .

See cref="mention" .

function getMentions(source: Partial<Activity>): Mention[]

Parameters

source

Partial<Activity>

The source activity.

Returns

Mention[]

The array of mentions; or an empty array, if none are found.

Remarks

This method is only intended for use with a message activity, where the Activity Type is set to Message.

hasContent(Partial<Activity>)

Indicates whether the source activity has content.

function hasContent(source: Partial<Activity>): boolean

Parameters

source

Partial<Activity>

The source activity.

Returns

boolean

True, if this activity has any content to send; otherwise, false.

Remarks

This method is only intended for use with a message activity, where the Activity Type is set to Message.

isActivity(Partial<Activity>, string)

Indicates whether this activity is of a specified activity type.

function isActivity(source: Partial<Activity>, activityType: string): boolean

Parameters

source

Partial<Activity>

The source activity.

activityType

string

The activity type to check for.

Returns

boolean

True if the activity is of the specified activity type; otherwise, false.

isFromStreamingConnection(Partial<Activity>)

Determines if the Activity was sent via an Http/Https connection or Streaming. This can be determined by looking at the ServiceUrl property: (1) All channels that send messages via http/https are not streaming (2) Channels that send messages via streaming have a ServiceUrl that does not begin with http/https.

function isFromStreamingConnection(source: Partial<Activity>): boolean

Parameters

source

Partial<Activity>

The source activity.

Returns

boolean

True if the Activity was originate from a streaming connection.