Skip to main content

Module ops

Module ops 

Source
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 account operations.
backup
The backup operations.
draft
The draft operations.
entry
The entry operations.
export
The export operations.
idea
The idea operations.
image
The image operations.
note
The note operations.
ops
The ops operations.
plugin
The plugin operations.
project
The project operations.
scene
The scene operations.
stats
The stats operations.
sync
The sync operations.
tag
The tag operations.
timeline
The timeline operations.

Structs§

AccountStatus
Activity
Appearance
ArchivedScene
ArchivedScenes
Backup
Backups
CalendarDto
ChapterWords
DayWords
DeviceWords
DraftApplied
DraftInfo
DraftText
Drafts
Entries
Entry
EntryCount
EntryImageSummary
EntryImages
EntrySummary
EvenSpacingDto
ExportFormat
ExportFormats
ExportedFile
Idea
Ideas
ImageContent
ImageDeleted
ImageSummary
ImageUser
Images
Note
Notes
OperationDescriptor
OperationList
PagedScene
PluginList
PluginSummary
ProjectImported
ProjectInfo
ProjectList
ProjectName
ProjectStats
ProjectSummary
ProjectSyncStatus
SceneItemRef
SceneMeta
SceneNode
ScenePage
SceneRef
SceneText
SceneTree
SceneWordCount
SceneWords
SceneWriteResult
SearchHit
SearchOptions
The optional inputs of search; leave any out with ..Default::default().
SearchResults
Session
Sessions
SyncStatus
TagCount
TaggedEntities
TaggedEntity
Tags
Timeline
TimelineDefDeleted
TimelineDefDto
TimelineEntry
TimelineSettings
WordGoal

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.
CalendarPresetDto
A value this kit doesn’t know, from a later Hammer, reads as CalendarPresetDto::Unknown.
EntityKind
A value this kit doesn’t know, from a later Hammer, reads as EntityKind::Unknown.
EntryKind
A value this kit doesn’t know, from a later Hammer, reads as EntryKind::Unknown.
ImageUserKind
A value this kit doesn’t know, from a later Hammer, reads as ImageUserKind::Unknown.
ImportFileFormat
A value this kit doesn’t know, from a later Hammer, reads as ImportFileFormat::Unknown.
MarkdownSplit
A value this kit doesn’t know, from a later Hammer, reads as MarkdownSplit::Unknown.
OperationScope
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.
SceneKind
A value this kit doesn’t know, from a later Hammer, reads as SceneKind::Unknown.
SearchFilter
A value this kit doesn’t know, from a later Hammer, reads as SearchFilter::Unknown.
TimelineKindDto
A value this kit doesn’t know, from a later Hammer, reads as TimelineKindDto::Unknown.
TimelineModeDto
A value this kit doesn’t know, from a later Hammer, reads as TimelineModeDto::Unknown.
WriteMode
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.