MessagePatch

Данные дополнения к сообщению.

message MessagePatch {
    required string MessageId = 1;
    required sfixed64 TimestampTicks = 2;
    repeated Entity Entities = 3;
    optional bool ForDraft = 4 [default = false];
    optional bool DraftIsRecycled = 5 [default = false];
    repeated string DraftIsTransformedToMessageIdList = 6;
    optional bool DraftIsLocked = 7 [default = false];
    optional bool MessageIsDeleted = 8 [default = false];
    repeated EntityPatch EntityPatches = 9;
    optional bool MessageIsRestored = 10 [default = false];
    optional bool MessageIsDelivered = 11 [default = false];
    optional string DeliveredPatchId = 12;
    required string PatchId = 13;
    optional string NotDeliveredEventId = 14;
    required MessageType MessageType = 15;
}

message EntityPatch {
    required string EntityId = 1;
    optional bool DocumentIsDeleted = 2 [default = false];
    optional string MovedToDepartment = 3;
    optional bool DocumentIsRestored = 4 [default = false];
    optional bool ContentIsPatched = 5 [default = false];
    optional string ForwardedToBoxId = 6;
}

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

  • TimestampTicks — время создания дополнения.

  • Entities — список сущностей дополнения, представленных структурой Entity.

  • ForDraft — признак того, что сообщение, к которому относится текущее дополнение, является черновиком.

  • DraftIsRecycled — признак того, что черновик, к которому относится текущее дополнение, утилизирован: он либо был удален, либо на его основе было создано и отправлено полноценное сообщение. Заполняется только для дополнений, относящихся к черновикам.

  • DraftIsTransformedToMessageIdList — список идентификаторов сообщений, созданных на основе черновика, к которому относится текущее дополнение. Заполняется только для дополнений, относящихся к черновикам.

  • DraftIsLocked — признак того, что черновик, к которому относится текущее дополнение, заблокирован: в него нельзя добавлять или удалять документы. Такой черновик можно либо отправить, превратив в полноценное сообщение, либо удалить. Заполняется только для дополнений, относящихся к черновикам.

  • MessageIsDeleted — признак того, что сообщение, к которому относится текущее дополнение, было удалено.

  • EntityPatches — список дополнений к сущностям сообщения, к которому относится текущее дополнение. Каждый элемент списка представлен структурой EntityPatch с полями:

    • EntityId — идентификатор сущности, к которой относится текущее дополнение.

    • DocumentIsDeleted — признак того, что документ, к которому относится текущее дополнение, был удален.

    • MovedToDepartment — идентификатор подразделения, в которое был перемещен документ. Заполняется только в случае перемещения документа между подразделениями организации.

    • DocumentIsRestored — признак того, что документ, к которому относится текущее дополнение, был восстановлен из удаленных.

    • ContentIsPatched — признак того, что исходящий документ, к которому относится текущее дополнение, был подписан, и к содержимому документа были добавлены данные из сертификата подписанта.

    • ForwardedToBoxId — идентификатор ящика получателя при пересылке документа третьей стороне.

  • MessageIsRestored — признак того, что сообщение, к которому относится текущее дополнение, было восстановлено из удаленных.

  • MessageIsDelivered — признак того, что сообщение, к которому относится текущее дополнение, было доставлено получателю.

  • DeliveredPatchId — идентификатор дополнения, доставленного получателю.

  • PatchId — идентификатор дополнения.

  • NotDeliveredEventId — идентификатор дополнения, которое не удалось доставить (например, из-за некорректности одной или нескольких подписей в нем). Получить недоставленную часть сообщения можно с помощью метода GetEvent (V2) или GetEvent (V3), передав в качестве параметра eventId значение NotDeliveredEventId.

  • MessageType — тип сообщения, принимает значения из перечисления MessageType.

См. также

Структура используется: