ITraceActivity Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents a point in a bot's logic, to help with bot debugging.
public interface ITraceActivity : Microsoft.Bot.Schema.IActivitytype ITraceActivity = interface
interface IActivityPublic Interface ITraceActivity
Implements IActivity- Derived
- Implements
Remarks
The trace activity typically is logged by transcript history components to become part of a transcript history. In remote debugging scenarios the trace activity can be sent to the client so that the activity can be inspected as part of the debug flow.
Trace activities are normally not shown to the user, and are internal to transcript logging and developer debugging.
See also InspectionMiddleware.
Properties
| ChannelData |
Gets or sets channel-specific payload. (Inherited from IActivity) |
| ChannelId |
Gets or sets Channel this activity is associated with. (Inherited from IActivity) |
| Conversation |
Gets or sets Address for the conversation that this activity is associated with. (Inherited from IActivity) |
| Entities |
Gets or sets collection of Entity objects, each of which contains metadata about this activity. Each Entity object is typed. (Inherited from IActivity) |
| From |
Gets or sets Sender address. (Inherited from IActivity) |
| Id |
Gets or sets iD for the activity. (Inherited from IActivity) |
| Label |
Gets or sets an optional label which can provide contextual information about the trace. |
| LocalTimestamp |
Gets or sets the local date and time of the message, expressed in ISO-8601 format. For example, 2016-09-23T13:07:49.4714686-07:00. (Inherited from IActivity) |
| Name |
Gets or sets the name of the trace operation. |
| Recipient |
Gets or sets address that received the message. (Inherited from IActivity) |
| RelatesTo |
Gets or sets the ConversationReference, and optionally a specific activity within that conversation, that this trace is related to. |
| ReplyToId |
Gets or sets the original ID this activity is a response to. (Inherited from IActivity) |
| ServiceUrl |
Gets or sets service URL where responses to this activity should be sent. (Inherited from IActivity) |
| Timestamp |
Gets or sets timestamp when this message was sent (UTC). (Inherited from IActivity) |
| Type |
Gets or sets activity type. (Inherited from IActivity) |
| Value |
Gets or sets the content for this trace, as defined by the ValueType or Name property. |
| ValueType |
Gets or sets an optional identifier for the format of the Value property. |
Methods
| ApplyConversationReference(ConversationReference, Boolean) |
Updates an activity with the delivery information from an existing conversation reference. (Inherited from IActivity) |
| AsContactRelationUpdateActivity() |
Return IContactRelationUpdateActivity if this is a contactRelationUpdate activity, null otherwise. (Inherited from IActivity) |
| AsConversationUpdateActivity() |
Return IConversationUpdateActivity if this is a conversationUpdate activity, null otherwise. (Inherited from IActivity) |
| AsEndOfConversationActivity() |
Return IEndOfConversationActivity if this is an end-of-conversation activity, null otherwise. (Inherited from IActivity) |
| AsEventActivity() |
Returns IEventActivity if this is an event activity, null otherwise. (Inherited from IActivity) |
| AsInstallationUpdateActivity() |
Return IInstallationUpdateActivity if this is a installationUpdate activity, null otherwise. (Inherited from IActivity) |
| AsInvokeActivity() |
Returns IInvokeActivity if this is an invoke activity, null otherwise. (Inherited from IActivity) |
| AsMessageActivity() |
Return IMessageActivity if this is a message activity, null otherwise. (Inherited from IActivity) |
| AsMessageDeleteActivity() |
Returns IMessageDeleteActivity if this is a message delete activity, null otherwise. (Inherited from IActivity) |
| AsMessageReactionActivity() |
Returns IMessageDeleteActivity if this is a message reaction activity, null otherwise. (Inherited from IActivity) |
| AsMessageUpdateActivity() |
Returns IMessageUpdateActivity if this is a message update activity, null otherwise. (Inherited from IActivity) |
| AsSuggestionActivity() |
Returns IMessageDeleteActivity if this is a suggestion activity, null otherwise. (Inherited from IActivity) |
| AsTypingActivity() |
Return ITypingActivity if this is a typing activity, null otherwise. (Inherited from IActivity) |
| GetChannelData<TypeT>() |
Gets the channel data as strongly typed object. (Inherited from IActivity) |
| GetConversationReference() |
Gets a conversation reference from an activity. (Inherited from IActivity) |
| TryGetChannelData<TypeT>(TypeT) |
Try to get the channeldata as a strongly typed object. (Inherited from IActivity) |
Extension Methods
| TeamsGetChannelId(IActivity) |
Gets the Team's channel id from the current activity. |
| TeamsGetMeetingInfo(IActivity) |
Gets the TeamsMeetingInfo object from the current activity. |
| TeamsGetSelectedChannelId(IActivity) |
Gets the Team's selected channel id from the current activity. |
| TeamsGetTeamInfo(IActivity) |
Gets the TeamsInfo object from the current activity. |
| TeamsNotifyUser(IActivity) |
Configures the current activity to generate a notification within Teams. |
| TeamsNotifyUser(IActivity, Boolean, String) |
Configures the current activity to generate a notification within Teams. |
| GetLocale(IActivity) |
Gets the locale for the activity. |
| SetLocale(IActivity, String) |
Sets the locale for the activity. |