package anki.decks

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc NewDeck (generic.Empty, Deck)

  decks.proto:14

• rpc AddDeck (Deck, collection.OpChangesWithId)

  decks.proto:15

• rpc AddDeckLegacy (generic.Json, collection.OpChangesWithId)

  decks.proto:16

• rpc AddOrUpdateDeckLegacy (AddOrUpdateDeckLegacyRequest, DeckId)

  decks.proto:17

  message AddOrUpdateDeckLegacyRequest

  decks.proto:133

  • bytes deck = 1

  • bool preserve_usn_and_mtime = 2

• rpc DeckTree (DeckTreeRequest, DeckTreeNode)

  decks.proto:18

  message DeckTreeRequest

  decks.proto:138

  • int64 now = 1

    if non-zero, counts for the provided timestamp will be included

  message DeckTreeNode

  decks.proto:143

  • int64 deck_id = 1

  • string name = 2

  • uint32 level = 4

  • bool collapsed = 5

  • uint32 review_count = 6

    counts after adding children+applying limits

  • uint32 learn_count = 7

  • uint32 new_count = 8

  • uint32 intraday_learning = 9

    card counts without children or limits applied

  • uint32 interday_learning_uncapped = 10

  • uint32 new_uncapped = 11

  • uint32 review_uncapped = 12

  • uint32 total_in_deck = 13

  • uint32 total_including_children = 14

    with children, without any limits

  • bool filtered = 16

  • repeated DeckTreeNode children = 3

    low index so key can be packed into a byte, but at bottom to make debug output easier to read

• rpc DeckTreeLegacy (generic.Empty, generic.Json)

  decks.proto:19

• rpc GetAllDecksLegacy (generic.Empty, generic.Json)

  decks.proto:20

• rpc GetDeckIdByName (generic.String, DeckId)

  decks.proto:21

• rpc GetDeck (DeckId, Deck)

  decks.proto:22

• rpc UpdateDeck (Deck, collection.OpChanges)

  decks.proto:23

• rpc UpdateDeckLegacy (generic.Json, collection.OpChanges)

  decks.proto:24

• rpc SetDeckCollapsed (SetDeckCollapsedRequest, collection.OpChanges)

  decks.proto:25

  message SetDeckCollapsedRequest

  decks.proto:171

  • int64 deck_id = 1

  • bool collapsed = 2

  • SetDeckCollapsedRequest.Scope scope = 3

• rpc GetDeckLegacy (DeckId, generic.Json)

  decks.proto:26

• rpc GetDeckNames (GetDeckNamesRequest, DeckNames)

  decks.proto:27

  message GetDeckNamesRequest

  decks.proto:182

  • bool skip_empty_default = 1

  • bool include_filtered = 2

    if unset, implies skip_empty_default

• rpc GetDeckAndChildNames (DeckId, DeckNames)

  decks.proto:28

• rpc NewDeckLegacy (generic.Bool, generic.Json)

  decks.proto:29

• rpc RemoveDecks (DeckIds, collection.OpChangesWithCount)

  decks.proto:30

  message DeckIds

  decks.proto:46

  • repeated int64 dids = 1

• rpc ReparentDecks (ReparentDecksRequest, collection.OpChangesWithCount)

  decks.proto:31

  message ReparentDecksRequest

  decks.proto:197

  • repeated int64 deck_ids = 1

  • int64 new_parent = 2

• rpc RenameDeck (RenameDeckRequest, collection.OpChanges)

  decks.proto:33

  message RenameDeckRequest

  decks.proto:202

  • int64 deck_id = 1

  • string new_name = 2

• rpc GetOrCreateFilteredDeck (DeckId, FilteredDeckForUpdate)

  decks.proto:34

• rpc AddOrUpdateFilteredDeck (FilteredDeckForUpdate, collection.OpChangesWithId)

  decks.proto:35

• rpc FilteredDeckOrderLabels (generic.Empty, generic.StringList)

  decks.proto:37

• rpc SetCurrentDeck (DeckId, collection.OpChanges)

  decks.proto:38

• rpc GetCurrentDeck (generic.Empty, Deck)

  decks.proto:39

Used as request type in: DecksService.AddDeck, DecksService.UpdateDeck

Used as response type in: DecksService.GetCurrentDeck, DecksService.GetDeck, DecksService.NewDeck

• int64 id = 1

• string name = 2

• int64 mtime_secs = 3

• int32 usn = 4

• optional Deck.Common common = 5

• oneof kind

  the specifics are inlined here when sending data to clients, as otherwise an extra level of indirection would be required

  • Deck.Normal normal = 6

  • Deck.Filtered filtered = 7

Used in: Deck

• bool study_collapsed = 1

• bool browser_collapsed = 2

• uint32 last_day_studied = 3

• int32 new_studied = 4

• int32 review_studied = 5

• int32 milliseconds_studied = 7

• int32 learning_studied = 6

  previously set in the v1 scheduler, but not currently used for anything

• bytes other = 255

Used in: Deck, KindContainer, FilteredDeckForUpdate

• bool reschedule = 1

• repeated Filtered.SearchTerm search_terms = 2

• repeated float delays = 3

  v1 scheduler only

• uint32 preview_delay = 4

  v2 scheduler only

Used in: Filtered

• string search = 1

• uint32 limit = 2

• SearchTerm.Order order = 3

Used in: SearchTerm

• OLDEST_REVIEWED_FIRST = 0

• RANDOM = 1

• INTERVALS_ASCENDING = 2

• INTERVALS_DESCENDING = 3

• LAPSES = 4

• ADDED = 5

• DUE = 6

• REVERSE_ADDED = 7

• DUE_PRIORITY = 8

a container to store the deck specifics in the DB as a tagged enum

• oneof kind

  • Normal normal = 1

  • Filtered filtered = 2

Used in: Deck, KindContainer

• int64 config_id = 1

• uint32 extend_new = 2

• uint32 extend_review = 3

• string description = 4

• bool markdown_description = 5

• optional uint32 review_limit = 6

• optional uint32 new_limit = 7

• optional Normal.DayLimit review_limit_today = 8

• optional Normal.DayLimit new_limit_today = 9

Used in: Normal

• uint32 limit = 1

• uint32 today = 2

Used as request type in: deckconfig.DeckConfigService.GetDeckConfigsForUpdate, DecksService.GetDeck, DecksService.GetDeckAndChildNames, DecksService.GetDeckLegacy, DecksService.GetOrCreateFilteredDeck, DecksService.SetCurrentDeck, scheduler.SchedulerService.CountsForDeckToday, scheduler.SchedulerService.EmptyFilteredDeck, scheduler.SchedulerService.RebuildFilteredDeck

Used as response type in: DecksService.AddOrUpdateDeckLegacy, DecksService.GetDeckIdByName, notes.NotesService.DefaultDeckForNotetype

• int64 did = 1

Used in: DeckNames

• int64 id = 1

• string name = 2

Used as response type in: DecksService.GetDeckAndChildNames, DecksService.GetDeckNames

• repeated DeckNameId entries = 1

Used as request type in: DecksService.AddOrUpdateFilteredDeck

Used as response type in: DecksService.GetOrCreateFilteredDeck

• int64 id = 1

• string name = 2

• optional Deck.Filtered config = 3

Used in: SetDeckCollapsedRequest

• REVIEWER = 0

• BROWSER = 1