Activity Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Действие — это базовый тип связи для протокола Bot Framework 3.0.
public class Activity : Microsoft.Bot.Schema.ICommandActivity, Microsoft.Bot.Schema.ICommandResultActivity, Microsoft.Bot.Schema.IContactRelationUpdateActivity, Microsoft.Bot.Schema.IConversationUpdateActivity, Microsoft.Bot.Schema.IEndOfConversationActivity, Microsoft.Bot.Schema.IEventActivity, Microsoft.Bot.Schema.IHandoffActivity, Microsoft.Bot.Schema.IInstallationUpdateActivity, Microsoft.Bot.Schema.IInvokeActivity, Microsoft.Bot.Schema.IMessageDeleteActivity, Microsoft.Bot.Schema.IMessageReactionActivity, Microsoft.Bot.Schema.IMessageUpdateActivity, Microsoft.Bot.Schema.ISuggestionActivity, Microsoft.Bot.Schema.ITraceActivity, Microsoft.Bot.Schema.ITypingActivity
type Activity = class
interface IActivity
interface IConversationUpdateActivity
interface IContactRelationUpdateActivity
interface IInstallationUpdateActivity
interface IMessageActivity
interface IMessageUpdateActivity
interface IMessageDeleteActivity
interface IMessageReactionActivity
interface ISuggestionActivity
interface ITypingActivity
interface IEndOfConversationActivity
interface IEventActivity
interface IInvokeActivity
interface ITraceActivity
interface IHandoffActivity
interface ICommandActivity
interface ICommandResultActivity
Public Class Activity
Implements ICommandActivity, ICommandResultActivity, IContactRelationUpdateActivity, IConversationUpdateActivity, IEndOfConversationActivity, IEventActivity, IHandoffActivity, IInstallationUpdateActivity, IInvokeActivity, IMessageDeleteActivity, IMessageReactionActivity, IMessageUpdateActivity, ISuggestionActivity, ITraceActivity, ITypingActivity
- Наследование
-
Activity
- Реализации
-
IActivity ICommandActivity ICommandResultActivity IContactRelationUpdateActivity IConversationUpdateActivity IEndOfConversationActivity IEventActivity IHandoffActivity IInstallationUpdateActivity IInvokeActivity IMessageActivity IMessageDeleteActivity IMessageReactionActivity IMessageUpdateActivity ISuggestionActivity ITraceActivity ITypingActivity
Комментарии
Класс Activity содержит все свойства, которые могут содержать отдельные, более конкретные действия. Это тип надмножества.
Конструкторы
Поля
ContentType |
Заголовок сущности HTTP |
Свойства
Action |
Возвращает или задает строку, указывающую, был ли получатель contactRelationUpdate добавлен в список контактов отправителя или удален из него. |
AttachmentLayout |
Возвращает или задает указание макета для нескольких вложений. По умолчанию: list. Возможные значения определяются с помощью AttachmentLayoutTypes. |
Attachments |
Возвращает или задает вложения для действия. |
CallerId |
Возвращает или задает строку, содержащую IRI, идентифицирующие вызывающий объект бота. Это поле не предназначено для передачи по сети. Оно заполняется ботами и клиентами на основе доступных для криптографической проверки данных, которые подтверждают подлинность вызывающих объектов (например, маркеров). |
ChannelData |
Возвращает или задает содержимое канала. |
ChannelId |
Возвращает или задает идентификатор, который однозначно идентифицирует канал. Задается каналом. |
Code |
Возвращает или задает код для действий endOfConversation, указывающий, почему беседа закончилась. Возможные значения определяются в EndOfConversationCodes. |
Conversation |
Возвращает или задает беседу, к которой принадлежит действие. |
DeliveryMode |
Возвращает или задает указание доставки, чтобы сообщить получателю альтернативные пути доставки для действия. Режим доставки по умолчанию — "default". Возможные значения определяются в DeliveryModes. |
Entities |
Возвращает или задает сущности, упомянутые в сообщении. |
Expiration |
Возвращает или задает время, когда действие должно считаться просроченным и не должно быть представлено получателю. |
From |
Возвращает или задает отправителя сообщения. |
HistoryDisclosed |
Возвращает или задает значение, указывающее, раскрывается ли предыдущий журнал канала. |
Id |
Возвращает или задает идентификатор, который однозначно идентифицирует действие в канале. |
Importance |
Возвращает или задает важность действия. Возможные значения определяются в ActivityImportance. |
InputHint |
Возвращает или задает строку, указывающую, принимает ли бот, ожидает или игнорирует введенные пользователем данные после доставки сообщения клиенту (см InputHints. раздел . |
Label |
Возвращает или задает описательную метку для действия. |
ListenFor |
Возвращает или задает список фраз и ссылок, которые должны прослушиваться системами распознавания речи и языка. |
Locale |
Возвращает или задает имя языкового стандарта BCP-47 для содержимого текстового поля. |
LocalTimestamp |
Возвращает или задает дату и время отправки сообщения в местном времени, выраженные в формате ISO-8601. Например, 2016-09-23T13:07:49.4714686-07:00. |
LocalTimezone |
Возвращает или задает имя часового пояса, используемого для определения местного времени для сообщения, выраженное в формате базы данных часового пояса IANA. Например, America/Los_Angeles. |
MembersAdded |
Возвращает или задает коллекцию участников, добавленных в беседу. |
MembersRemoved |
Возвращает или задает коллекцию элементов, удаленных из диалога. |
Name |
Возвращает или задает имя операции, связанной с действием вызова или события. |
Properties |
Возвращает или задает свойства, которые не определены типом Activity , но могут отображаться в сериализованном объекте JSON REST. |
ReactionsAdded |
Возвращает или задает коллекцию реакций, добавленных в беседу. |
ReactionsRemoved |
Возвращает или задает коллекцию реакций, удаленных из диалога. |
Recipient |
Возвращает или задает получателя сообщения. |
RelatesTo |
Возвращает или задает для другого ConversationReference диалога или действия. |
ReplyToId |
Возвращает или задает идентификатор сообщения, на которое это сообщение является ответом. |
SemanticAction |
Возвращает или задает необязательное программное действие, сопровождающее этот запрос. |
ServiceUrl |
Возвращает или задает URL-адрес, указывающий конечную точку службы канала. Задается каналом. |
Speak |
Возвращает или задает текст для речи. |
SuggestedActions |
Возвращает или задает предлагаемые действия для действия. |
Summary |
Возвращает или задает текст, отображаемый, если каналу не удается отобразить карточки. |
Text |
Возвращает или задает текстовое содержимое сообщения. |
TextFormat |
Возвращает или задает формат текстовых полей. По умолчанию: markdown. Возможные значения определяются с помощью TextFormatTypes. |
TextHighlights |
Возвращает или задает коллекцию фрагментов текста для выделения, если действие содержит значение ReplyToId. |
Timestamp |
Возвращает или задает дату и время отправки сообщения в формате UTC, выраженные в формате ISO-8601. |
TopicName |
Возвращает или задает обновленное имя темы беседы. |
Type |
Возвращает или задает тип действия. Возможные значения: "message", "contactRelationUpdate", "conversationUpdate", "typing", "endOfConversation", "event", "invoke", "deleteUserData", "messageUpdate", "messageDelete", "installationUpdate", "messageReaction", "suggestion", "trace", "handoff". |
Value |
Возвращает или задает значение, связанное с действием. |
ValueType |
Возвращает или задает тип объекта значения действия. |
Методы
ApplyConversationReference(ConversationReference, Boolean) |
Обновления это действие с помощью сведений о доставке из существующего ConversationReference. |
AsCommandActivity() |
Возвращает это действие в ICommandActivity виде объекта или значение NULL, если это действие не является этим типом действия. |
AsCommandResultActivity() |
Возвращает это действие в ICommandResultActivity виде объекта или значение NULL, если это действие не является этим типом действия. |
AsContactRelationUpdateActivity() |
Возвращает это действие в IContactRelationUpdateActivity виде объекта или значение NULL, если это действие не является этим типом действия. |
AsConversationUpdateActivity() |
Возвращает это действие в IConversationUpdateActivity виде объекта или значение NULL, если это действие не является этим типом действия. |
AsEndOfConversationActivity() |
Возвращает это действие в IEndOfConversationActivity виде объекта или значение NULL, если это действие не является этим типом действия. |
AsEventActivity() |
Возвращает это действие в IEventActivity виде объекта или значение NULL, если это действие не является этим типом действия. |
AsHandoffActivity() |
Возвращает это действие в IHandoffActivity виде объекта или значение NULL, если это действие не является этим типом действия. |
AsInstallationUpdateActivity() |
Возвращает это действие в IInstallationUpdateActivity виде объекта или значение NULL, если это действие не является этим типом действия. |
AsInvokeActivity() |
Возвращает это действие в IInvokeActivity виде объекта или значение NULL, если это действие не является этим типом действия. |
AsMessageActivity() |
Возвращает это действие в IMessageActivity виде объекта или значение NULL, если это действие не является этим типом действия. |
AsMessageDeleteActivity() |
Возвращает это действие в IMessageDeleteActivity виде объекта или значение NULL, если это действие не является этим типом действия. |
AsMessageReactionActivity() |
Возвращает это действие в IMessageReactionActivity виде объекта или значение NULL, если это действие не является этим типом действия. |
AsMessageUpdateActivity() |
Возвращает это действие в IMessageUpdateActivity виде объекта или значение NULL, если это действие не является этим типом действия. |
AsSuggestionActivity() |
Возвращает это действие в ISuggestionActivity виде объекта или значение NULL, если это действие не является этим типом действия. |
AsTraceActivity() |
Возвращает это действие в ITraceActivity виде объекта или значение NULL, если это действие не является этим типом действия. |
AsTypingActivity() |
Возвращает это действие в ITypingActivity виде объекта или значение NULL, если это действие не является этим типом действия. |
CreateContactRelationUpdateActivity() |
Создает экземпляр класса в Activity виде IContactRelationUpdateActivity объекта . |
CreateConversationUpdateActivity() |
Создает экземпляр класса в Activity виде IConversationUpdateActivity объекта . |
CreateEndOfConversationActivity() |
Создает экземпляр класса в Activity виде IEndOfConversationActivity объекта . |
CreateEventActivity() |
Создает экземпляр класса в Activity виде IEventActivity объекта . |
CreateHandoffActivity() |
Создает экземпляр класса в Activity виде IHandoffActivity объекта . |
CreateInvokeActivity() |
Создает экземпляр класса в Activity виде IInvokeActivity объекта . |
CreateMessageActivity() |
Создает экземпляр класса в Activity виде IMessageActivity объекта . |
CreateReply(String, String) |
Создает новое действие сообщения в качестве ответа на это действие. |
CreateTrace(String, Object, String, String) |
Создает новое действие трассировки на основе этого действия. |
CreateTraceActivity(String, String, Object, String) |
Создает экземпляр класса в Activity виде ITraceActivity объекта . |
CreateTypingActivity() |
Создает экземпляр класса в Activity виде ITypingActivity объекта . |
GetChannelData<TypeT>() |
Получает данные канала для этого действия в виде строго типизированного объекта. |
GetConversationReference() |
Создает на ConversationReference основе этого действия. |
GetMentions() |
Разрешает упоминания из сущностей этого действия. |
GetReplyConversationReference(ResourceResponse) |
Создайте ConversationReference на основе сведений о беседе этого действия и ResourceResponse от отправки действия. |
HasContent() |
Указывает, содержит ли это действие содержимое. |
IsActivity(String) |
Указывает, имеет ли это действие указанный тип действия. |
IsFromStreamingConnection() |
Определите, было ли действие отправлено через http/https-подключение или потоковую передачу. Это можно определить, просмотрев свойство ServiceUrl: (1) Все каналы, которые отправляют сообщения через http/https, не являются потоковыми (2) Каналы, отправляющие сообщения через потоковую передачу, имеют ServiceUrl, который не начинается с http/https. |
TryGetChannelData<TypeT>(TypeT) |
Получает данные канала для этого действия в виде строго типизированного объекта. Возвращаемое значение определяет, успешно ли выполнена операция. |
Методы расширения
TeamsGetChannelId(IActivity) |
Возвращает идентификатор канала команды из текущего действия. |
TeamsGetMeetingInfo(IActivity) |
Возвращает объект TeamsMeetingInfo из текущего действия. |
TeamsGetSelectedChannelId(IActivity) |
Возвращает идентификатор канала, выбранного командой из текущего действия. |
TeamsGetTeamInfo(IActivity) |
Возвращает объект TeamsInfo из текущего действия. |
TeamsNotifyUser(IActivity) |
Настраивает текущее действие для создания уведомлений в Teams. |
TeamsNotifyUser(IActivity, Boolean, String) |
Настраивает текущее действие для создания уведомлений в Teams. |
MentionsId(IMessageActivity, String) |
Есть ли в свойстве Text упоминание идентификатора. |
MentionsRecipient(IMessageActivity) |
Есть ли упоминание о Recipient.Id в свойстве Text. |
RemoveMentionText(IMessageActivity, String) |
Удалите любой текст упоминания для заданного идентификатора из свойства Activity.Text. Например, если вы получите сообщение @echoBot Hi Bot, это приведет к удалению "@echoBot", оставив "Hi Bot". |
RemoveRecipientMention(IMessageActivity) |
Удаление текста упоминания получателя из свойства Text. Используйте с осторожностью, так как эта функция изменяет текст действия. |
GetLocale(IActivity) |
Возвращает языковой стандарт для действия. |
SetLocale(IActivity, String) |
Задает языковой стандарт для действия. |