|
<< Click to Display Table of Contents >> Объектная модель > Базовое решение Directum RX > Exchange – электронный обмен Клиентские функции модуля Exchange |
|
|
<< Click to Display Table of Contents >> Объектная модель > Базовое решение Directum RX > Exchange – электронный обмен Клиентские функции модуля Exchange |
|
Имя функции |
Модификатор |
Атрибут |
Описание |
static |
– |
Создать QueueItem |
|
static |
– |
Перегенерировать Public Body |
|
static |
– |
Получить сертификат сервиса обмена для текущего сотрудника, используя системный диалог выбора сертификата |
|
virtual |
– |
Получить сообщение об ошибке при блокировке сведения о документе обмена |
|
virtual |
– |
Получить сообщение об ошибке при блокировке документа |
|
static |
– |
Запустить фоновый процесс "Электронный обмен. Получение сообщений" |
|
virtual |
[Public] |
Получить сертификат сервиса обмена для сотрудника, используя системный диалог выбора сертификата |
|
static |
[Public] |
Отправить уведомление об уточнении документа |
|
virtual |
– |
Отправить уведомление об уточнении документа |
|
virtual |
– |
Отправка ответа контрагенту |
|
virtual |
[Public] |
Отправить извещение о получении документа |
|
SendDocumentToCounterparty + перегрузки |
virtual |
– |
Отправка последней версии документа контрагенту |
virtual |
– |
Отправить ответ по документу и приложениям контрагенту |
|
SendResultToCounterparty + перегрузки |
virtual |
[Public] |
Отправка документа, либо ответа контрагенту |
virtual |
[Public] |
Отправить извещения о получении документа |
|
SignBeforeSendDocumentToCounterparty + перегрузки |
virtual |
– |
Подписать документ и его приложений перед отправкой контрагенту |
TryRejectCounterpartyVersion + перегрузки |
virtual |
– |
Попытаться отказать контрагенту по первой версии, когда отправляем вторую |
virtual |
– |
Провалидировать параметры перед отправкой ответа контрагенту |
|
virtual |
– |
Провалидировать параметры перед отправкой документа контрагенту |
Создать QueueItem.
Синтаксис
public static void CreateQueueItem(string businessUnitBoxId, string messageId)
Параметры
businessUnitBoxId – ИД абонентского ящика;
messageId – ИД сообщения.
Перегенерировать Public Body.
Синтаксис
public static void GeneratePublicBody(string documentId)
Параметры
documentId – ИД документа.
GetCurrentUserExchangeCertificate
Получить сертификат сервиса обмена для текущего сотрудника, используя системный диалог выбора сертификата.
Синтаксис
public static ICertificate GetCurrentUserExchangeCertificate(ExchangeCore.IBoxBase box, Company.IEmployee employee)
Параметры
box – Абонентский ящик;
employee – Сотрудник.
Возвращаемое значение
ICertificate – Сертификат.
Получить сообщение об ошибке при блокировке сведения о документе обмена.
Синтаксис
public virtual string GetDocumentInfoLockedError(IExchangeDocumentInfo documentInfo)
Параметры
documentInfo – Сведения о документе обмена.
Возвращаемое значение
string – Сообщение об ошибке или пустая строка, если ошибок нет.
Получить сообщение об ошибке при блокировке документа.
Синтаксис
public virtual string GetDocumentLockedError(Docflow.IOfficialDocument document)
Параметры
document – Документ.
Возвращаемое значение
string – Сообщение об ошибке или пустая строка, если ошибок нет.
Запустить фоновый процесс "Электронный обмен. Получение сообщений".
Синтаксис
[LocalizeFunction("GetMessagesFunctionName", "GetMessagesFunctionDescription")]
public static void GetMessages()
Получить сертификат сервиса обмена для сотрудника, используя системный диалог выбора сертификата.
Синтаксис
[Public]
public virtual ICertificate GetUserExchangeCertificate(ExchangeCore.IBoxBase box, Company.IEmployee employee)
Параметры
box – Абонентский ящик;
employee – Сотрудник.
Возвращаемое значение
ICertificate – Сертификат.
Отправить уведомление об уточнении документа.
Синтаксис
[Public]
public static string SendAmendmentRequest(List<Docflow.IOfficialDocument> documents, Parties.ICounterparty receiver, string note, bool throwError, ExchangeCore.IBoxBase box, ICertificate certificate, bool isInvoiceAmendmentRequest)
Параметры
documents – Документы;
receiver – Получатель;
note – Комментарий;
throwError – Не гасить ошибку;
box – Абонентский ящик;
certificate – Сертификат для подписания УОУ;
isInvoiceAmendmentRequest – True для УОУ, False для отказа.
Возвращаемое значение
string – Строка с ошибкой отправки уведомления. Пусто - если отправка успешная.
SendAmendmentRequestToCounterparty
Отправить уведомление об уточнении документа.
Синтаксис
public virtual bool SendAmendmentRequestToCounterparty(Docflow.IOfficialDocument document, List<Docflow.IOfficialDocument> selectedAddenda, Parties.ICounterparty counterparty, ExchangeCore.IBusinessUnitBox box, string comment, string signResult, CommonLibrary.BaseInputDialogEventArgs args)
Параметры
document – Документ;
selectedAddenda – Выбранные приложения;
counterparty – Контрагент;
box – Абонентский ящик;
comment – Комментарий к сообщению в сервисе;
signResult – Результат, который будет отправлен контрагенту;
args – Аргументы события диалога.
Возвращаемое значение
bool – True - если отправка успешная. Иначе - false.
Отправка ответа контрагенту.
Синтаксис
public virtual void SendAnswerToCounterparty(Docflow.IOfficialDocument document, Sungero.Exchange.Structures.Module.SendToCounterpartyInfo documentInfo, List<Docflow.IOfficialDocument> addenda)
Параметры
document – Документ, по которому требуется отправка ответа;
documentInfo – Информация о документе, связанная с коммуникацией с контрагентом;
addenda – Приложения.
Отправить извещение о получении документа.
Синтаксис
[Public]
public virtual string SendDeliveryConfirmation(ExchangeCore.IBoxBase box, ICertificate certificate, bool bulkMode)
Параметры
box – Абонентский ящик;
certificate – Сертификат для подписания ИОП;
bulkMode – Режим для большой нагрузки.Если true - будут выполняться генерации ИОП в сервисе обмена и подписываться все доступные ИОП-ы.Если false - только одна пачка ИОП будет подписана, если совсем нечего подписывать - будет сгенерирована.
Возвращаемое значение
string – Строка с ошибкой отправки извещения. Пусто - если отправка успешная.
Отправка последней версии документа контрагенту.
Перегрузки
Имя функции |
Описание |
Отправка последней версии документа контрагенту |
|
Отправить документ и приложения контрагенту |
SendDocumentToCounterparty (Docflow.IOfficialDocument document, Sungero.Exchange.Structures.Module.SendToCounterpartyInfo documentInfo, ExchangeCore.IExchangeService service, List<Docflow.IOfficialDocument> addenda)
Отправка последней версии документа контрагенту.
Синтаксис
public virtual void SendDocumentToCounterparty(Docflow.IOfficialDocument document, Sungero.Exchange.Structures.Module.SendToCounterpartyInfo documentInfo, ExchangeCore.IExchangeService service, List<Docflow.IOfficialDocument> addenda)
Параметры
document – Документ для отправки;
documentInfo – Информация о документе, связанная с коммуникацией с контрагентом;
service – Сервис обмена;
addenda – Приложения.
SendDocumentToCounterparty (Docflow.IOfficialDocument document, Sungero.Exchange.Structures.Module.SendToCounterpartyInfo documentInfo, List<Docflow.IOfficialDocument> selectedAddenda, Parties.ICounterparty counterparty, ExchangeCore.ICounterpartyDepartmentBox counterpartyDepartmentBox, ExchangeCore.IBusinessUnitBox box, ICertificate certificate, bool needSign, string comment)
Отправить документ и приложения контрагенту.
Синтаксис
public virtual string SendDocumentToCounterparty(Docflow.IOfficialDocument document, Sungero.Exchange.Structures.Module.SendToCounterpartyInfo documentInfo, List<Docflow.IOfficialDocument> selectedAddenda, Parties.ICounterparty counterparty, ExchangeCore.ICounterpartyDepartmentBox counterpartyDepartmentBox, ExchangeCore.IBusinessUnitBox box, ICertificate certificate, bool needSign, string comment)
Параметры
document – Документ для отправки;
documentInfo – Информация о документе, связанная с коммуникацией с контрагентом;
selectedAddenda – Выбранные приложения;
counterparty – Контрагент;
counterpartyDepartmentBox – Абонентский ящик подразделения контрагента;
box – Аб. ящик нашей организации;
certificate – Сертификат, которым подписаны документы;
needSign – Требовать подписание от контрагента;
comment – Комментарий к сообщению в сервисе.
Возвращаемое значение
string – Сообщение об ошибке или пустая строка, если ошибок нет.
Отправить ответ по документу и приложениям контрагенту.
Синтаксис
public virtual bool SendReplySignToCounterparty(Docflow.IOfficialDocument document, List<Docflow.IOfficialDocument> selectedAddenda, Parties.ICounterparty counterparty, ExchangeCore.IBusinessUnitBox box, ICertificate certificate, CommonLibrary.BaseInputDialogEventArgs args)
Параметры
document – Документ;
selectedAddenda – Выбранные приложения;
counterparty – Контрагент;
box – Аб. ящик нашей организации;
certificate – Сертификат, которым подписаны документы;
args – Аргументы события диалога.
Возвращаемое значение
bool – True - если отправка успешная. Иначе - false.
Отправка документа, либо ответа контрагенту.
Перегрузки
Имя функции |
Описание |
SendResultToCounterparty (Docflow.IOfficialDocument document) |
Отправка документа, либо ответа контрагенту |
Отправка документа, либо ответа контрагенту с учетом выбранного сервиса обмена и приложений в задаче на согласование |
SendResultToCounterparty (Docflow.IOfficialDocument document)
Отправка документа, либо ответа контрагенту.
Синтаксис
[Public]
public virtual void SendResultToCounterparty(Docflow.IOfficialDocument document)
Параметры
document – Документ, по которому требуется отправка ответа или отправка самого документа.
SendResultToCounterparty (Docflow.IOfficialDocument document, ExchangeCore.IExchangeService service, List<Docflow.IOfficialDocument> addenda)
Отправка документа, либо ответа контрагенту с учетом выбранного сервиса обмена и приложений в задаче на согласование.
Синтаксис
[Public]
public virtual void SendResultToCounterparty(Docflow.IOfficialDocument document, ExchangeCore.IExchangeService service, List<Docflow.IOfficialDocument> addenda)
Параметры
document – Документ, по которому требуется отправка ответа или отправка самого документа;
service – Сервис обмена;
addenda – Приложения.
SignAndSendDeliveryConfirmation
Отправить извещения о получении документа.
Синтаксис
[Public, LocalizeFunction("SignAndSendDeliveryConfirmationFunctionName", "")]
public virtual void SignAndSendDeliveryConfirmation()
SignBeforeSendDocumentToCounterparty
Подписать документ и его приложений перед отправкой контрагенту.
Перегрузки
Имя функции |
Описание |
Подписать документ и его приложений перед отправкой контрагенту |
|
Подписать документ и его приложений перед отправкой контрагенту |
SignBeforeSendDocumentToCounterparty (Docflow.IOfficialDocument document, Sungero.Exchange.Structures.Module.SendToCounterpartyInfo documentInfo, List<Docflow.IOfficialDocument> selectedAddenda, ICertificate certificate, bool isSendAswer)
Подписать документ и его приложений перед отправкой контрагенту.
Синтаксис
public virtual string SignBeforeSendDocumentToCounterparty(Docflow.IOfficialDocument document, Sungero.Exchange.Structures.Module.SendToCounterpartyInfo documentInfo, List<Docflow.IOfficialDocument> selectedAddenda, ICertificate certificate, bool isSendAswer)
Параметры
document – Документ для отправки;
documentInfo – Информация о документе, связанная с коммуникацией с контрагентом;
selectedAddenda – Выбранные приложения;
certificate – Сертификат, которым подписаны документы;
isSendAswer – Признак, что отправляется ответ по документу.
Возвращаемое значение
string – Сообщение об ошибке или пустая строка, если ошибок нет.
SignBeforeSendDocumentToCounterparty (Docflow.IOfficialDocument document, Sungero.Exchange.Structures.Module.SendToCounterpartyInfo documentInfo, List<Docflow.IOfficialDocument> selectedAddenda, Parties.ICounterparty counterparty, ExchangeCore.IBusinessUnitBox box, ICertificate certificate)
Подписать документ и его приложений перед отправкой контрагенту.
Синтаксис
[Obsolete("Используйте метод SignBeforeSendDocumentToCounterparty с параметром, что отправляется ответ по документу.")]
public virtual string SignBeforeSendDocumentToCounterparty(Docflow.IOfficialDocument document, Sungero.Exchange.Structures.Module.SendToCounterpartyInfo documentInfo, List<Docflow.IOfficialDocument> selectedAddenda, Parties.ICounterparty counterparty, ExchangeCore.IBusinessUnitBox box, ICertificate certificate)
Параметры
document – Документ для отправки;
documentInfo – Информация о документе, связанная с коммуникацией с контрагентом;
selectedAddenda – Выбранные приложения;
counterparty – Контрагент;
box – Аб. ящик нашей организации;
certificate – Сертификат, которым подписаны документы.
Возвращаемое значение
string – Сообщение об ошибке или пустая строка, если ошибок нет.
Попытаться отказать контрагенту по первой версии, когда отправляем вторую.
Перегрузки
Имя функции |
Описание |
Попытаться отказать контрагенту по первой версии, когда отправляем вторую |
TryRejectCounterpartyVersion (Docflow.IOfficialDocument document, Sungero.Exchange.Structures.Module.SendToCounterpartyInfo documentInfo, List<Docflow.IOfficialDocument> selectedAddenda, Parties.ICounterparty counterparty, ExchangeCore.ICounterpartyDepartmentBox counterpartyDepartmentBox, ExchangeCore.IBusinessUnitBox box, ICertificate certificateToRejectFirstVersion)
Попытаться отказать контрагенту по первой версии, когда отправляем вторую.
Синтаксис
public virtual void TryRejectCounterpartyVersion(Docflow.IOfficialDocument document, Sungero.Exchange.Structures.Module.SendToCounterpartyInfo documentInfo, List<Docflow.IOfficialDocument> selectedAddenda, Parties.ICounterparty counterparty, ExchangeCore.ICounterpartyDepartmentBox counterpartyDepartmentBox, ExchangeCore.IBusinessUnitBox box, ICertificate certificateToRejectFirstVersion)
Параметры
document – Документ для отправки;
documentInfo – Информация о документе, связанная с коммуникацией с контрагентом;
selectedAddenda – Выбранные приложения;
counterparty – Контрагент;
counterpartyDepartmentBox – Абонентский ящик подразделения контрагента;
box – Аб. ящик нашей организации;
certificateToRejectFirstVersion – Сертификат.
ValidateBeforeSendAnswerToCounterparty
Провалидировать параметры перед отправкой ответа контрагенту.
Синтаксис
public virtual string ValidateBeforeSendAnswerToCounterparty(Docflow.IOfficialDocument document, Sungero.Exchange.Structures.Module.SendToCounterpartyInfo documentInfo, List<Docflow.IOfficialDocument> selectedAddenda, Parties.ICounterparty counterparty, IUser signatureOwner, ExchangeCore.IBusinessUnitBox box, string comment, string signResult)
Параметры
document – Документ;
documentInfo – Информация о документе, связанная с коммуникацией с контрагентом;
selectedAddenda – Выбранные приложения;
counterparty – Контрагент;
signatureOwner – Подписал;
box – Аб. ящик нашей организации;
comment – Комментарий к сообщению в сервисе;
signResult – Результат, который будет отправлен контрагенту.
Возвращаемое значение
string – Сообщение об ошибке или пустая строка, если ошибок нет.
ValidateBeforeSendDocumentToCounterparty
Провалидировать параметры перед отправкой документа контрагенту.
Синтаксис
public virtual string ValidateBeforeSendDocumentToCounterparty(Docflow.IOfficialDocument document, Sungero.Exchange.Structures.Module.SendToCounterpartyInfo documentInfo, List<Docflow.IOfficialDocument> selectedAddenda, Parties.ICounterparty counterparty, IUser signatureOwner, ExchangeCore.IBusinessUnitBox box)
Параметры
document – Документ для отправки;
documentInfo – Информация о документе, связанная с коммуникацией с контрагентом;
selectedAddenda – Выбранные приложения;
counterparty – Контрагент;
signatureOwner – Подписал;
box – Аб. ящик нашей организации.
Возвращаемое значение
string – Сообщение об ошибке или пустая строка, если ошибок нет.
| © Компания Directum, 2024 |