package anki.notetypes
Get desktop application:
View/edit binary Protocol Buffers messages
Implicitly includes any of the above methods that are not listed in the backend service.
(no methods)
rpc AddNotetype (, )
notetypes.proto:14rpc UpdateNotetype (, )
notetypes.proto:15rpc AddNotetypeLegacy (, )
notetypes.proto:16message
notetypes.proto:139bytes json = 1
bool skip_checks = 2
message
notetypes.proto:133bytes json = 1
bool preserve_usn_and_mtime = 2
bool skip_checks = 3
message
notetypes.proto:144StockNotetype.Kind kind = 1
rpc GetNotetype (, )
notetypes.proto:21rpc GetNotetypeLegacy (, )
notetypes.proto:22rpc GetNotetypeNames (, )
notetypes.proto:23message
notetypes.proto:170repeated entries = 1
message
notetypes.proto:174repeated entries = 1
rpc RemoveNotetype (, )
notetypes.proto:26message
notetypes.proto:189int64 id = 1
string key = 2
message
notetypes.proto:194int64 notetype_id = 1
uint32 card_ordinal = 2
string key = 3
message
notetypes.proto:200int64 old_notetype_id = 1
int64 new_notetype_id = 2
message
notetypes.proto:218repeated string old_field_names = 1
repeated string old_template_names = 2
repeated string new_field_names = 3
repeated string new_template_names = 4
optional input = 5
string old_notetype_name = 6
rpc ChangeNotetype (, )
notetypes.proto:32rpc GetFieldNames (, )
notetypes.proto:33message
notetypes.proto:227optional notetype_id = 1
optional StockNotetype.Kind force_kind = 2
Older notetypes did not store their original stock kind, so we allow the UI to pass in an override to use when missing, or for tests.
rpc GetClozeFieldOrds (, )
notetypes.proto:36message
notetypes.proto:247repeated uint32 ords = 1
message
notetypes.proto:205Used as request type in: NotetypesService.ChangeNotetype
Used as field type in:
repeated int64 note_ids = 1
repeated int32 new_fields = 2
-1 is used to represent null, as nullable repeated fields are unwieldy in protobuf
repeated int32 new_templates = 3
int64 old_notetype_id = 4
int64 new_notetype_id = 5
int64 current_schema = 6
string old_notetype_name = 7
bool is_cloze = 8
CLOZE_FIELD_TEXT = 0
CLOZE_FIELD_BACK_EXTRA = 1
IMAGE_OCCLUSION_FIELD_OCCLUSIONS = 0
IMAGE_OCCLUSION_FIELD_IMAGE = 1
IMAGE_OCCLUSION_FIELD_HEADER = 2
IMAGE_OCCLUSION_FIELD_BACK_EXTRA = 3
IMAGE_OCCLUSION_FIELD_COMMENTS = 4
message
notetypes.proto:47Used as request type in: NotetypesService.AddNotetype, NotetypesService.UpdateNotetype
Used as response type in: NotetypesService.GetNotetype
int64 id = 1
string name = 2
int64 mtime_secs = 3
sint32 usn = 4
optional config = 7
repeated fields = 8
repeated templates = 9
message
notetypes.proto:48Used in:
Config.Kind kind = 1
uint32 sort_field_idx = 2
string css = 3
int64 target_deck_id_unused = 4
This is now stored separately; retrieve with DefaultsForAdding()
string latex_pre = 5
string latex_post = 6
bool latex_svg = 7
repeated reqs = 8
StockNotetype.OriginalStockKind original_stock_kind = 9
Only set on notetypes created with Anki 2.1.62+.
optional int64 original_id = 10
the id in the source collection for imported notetypes (Anki 23.10)
bytes other = 255
message
notetypes.proto:53Used in:
uint32 card_ord = 1
CardRequirement.Kind kind = 2
repeated uint32 field_ords = 3
Used in:
KIND_NONE = 0
KIND_ANY = 1
KIND_ALL = 2
Used in:
KIND_NORMAL = 0
KIND_CLOZE = 1
message
notetypes.proto:80Used in:
optional ord = 1
string name = 2
optional config = 5
message
notetypes.proto:81Used in:
bool sticky = 1
bool rtl = 2
string font_name = 3
uint32 font_size = 4
string description = 5
bool plain_text = 6
bool collapsed = 7
bool exclude_from_search = 8
optional int64 id = 9
used for merging notetypes on import (Anki 23.10)
optional uint32 tag = 10
Can be used to uniquely identify required fields.
bool prevent_deletion = 11
bytes other = 255
message
notetypes.proto:102Used in: ,
optional ord = 1
string name = 2
int64 mtime_secs = 3
sint32 usn = 4
optional config = 5
message
notetypes.proto:103Used in:
string q_format = 1
string a_format = 2
string q_format_browser = 3
string a_format_browser = 4
int64 target_deck_id = 5
string browser_font_name = 6
uint32 browser_font_size = 7
optional int64 id = 8
used for merging notetypes on import (Anki 23.10)
bytes other = 255
message
notetypes.proto:43Used as request type in: media.MediaService.ExtractStaticMediaFiles, notes.NotesService.DefaultDeckForNotetype, notes.NotesService.NewNote, NotetypesService.GetClozeFieldOrds, NotetypesService.GetFieldNames, NotetypesService.GetNotetype, NotetypesService.GetNotetypeLegacy, NotetypesService.RemoveNotetype
Used as response type in: notes.NotesService.GetSingleNotetypeOfNotes, NotetypesService.AddOrUpdateNotetype, NotetypesService.GetNotetypeIdByName
Used as field type in:
int64 ntid = 1
message
notetypes.proto:178Used in:
int64 id = 1
string name = 2
message
notetypes.proto:183Used in:
int64 id = 1
string name = 2
uint32 use_count = 3
Used in: ,
KIND_BASIC = 0
KIND_BASIC_AND_REVERSED = 1
KIND_BASIC_OPTIONAL_REVERSED = 2
KIND_BASIC_TYPING = 3
KIND_CLOZE = 4
KIND_IMAGE_OCCLUSION = 5
This is decoupled from Kind to allow us to evolve notetypes over time (eg an older notetype might require different JS), and allow us to store a type even for notetypes that we don't add by default. Code should not assume that the entries here are always +1 from Kind.
Used in:
ORIGINAL_STOCK_KIND_UNKNOWN = 0
ORIGINAL_STOCK_KIND_BASIC = 1
ORIGINAL_STOCK_KIND_BASIC_AND_REVERSED = 2
ORIGINAL_STOCK_KIND_BASIC_OPTIONAL_REVERSED = 3
ORIGINAL_STOCK_KIND_BASIC_TYPING = 4
ORIGINAL_STOCK_KIND_CLOZE = 5
ORIGINAL_STOCK_KIND_IMAGE_OCCLUSION = 6