Доступна более новая версия документации данного модуля.

См. последнюю версию

IMessageService — интерфейс

Интерфейс IMessageService определяет методы, которые должен реализовывать компонент сервиса сообщений.

  • Пространство имен: DocsVision.Edi.Interfaces

  • Сборка: DocsVision.Edi.Interfaces.dll

Синтаксис

public interface IMessageService

Методы

Имя Описание

EventExists(String, String)

Проверяет наличие события с указанным идентификатором в ящике организации. Возвращает True, если событие есть.

Тип возвращаемого значения: Boolean.

Параметры:

  • boxId — идентификатор ящика организации.

  • eventId — идентификатор события.

В стандартной конфигурации модуля метод вызывается при получении новых сообщений от оператора ЭДО.

GenerateCorrectionRequest(String, String, String, X509Certificate2, String, String)

Формирует запрос на уточнение.

Тип возвращаемого значения: MessageFile.

Параметры:

  • boxId — идентификатор ящика организации.

  • messageId — идентификатор сообщения у оператора обмена.

  • entityId — идентификатор сущности у оператора ЭДО, по которому отправляется запрос на уточнение.

  • certificate — сертификат, которым подписывается запрос.

  • positionName — должность подписывающего запрос сотрудника.

  • comment — комментарий к запросу.

В стандартной конфигурации модуля метод вызывается, когда пользователь запрашивает уточнение по поступившему документу.

GenerateInvoiceReceipt(String, String, String, X509Certificate2, String)

Формирует ответную подпись на полученный документ.

Тип возвращаемого значения: MessageFile.

Параметры:

  • boxId — идентификатор ящика организации.

  • messageId — идентификатор сообщения у оператора обмена.

  • entityId — идентификатор сущности у оператора ЭДО, извещение о получении которой отправляется.

  • certificate — сертификат, которым подписывается извещение.

  • positionName — должность подписывающего извещение сотрудника.

В стандартной конфигурации модуля метод вызывается, когда пользователь вызывает функцию отправки извещения.

GenerateInvoiceReply(String, String, String, X509Certificate2, String, String)

Формирует ответную подпись для поступившего документа.

Тип возвращаемого значения: MessageFile.

Параметры:

  • boxId — идентификатор ящика организации.

  • messageId — идентификатор сообщения у оператора обмена.

  • entityId — идентификатор сущности у оператора ЭДО, по которой формируется подпись.

  • certificate — сертификат, которым подписывается запрос.

  • documentType — тип документа.

  • replyData — содержимое ответа.

В стандартной конфигурации модуля метод вызывается, когда пользователь подписывает поступивший документ.

GenerateRevocationRequest(String, String, String, X509Certificate2, String, String)

Формирует запрос на аннулирование.

Тип возвращаемого значения: MessageFile.

Параметры:

  • boxId — идентификатор ящика организации.

  • messageId — идентификатор сообщения у оператора обмена.

  • entityId — идентификатор сущности у оператора ЭДО, по которому отправляется запрос на аннулирование.

  • certificate — сертификат, которым подписывается запрос.

  • positionName — должность подписывающего запрос сотрудника.

  • comment — комментарий к запросу.

В стандартной конфигурации модуля метод вызывается, когда пользователь запрашивает аннулирование.

GenerateSignatureRejection(String, String, String, X509Certificate2, String, String)

Формирует отказ в подписании.

Тип возвращаемого значения: MessageFile.

Параметры:

  • boxId — идентификатор ящика организации.

  • messageId — идентификатор сообщения у оператора обмена.

  • entityId — идентификатор сущности у оператора ЭДО, по которому отправляется отказ в подписании.

  • certificate — сертификат, которым подписывается ответ.

  • positionName — должность подписывающего запрос сотрудника.

  • comment — комментарий к отказу.

В стандартной конфигурации модуля метод вызывается, когда пользователь отказывает в подписании поступившего документа.

GetLastEventId(String)

Возвращает идентификатор последнего события в ящике организации.

Тип возвращаемого значения: String.

Параметры:

  • boxId — идентификатор ящика организации.

В стандартной конфигурации модуля метод используется при активации ящика организации.

GetNewEvents(String, String, DateTime?)

Получает новые события из ящика организации.

Тип возвращаемого значения: ItemCollection<MessageData>.

Параметры:

  • boxId — идентификатор ящика организации.

  • lastEventId — идентификатор последнего полученного события (может отсутствовать).

  • fromDate — дата минимальная дата создания сообщения. Если значение указано, то должны возвращаться сообщения, созданные после указанной даты.

В стандартной конфигурации модуля метод вызывается при получении новых сообщений от оператора ЭДО.

GetNewEventsCount(String, String)

Возвращает количество новых событий.

Тип возвращаемого значения: Int32.

Параметры:

  • boxId — идентификатор ящика организации.

  • lastEventId — идентификатор последнего полученного события (может отсутствовать).

В стандартной конфигурации модуля метод вызывается при активации ящика организации.

Initialize(Dictionary<String, String>)

Инициализирует компонент.

Параметры:

  • settings — коллекция настроек оператора ЭДО из Справочника настроек операторов ЮЗДО. Каждая запись содержит ключ и значение, например: Login и Docsvision@diadoc.ru.

SendCorrection(MessageData)

Отправляет запрос на уточнение.

Параметры:

  • messageData — сообщение типа MessageData, содержащее запрос на уточнение.

В стандартной конфигурации модуля метод используется отправке новых сообщений оператору ЭДО.

SendMessage(MessageData)

Отправляет новое сообщение оператору ЭДО.

Параметры:

  • messageData — сообщение типа MessageData.

В стандартной конфигурации модуля метод используется отправке новых сообщений оператору ЭДО.

SendReceipt(MessageData)

Отправляет квитанцию.

Параметры:

  • messageData — сообщение типа MessageData.

SendRevocation(MessageData)

Отправляет запрос на аннулирование.

Параметры:

  • messageData — сообщение типа MessageData, содержащее запрос на аннулирование

В стандартной конфигурации модуля метод используется отправке новых сообщений оператору ЭДО.

SendSignatureReply(MessageData)

Отправляет ответную подпись на полученное сообщение.

Параметры:

  • messageData — сообщение типа MessageData.

В стандартной конфигурации модуля метод используется при отправке оператору ЭДО ответа на полученное сообщение.