CustomDocumentToSend

Объект представляет собой документ на отправку произвольного типа и является производным объектом от DocumentToSend

Свойства

  • Type (строка, чтение) - тип документа (возвращает строку “Document”)
  • Comment (строка, чтение/запись) - комментарий к документу
  • CustomDocumentId (строка, чтение/запись) - внешний идентификатор документа
  • FileName (строка, чтение) - имя файла вложения
  • NeedRecipientSignature (булево, чтение/запись) - флаг, обозначающий запрос подписи получателя под отправляемым документом
  • TypeNamedId (строка, чтение/запись) - строковой идентификатор типа документа. Доступные типы можно получить методом GetDocumentTypes
  • Function (строка, чтени/запись) - идентификатор функции документа. Обязательно при отправке зашифрованных документов
  • Version (строка, чтение/запись) - идентификатор версии документа. Обязательно при отправке зашифрованных документов
  • Metadata (коллекция объектов MetadataItem, чтение) - список пар вида “ключ-значение”, содержащих метаданные документа. Каждая пара задается структурой MetadataItem. Список доступных метаданных для типа можно получить через метод GetDocumentTypes
  • WorkflowId (строка, чтение/запись) - идентификатор вида документооборота. Список допустимых видов документооборота для типа можно получить через метод GetDocumentTypes. Описание видов документооборота доступно на странице DocumentWorkflow
  • IsEncrypted (булево, чтение/запись) - флаг, означающий, что документ передается в зашифрованном виде. Список версий, для которых поддерживается отправка в зашифрованном виде, можно взять из метода GetDocumentTypes
  • Content (объект производный от BaseContent, чтение) - объектное представление содержимого документа “любого типа”

Методы

  • AddMetadata - добавляет элемент метаданных в коллекцию Metadata