Поделиться через


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
Реализации

Комментарии

Класс Activity содержит все свойства, которые могут содержать отдельные, более конкретные действия. Это тип супермножества.

Конструкторы

Activity()

Инициализирует новый экземпляр класса Activity.

Activity(String, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, String, String, ChannelAccount, ConversationAccount, ChannelAccount, String, String, IList<ChannelAccount>, IList<ChannelAccount>, IList<MessageReaction>, IList<MessageReaction>, String, Nullable<Boolean>, String, String, String, String, String, SuggestedActions, IList<Attachment>, IList<Entity>, Object, String, String, String, String, Object, String, ConversationReference, String, Nullable<DateTimeOffset>, String, String, IList<String>, IList<TextHighlight>, SemanticAction, String)

Инициализирует новый экземпляр класса Activity.

Поля

ContentType

Заголовок сущности HTTP Content-Type, определяющий ресурс типа носителя Activity.

Свойства

Action

Возвращает или задает строку, указывающую, был ли получатель контактаRelationUpdate добавлен или удален из списка контактов отправителя.

AttachmentLayout

Возвращает или задает указание макета для нескольких вложений. По умолчанию: список. Возможные значения определяются AttachmentLayoutTypes.

Attachments

Возвращает или задает вложения для действия.

CallerId

Возвращает или задает строку, содержащую IRI, определяющую вызывающий бот. Это поле не предназначено для передачи по проводу, но вместо этого заполняется ботами и клиентами на основе криптографически проверяемых данных, которые утверждают удостоверение вызывающих лиц (например, токены).

ChannelData

Возвращает или задает содержимое для конкретного канала.

ChannelId

Возвращает или задает идентификатор, который однозначно идентифицирует канал. Задан каналом.

Code

Возвращает или задает код для действий endOfConversation, указывающих, почему беседа закончилась. Возможные значения определяются в EndOfConversationCodes.

Conversation

Возвращает или задает беседу, к которой относится действие.

DeliveryMode

Возвращает или задает подсказку доставки, чтобы сообщить получателю альтернативные пути доставки для действия. Режим доставки по умолчанию — "по умолчанию". Возможные значения определяются в 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. Например, Америка/Los_Angeles.

MembersAdded

Возвращает или задает коллекцию элементов, добавленных в беседу.

MembersRemoved

Возвращает или задает коллекцию элементов, удаленных из беседы.

Name

Возвращает или задает имя операции, связанной с действием вызова или события.

Properties

Возвращает или задает свойства, не определенные типом Activity, но которые могут отображаться в сериализованном объекте REST JSON.

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", "typeing", "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 из текущего действия.

TeamsGetTeamOnBehalfOf(IActivity)

Возвращает список Teams OnBehalfOf из текущего действия.

TeamsNotifyUser(IActivity, Boolean, String)

Настраивает текущее действие для создания уведомления в Teams.

TeamsNotifyUser(IActivity)

Настраивает текущее действие для создания уведомления в Teams.

MentionsId(IMessageActivity, String)

Существует ли упоминание идентификатора в текстовом свойстве.

MentionsRecipient(IMessageActivity)

Существует ли упоминание о Recipient.Id в текстовом свойстве.

RemoveMentionText(IMessageActivity, String)

Удалите любой текст упоминания для заданного идентификатора из свойства Activity.Text. Например, учитывая сообщение @echoBot Hi Bot, это приведет к удалению "@echoBot", оставив "Hi Bot".

RemoveRecipientMention(IMessageActivity)

Удаление текста упоминания получателя из свойства Text. Используйте с осторожностью, так как эта функция изменяет текст действия.

GetLocale(IActivity)

Возвращает языковой стандарт для действия.

SetLocale(IActivity, String)

Задает языковой стандарт для действия.

Применяется к