Expand description
Hammer’s operations, typed. Each function runs one operation, as crate::call would. A plugin may
call only those its manifest’s [permissions] ask for: each function’s documentation names what it needs.
Generated from api/operations.json by kotlin/codegen: regenerate rather than edit.
Modules§
- account
- The
accountoperations. - backup
- The
backupoperations. - draft
- The
draftoperations. - entry
- The
entryoperations. - export
- The
exportoperations. - idea
- The
ideaoperations. - image
- The
imageoperations. - note
- The
noteoperations. - ops
- The
opsoperations. - plugin
- The
pluginoperations. - project
- The
projectoperations. - scene
- The
sceneoperations. - stats
- The
statsoperations. - sync
- The
syncoperations. - tag
- The
tagoperations. - timeline
- The
timelineoperations.
Structs§
- Account
Status - Activity
- Appearance
- Archived
Scene - Archived
Scenes - Backup
- Backups
- Calendar
Dto - Chapter
Words - DayWords
- Device
Words - Draft
Applied - Draft
Info - Draft
Text - Drafts
- Entries
- Entry
- Entry
Count - Entry
Image Summary - Entry
Images - Entry
Summary - Even
Spacing Dto - Export
Format - Export
Formats - Exported
File - Idea
- Ideas
- Image
Content - Image
Deleted - Image
Summary - Image
User - Images
- Note
- Notes
- Operation
Descriptor - Operation
List - Paged
Scene - Plugin
List - Plugin
Summary - Project
Imported - Project
Info - Project
List - Project
Name - Project
Stats - Project
Summary - Project
Sync Status - Scene
Item Ref - Scene
Meta - Scene
Node - Scene
Page - Scene
Ref - Scene
Text - Scene
Tree - Scene
Word Count - Scene
Words - Scene
Write Result - Search
Hit - Search
Options - The optional inputs of
search; leave any out with..Default::default(). - Search
Results - Session
- Sessions
- Sync
Status - TagCount
- Tagged
Entities - Tagged
Entity - Tags
- Timeline
- Timeline
DefDeleted - Timeline
DefDto - Timeline
Entry - Timeline
Settings - Word
Goal
Enums§
- Access
- A value this kit doesn’t know, from a later Hammer, reads as
Access::Unknown. - Cadence
- A value this kit doesn’t know, from a later Hammer, reads as
Cadence::Unknown. - Calendar
Preset Dto - A value this kit doesn’t know, from a later Hammer, reads as
CalendarPresetDto::Unknown. - Entity
Kind - A value this kit doesn’t know, from a later Hammer, reads as
EntityKind::Unknown. - Entry
Kind - A value this kit doesn’t know, from a later Hammer, reads as
EntryKind::Unknown. - Image
User Kind - A value this kit doesn’t know, from a later Hammer, reads as
ImageUserKind::Unknown. - Import
File Format - A value this kit doesn’t know, from a later Hammer, reads as
ImportFileFormat::Unknown. - Markdown
Split - A value this kit doesn’t know, from a later Hammer, reads as
MarkdownSplit::Unknown. - Operation
Scope - A value this kit doesn’t know, from a later Hammer, reads as
OperationScope::Unknown. - RtfSplit
- A value this kit doesn’t know, from a later Hammer, reads as
RtfSplit::Unknown. - Scene
Kind - A value this kit doesn’t know, from a later Hammer, reads as
SceneKind::Unknown. - Search
Filter - A value this kit doesn’t know, from a later Hammer, reads as
SearchFilter::Unknown. - Timeline
Kind Dto - A value this kit doesn’t know, from a later Hammer, reads as
TimelineKindDto::Unknown. - Timeline
Mode Dto - A value this kit doesn’t know, from a later Hammer, reads as
TimelineModeDto::Unknown. - Write
Mode - A value this kit doesn’t know, from a later Hammer, reads as
WriteMode::Unknown.
Functions§
- search
- Search a project’s scenes, notes, encyclopedia, and timeline. #tag in the query filters by tag.