Предупреждение

Прекращение развития и поддержки Компоненты

С 1 сентября 2026 года команда разработки прекращает развитие и техническую поддержку Компоненты.

Сама библиотека продолжит работать в текущем виде без каких-либо ограничений со стороны компании, но новая функциональность разрабатываться не будет. Прекратится техническая поддержка со стороны команды разработки: консультации, исправление ошибок и адаптация под изменения внешних систем.

Ключи, выпускаемые через кабинет интегратора, не подходят для использования в Компоненте.

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

BoxEvent

Информация о событии, произошедшем с документом

Свойства

CounteragentId:

Строка, чтение — идентификатор контрагента

EventId:

Строка, чтение — идентификатор события

DocumentType:

Строка, чтение — тип документа

DocumentId:

Строка, чтение — идентификатор документа

DocumentDirection:

Строка, чтение — направление документа. Возможные значения

EventType:

Строка, чтение — тип события. Возможные значения

Timestamp:

Дата и время, чтение — дата и время события в текущем часовом поясе

IndexKey:

Строка, чтение — информация, которую можно указать в новом фильтре событий документов для продолжения чтения ленты

Добавлено в версии 5.57.0.

Методы

BoxEvent.GetDocument()

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

BoxEvent.GetFileContent(FilePath)
FilePath:

Строка — путь до файла, в который будет сохранён контент

Сохраняет содержимое события на диск и возвращает строку с именем документа в Диадок

BoxEvent.GetSignatureContent(FilePath)
FilePath:

Строка — путь до файла, в который будет сохранён контент подписи

Сохраняет контент подписи документа на диск и возвращает строку с именем документа в Диадок