ISuggestionActivity Interface

Definition

Namespace:

Microsoft.Agents.Protocols.Primitives

Assembly:

Microsoft.Agents.Protocols.dll

Package:

Microsoft.Agents.Protocols v0.2.10-alpha

Represents a private suggestion to the Recipient about another activity.

C#

public interface ISuggestionActivity : Microsoft.Agents.Protocols.Primitives.IMessageActivity

Derived

Microsoft.Agents.Protocols.Primitives.Activity

Implements

IActivity IMessageActivity

Remarks

The activity's ReplyToId property identifies the activity being referenced. The activity's Recipient property indicates which user the suggestion is for.

Properties

Action	The action field describes the meaning of the contact relation update activity. The value of the Action field is a string. Only values of add and remove are defined, which denote a relationship between the users/bots in the from and recipient fields. (Inherited from IActivity)
AttachmentLayout	The AttachmentLayout field instructs user interface renderers how to present content included in the attachments field. The value of the attachmentLayout field is of type string, with defined values of list and carousel. (Inherited from IActivity)
Attachments	The Attachments field contains a flat list of objects to be displayed as part of this activity. The value of each attachments list element is a complex object of the Attachment type. (Inherited from IActivity)
CallerId	In some cases, it's important to record where an activity was sent. The CallerId field is a string containing an IRI identifying the caller of a bot. This field is not intended to be transmitted over the wire, but is instead populated by bots and clients based on cryptographically verifiable data that asserts the identity of the callers (e.g. tokens). (Inherited from IActivity)
ChannelData	Extensibility data in the activity schema is organized principally within the ChannelData field. This simplifies plumbing in SDKs that implement the protocol. The format of the ChannelData object is defined by the channel sending or receiving the activity. (Inherited from IActivity)
ChannelId	The ChannelId field establishes the channel and authoritative store for the activity. (Inherited from IActivity)
Code	The Code field contains a programmatic value describing why or how the conversation was ended. The value of the Code field is of type string and its meaning is defined by the channel sending the activity. (Inherited from IActivity)
Conversation	The Conversation field describes the conversation in which the activity exists. The value of the conversation field is a complex object of the Conversation account type. (Inherited from IActivity)
DeliveryMode	The DeliveryMode field contains any one of an enumerated set of values to signal to the recipient alternate delivery paths for the activity or response. The value of the deliveryMode field is of type string, with defined values of 'normal', 'notification' and 'expectReplies'. The default value is normal. (Inherited from IActivity)
Entities	The Entities field contains a flat list of metadata objects pertaining to this activity. Unlike attachments (see the attachments field), entities do not necessarily manifest as user-interactable content elements, and are intended to be ignored if not understood. Senders may include entities they think may be useful to a receiver even if they are not certain the receiver can accept them. The value of each entities list element is a complex object of the Entity type. (Inherited from IActivity)
Expiration	The Expiration field contains a time at which the activity should be considered to be "expired" and should not be presented to the recipient. The value of the expiration field is an ISO 8601 date time format encoded datetime within a string. (Inherited from IActivity)
From	The From field describes which client, bot, or channel generated an activity. The value of the From field is a complex object of the ChannelAccount type. (Inherited from IActivity)
Id	The Id field establishes the identity for the activity once it has been recorded in the channel. Activities in-flight that have not yet been recorded do not have identities. Not all activities are assigned identities (for example, a typing activity may never be assigned an id.) (Inherited from IActivity)
Importance	The importance field contains an enumerated set of values to signal to the recipient the relative importance of the activity. It is up to the receiver to map these importance hints to the user experience. The value of the importance field is of type string, with defined values of low, normal and high. The default value is normal. (Inherited from IActivity)
InputHint	The inputHint field indicates whether or not the generator of the activity is anticipating a response. This field is used predominantly within channels that have modal user interfaces, and is typically not used in channels with continuous chat feeds. The value of the inputHint field is of type string, with defined values of accepting, expecting, and ignoring. The default value is accepting. (Inherited from IActivity)
Label	The label field contains optional a label which can provide contextual information about the trace. The value of the label field is of type string. (Inherited from IActivity)
ListenFor	The listenFor field contains a list of terms or references to term sources that speech and language processing systems can listen for. (Inherited from IActivity)
Locale	The locale field communicates the language code of the text field. The value of the locale field is an IETF BCP-47 language tag within a string. (Inherited from IActivity)
LocalTimestamp	The localTimestamp field expresses the datetime and timezone offset where the activity was generated. This may be different from the UTC timestamp where the activity was recorded. The value of the localTimestamp field is an ISO 8601 encoded datetime within a string. (Inherited from IActivity)
LocalTimezone	The LocalTimezone field expresses the timezone where the activity was generated. The value of the localTimezone field is a time zone name (zone entry) per the IANA Time Zone database. (Inherited from IActivity)
MembersAdded	The membersAdded field contains a list of channel participants (bots or users) added to the conversation. The value of the membersAdded field is an array of type channelAccount. (Inherited from IActivity)
MembersRemoved	The membersRemoved field contains a list of channel participants (bots or users) removed from the conversation. The value of the membersRemoved field is an array of type channelAccount. (Inherited from IActivity)
Name	The name field controls the meaning of the event and the schema of the value field. (Inherited from IActivity)
Properties	Gets properties that are not otherwise defined by the Activity type but that might appear in the serialized REST JSON object. (Inherited from IActivity)
ReactionsAdded	The reactionsAdded field contains a list of reactions added to this activity. The value of the ReactionsAdded field is an array of type MessageReaction. (Inherited from IActivity)
ReactionsRemoved	The reactionsRemoved field contains a list of reactions removed from this activity. The value of the ReactionsRemoved field is an array of type MessageReaction. (Inherited from IActivity)
Recipient	The recipient field describes which client or bot is receiving this activity. This field is only meaningful when an activity is transmitted to exactly one recipient; it is not meaningful when it is broadcast to multiple recipients (as happens when an activity is sent to a channel). The purpose of the field is to allow the recipient to identify themselves. This is helpful when a client or bot has more than one identity within the channel. The value of the recipient field is a complex object of the Channel account type. (Inherited from IActivity)
RelatesTo	The relatesTo field references another conversation, and optionally a specific activity within that conversation. The value of the relatesTo field is a complex object of the Conversation reference type. (Inherited from IActivity)
ReplyToId	The replyToId field identifies the prior activity to which the current activity is a reply. This field allows threaded conversation and comment nesting to be communicated between participants. replyToId is valid only within the current conversation. (See relatesTo for references to other conversations.) (Inherited from IActivity)
SemanticAction	The semanticAction field contains an optional programmatic action accompanying the user request. The semantic action field is populated by the channel and bot based on some understanding of what the user is trying to accomplish; this understanding may be achieved with natural language processing, additional user interface elements tied specifically to these actions, through a process of conversational refinement, or contextually via other means. The meaning and structure of the semantic action is agreed ahead of time between the channel and the bot. (Inherited from IActivity)
ServiceUrl	Activities are frequently sent asynchronously, with separate transport connections for sending and receiving traffic. The serviceUrl field is used by channels to denote the URL where replies to the current activity may be sent. (Inherited from IActivity)
Speak	The speak field indicates how the activity should be spoken via a text-to-speech system. The field is only used to customize speech rendering when the default is deemed inadequate. It replaces speech synthesis for any content within the activity, including text, attachments, and summaries. The value of the speak field is either plain text or SSML encoded within a string. (Inherited from IActivity)
SuggestedActions	The suggestedActions field contains a payload of interactive actions that may be displayed to the user. Support for suggestedActions and their manifestation depends heavily on the channel. The value of the suggestedActions field is a complex object of the Suggested actions type. (Inherited from IActivity)
Summary	The summary field contains text used to replace attachments on channels that do not support them. (Inherited from IActivity)
Text	The text field contains text content, either in the Markdown format, XML, or as plain text. The format is controlled by the textFormat field as is plain if unspecified or ambiguous. (Inherited from IActivity)
TextFormat	The textFormat field denotes whether the text field should be interpreted as Markdown [3], plain text, or XML. The value of the textFormat field is of type string, with defined values of markdown, plain, and xml. The default value is plain. This field is not designed to be extended with arbitrary values. (Inherited from IActivity)
TextHighlights	The textHighlights field contains a list of text to highlight in the text field of the activity referred to by ReplyToId. The value of the TextHighlights field is an array of type TextHighlight. (Inherited from IActivity)
Timestamp	The timestamp field records the exact UTC time when the activity occurred. Due to the distributed nature of computing systems, the important time is when the channel (the authoritative store) records the activity. The time when a client or bot initiated an activity may be transmitted separately in the localTimestamp field. The value of the timestamp field is an ISO 8601 date time format encoded datetime within a string. (Inherited from IActivity)
TopicName	The topicName field contains the text topic or description for the conversation. The value of the topicName field is of type string. (Inherited from IActivity)
Type	The type field controls the meaning of each activity, and are by convention short strings (e.g. "message"). Senders may define their own application-layer types, although they are encouraged to choose values that are unlikely to collide with future well-defined values. If senders use URIs as type values, they SHOULD NOT implement URI ladder comparisons to establish equivalence. (Inherited from IActivity)
Value	The value field contains a programmatic payload specific to the activity being sent. Its meaning and format are defined in other sections of this document that describe its use. (Inherited from IActivity)
ValueType	The valueType field is a string type which contains a unique value which identifies the shape of the value. (Inherited from IActivity)

Methods

ApplyConversationReference(ConversationReference, Boolean)	Updates this activity with the delivery information from an existing ConversationReference. (Inherited from IActivity)
CreateReply(String, String)	Creates a new message activity as a response to this activity. (Inherited from IActivity)
CreateTrace(String, Object, String, String)	Creates a new trace activity based on this activity. (Inherited from IActivity)
GetConversationReference()	Creates a ConversationReference based on this activity. (Inherited from IActivity)
GetReplyConversationReference(ResourceResponse)	Create a ConversationReference based on this Activity's Conversation info and the ResourceResponse from sending an activity. (Inherited from IActivity)
HasContent()	Indicates whether this activity has content. (Inherited from IActivity)
IsFromStreamingConnection()	(Inherited from IActivity)

Extension Methods

Clone(IActivity)	Clone the activity to a new instance of activity.
GetChannelData<TypeT>(IActivity)	Gets the channel data for this activity as a strongly-typed object.
GetMentions(IActivity)	Resolves the mentions from the entities of this activity.
ToJson(IActivity)	Converts an IActivity to a JSON string.
TryGetChannelData<TypeT>(IActivity, TypeT)	Gets the channel data for this activity as a strongly-typed object. A return value indicates whether the operation succeeded.
RemoveMentionText(IActivity, String)	Remove any mention text for given id from the Activity.Text property. For example, given the message @echoBot Hi Bot, this will remove "@echoBot", leaving "Hi Bot".
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.
TeamsGetTeamOnBehalfOf(IActivity)	Gets the Teams OnBehalfOf list from the current activity.
TeamsNotifyUser(IActivity, Boolean, String)	Configures the current activity to generate a notification within Teams.
TeamsNotifyUser(IActivity)	Configures the current activity to generate a notification within Teams.

Applies to