TheAnachronism/docspell
1
0
Fork 0
mirror of https://github.com/TheAnachronism/docspell.git synced 2025-06-22 02:18:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2369 from madduck/2345-docs

Browse Source 
Add documentation for #2362
This commit is contained in:
eikek
2023-11-12 13:23:16 +01:00
committed by GitHub
parent f6bd97a86b d26f1d29c7
commit fe72fbee8a
2 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
website/site/content/docs/addons/writing.md
View File

@ -162,8 +162,8 @@ You find the complete structure below. It consists of these parts:
- `newItems`: declares files relative to `OUTPUT_DIR` that should be - `newItems`: declares files relative to `OUTPUT_DIR` that should be
processed as new uploads processed as new uploads
The `commands` allows to set tags, fields and other things. All parts The `commands` allows to set the item date, tags, fields and other things. All
are optional, you don't need to return the complete structure. Just parts are optional, you don't need to return the complete structure. Just
returning `commands` or only `files` is ok. returning `commands` or only `files` is ok.
**Example** **Example**

2
website/src/main/scala/docspell/website/AddonOutputExample.scala
View File

@ -5,6 +5,7 @@ import docspell.addons.out.{AddonOutput, ItemFile, NewFile, NewItem}
import docspell.addons.out.NewFile.{Meta => FileMeta} import docspell.addons.out.NewFile.{Meta => FileMeta}
import docspell.addons.out.NewItem.{Meta => ItemMeta} import docspell.addons.out.NewItem.{Meta => ItemMeta}
import docspell.common._ import docspell.common._
import docspell.common.Timestamp
import docspell.common.bc.{AttachmentAction, BackendCommand, ItemAction} import docspell.common.bc.{AttachmentAction, BackendCommand, ItemAction}
import io.circe.syntax._ import io.circe.syntax._
@ -15,6 +16,7 @@ object AddonOutputExample extends Helper {
BackendCommand.ItemUpdate( BackendCommand.ItemUpdate(
itemId = id("XabZ-item-id"), itemId = id("XabZ-item-id"),
actions = List( actions = List(
ItemAction.SetDate(Timestamp.ofMillis(1699697471000L)),
ItemAction.AddTags(Set("tag1", "tag2")), ItemAction.AddTags(Set("tag1", "tag2")),
ItemAction.ReplaceTags(Set("tagX", "tagY")), ItemAction.ReplaceTags(Set("tagX", "tagY")),
ItemAction.RemoveTags(Set("tag0", "tag9")), ItemAction.RemoveTags(Set("tag0", "tag9")),