PatchTask
Задание для изменения состояния документа.
Создаётся методом Box.CreatePatchTask()
Добавлено в версии 5.43.0.
Свойства
- PatchesToSend:
Коллекция объектов PatchToSend , чтение — коллекция патчей, разбитых по сообщениям, в которых лежат документы
Методы
- PatchTask.AddToPatch(Documents, Action)
- Documents:
Произвольный тип — документы, для которых будет применён патч
- Action:
Строка — действие, применяемое к документам. Возможные значения
Добавляет документ или документы в задание по изменению их состояния. Documents может быть одним из следующих объектов:
DocumentBase . В этом случае
будет проверено лежит ли документ в черновиках. Если да, то действие будет применено к каждому документу этого черновика,
будет проверено лежит ли документ в закрытом пакете. Если да, то действие будет применено к каждому документу этого пакета,
если предыдущие условия не выполнены, то действие будет применено только к этому документу.
ValueCollection из DocumentBase. В этом случае для каждого документа коллекции будет применена логика для DocumentBase.
DocumentPackage. В этом случае действие будет применено к каждого документу внутри пакета.
Возвращает ValueCollection из PatchItem — коллекцию объектов, в которых можно заполнить данные патча и документа, к которому этот патч относится.
Если ни для одного документа указанное действие Action не применимо, то вернётся пустая коллекция, новых данных в PatchesToSend не будет добавлено.
Примечание
Если логикой интеграции предполагается, что действие будет применено для DocumentPackage, то следует передавать его — не будет лишних проверок, а в случае с закрытым пакетом и черовиками не будет лишних запросов к Диадок
- PatchTask.Send()
Отправляет патчи. Возвращает Коллекцию из PatchResult
- PatchTask.SendAsync()
Отправляет патчи. Возвращает AsyncResult с коллекцией из PatchResult в качестве результата