package anki.collection

Get desktop application:
View/edit binary Protocol Buffers messages

Implicitly includes any of the above methods that are not listed in the backend service.

• rpc OpenCollection (OpenCollectionRequest, generic.Empty)

  collection.proto:28

  message OpenCollectionRequest

  collection.proto:42

  • string collection_path = 1

  • string media_folder_path = 2

  • string media_db_path = 3

• rpc CloseCollection (CloseCollectionRequest, generic.Empty)

  collection.proto:29

  message CloseCollectionRequest

  collection.proto:48

  • bool downgrade_to_schema11 = 1

• rpc CreateBackup (CreateBackupRequest, generic.Bool)

  collection.proto:34

  Create a no-media backup. Caller must ensure there is no active transaction. Unlike a collection export, does not require reopening the DB, as there is no downgrade step. Returns false if it's not time to make a backup yet.

  message CreateBackupRequest

  collection.proto:160

  • string backup_folder = 1

  • bool force = 2

    Create a backup even if the configured interval hasn't elapsed yet.

  • bool wait_for_completion = 3

• rpc AwaitBackupCompletion (generic.Empty, generic.Empty)

  collection.proto:37

  If a backup is running, wait for it to complete. Will return an error if the backup encountered an error.

• rpc LatestProgress (generic.Empty, Progress)

  collection.proto:38

• rpc SetWantsAbort (generic.Empty, generic.Empty)

  collection.proto:39

• rpc CheckDatabase (generic.Empty, CheckDatabaseResponse)

  collection.proto:14

  message CheckDatabaseResponse

  collection.proto:52

  • repeated string problems = 1

• rpc GetUndoStatus (generic.Empty, UndoStatus)

  collection.proto:15

• rpc Undo (generic.Empty, OpChangesAfterUndo)

  collection.proto:16

• rpc Redo (generic.Empty, OpChangesAfterUndo)

  collection.proto:17

• rpc AddCustomUndoEntry (generic.String, generic.UInt32)

  collection.proto:18

• rpc MergeUndoEntries (generic.UInt32, OpChanges)

  collection.proto:19

• rpc LatestProgress (generic.Empty, Progress)

  collection.proto:20

• rpc SetWantsAbort (generic.Empty, generic.Empty)

  collection.proto:21

• rpc SetLoadBalancerEnabled (generic.Bool, OpChanges)

  collection.proto:22

Used in: Progress

• uint32 current_cards = 1

• uint32 total_cards = 2

• string label = 3

Used in: Progress

• uint32 current = 1

  Current iteration

• uint32 total = 2

  Total iterations

• uint32 reviews = 3

• uint32 current_preset = 4

  Only used in 'compute all params' case

• uint32 total_presets = 5

  Only used in 'compute all params' case

Used in: Progress

• uint32 current = 1

• uint32 total = 2

Used as response type in: cards.CardsService.UpdateCards, CollectionService.MergeUndoEntries, CollectionService.SetLoadBalancerEnabled, config.ConfigService.RemoveConfig, config.ConfigService.SetConfigBool, config.ConfigService.SetConfigJson, config.ConfigService.SetConfigString, config.ConfigService.SetPreferences, deck_config.DeckConfigService.UpdateDeckConfigs, decks.DecksService.RenameDeck, decks.DecksService.SetCurrentDeck, decks.DecksService.SetDeckCollapsed, decks.DecksService.UpdateDeck, decks.DecksService.UpdateDeckLegacy, image_occlusion.ImageOcclusionService.AddImageOcclusionNote, image_occlusion.ImageOcclusionService.AddImageOcclusionNotetype, image_occlusion.ImageOcclusionService.UpdateImageOcclusionNote, notes.NotesService.UpdateNotes, notetypes.NotetypesService.ChangeNotetype, notetypes.NotetypesService.RemoveNotetype, notetypes.NotetypesService.RestoreNotetypeToStock, notetypes.NotetypesService.UpdateNotetype, notetypes.NotetypesService.UpdateNotetypeLegacy, scheduler.SchedulerService.AnswerCard, scheduler.SchedulerService.CustomStudy, scheduler.SchedulerService.EmptyFilteredDeck, scheduler.SchedulerService.GradeNow, scheduler.SchedulerService.RestoreBuriedAndSuspendedCards, scheduler.SchedulerService.ScheduleCardsAsNew, scheduler.SchedulerService.SetDueDate, scheduler.SchedulerService.UnburyDeck, tags.TagsService.SetTagCollapsed

Used as field type in: OpChangesAfterUndo, OpChangesOnly, OpChangesWithCount, OpChangesWithId, import_export.ImportResponse, notes.AddNoteResponse, notes.AddNotesResponse

• bool card = 1

• bool note = 2

• bool deck = 3

• bool tag = 4

• bool notetype = 5

• bool config = 6

• bool deck_config = 11

• bool mtime = 12

• bool browser_table = 7

• bool browser_sidebar = 8

• bool note_text = 9

  editor and displayed card in review screen

• bool study_queues = 10

  whether to call .reset() and getCard()

Used as response type in: CollectionService.Redo, CollectionService.Undo

• optional OpChanges changes = 1

• string operation = 2

• int64 reverted_to_timestamp = 3

• optional UndoStatus new_status = 4

• uint32 counter = 5

Allows frontend code to extract changes from other messages like ImportResponse without decoding other potentially large fields.

• optional OpChanges changes = 1

Used as response type in: cards.CardsService.RemoveCards, cards.CardsService.SetDeck, cards.CardsService.SetFlag, decks.DecksService.RemoveDecks, decks.DecksService.ReparentDecks, notes.NotesService.AfterNoteUpdates, notes.NotesService.RemoveNotes, scheduler.SchedulerService.BuryOrSuspendCards, scheduler.SchedulerService.RebuildFilteredDeck, scheduler.SchedulerService.SortCards, scheduler.SchedulerService.SortDeck, search.SearchService.FindAndReplace, tags.TagsService.AddNoteTags, tags.TagsService.ClearUnusedTags, tags.TagsService.FindAndReplaceTag, tags.TagsService.RemoveNoteTags, tags.TagsService.RemoveTags, tags.TagsService.RenameTags, tags.TagsService.ReparentTags

• optional OpChanges changes = 1

• uint32 count = 2

Used as response type in: decks.DecksService.AddDeck, decks.DecksService.AddDeckLegacy, decks.DecksService.AddOrUpdateFilteredDeck, notetypes.NotetypesService.AddNotetype, notetypes.NotetypesService.AddNotetypeLegacy

• optional OpChanges changes = 1

• int64 id = 2

Used as response type in: BackendCollectionService.LatestProgress, CollectionService.LatestProgress

• oneof value

  • generic.Empty none = 1

  • sync.MediaSyncProgress media_sync = 2

  • string media_check = 3

  • Progress.FullSync full_sync = 4

  • Progress.NormalSync normal_sync = 5

  • Progress.DatabaseCheck database_check = 6

  • string importing = 7

  • string exporting = 8

  • ComputeParamsProgress compute_params = 9

  • ComputeRetentionProgress compute_retention = 10

  • ComputeMemoryProgress compute_memory = 11

Used in: Progress

• string stage = 1

• uint32 stage_total = 2

• uint32 stage_current = 3

Used in: Progress

• uint32 transferred = 1

• uint32 total = 2

Used in: Progress

• string stage = 1

• string added = 2

• string removed = 3

Used as response type in: CollectionService.GetUndoStatus

Used as field type in: OpChangesAfterUndo

• string undo = 1

• string redo = 2

• uint32 last_step = 3