package mozc.user_dictionary
Get desktop application:
View/edit binary Protocol Buffers messages
message
user_dictionary_storage.proto:37Used in:
optional uint64 id = 1
ID of this dictionary
optional bool enabled = 2
set false if this dictionary is not used. Even if |enabled| is false, the dictionary it self is visible to user.
optional string name = 3
name of dictionary
repeated entries = 4
optional bool removed = 5
set true if this dictionary is removed. This flag is used for cloud sync feature. Cloud sync feature is already deprecated and this flag is only used to convert sync dictionary to normal dictionary.
optional bool syncable = 6
This flag is used for cloud sync feature. Cloud sync feature is already deprecated and this flag is only used to convert sync dictionary to normal dictionary.
entry of each word
Used in: , ,
optional string key = 1
optional string value = 2
optional string comment = 4
Do NOT use tag number '3' in this proto. Please see below.
optional PosType pos = 5
Historically we used to use tag number '3' for POS in string format. In order to switch it to enum based POS, we removed (deprecated) the tag number '3' field and created another field numbered '5'.
optional bool removed = 10
set true if this entry is removed. This flag is used for cloud sync feature. Cloud sync feature is already deprecated and this flag is only used to convert sync dictionary to normal dictionary.
optional bool auto_registered = 11
set true if this entry is automatically registered by converter.
Used in:
NOUN = 1
"名詞"
ABBREVIATION = 2
"短縮よみ"
SUGGESTION_ONLY = 3
"サジェストのみ"
PROPER_NOUN = 4
"固有名詞"
PERSONAL_NAME = 5
"人名"
FAMILY_NAME = 6
"姓"
FIRST_NAME = 7
"名"
ORGANIZATION_NAME = 8
"組織"
PLACE_NAME = 9
"地名"
SA_IRREGULAR_CONJUGATION_NOUN = 10
"名詞サ変"
ADJECTIVE_VERBAL_NOUN = 11
"名詞形動"
NUMBER = 12
"数"
ALPHABET = 13
"アルファベット"
SYMBOL = 14
"記号"
EMOTICON = 15
"顔文字"
ADVERB = 16
"副詞"
PRENOUN_ADJECTIVAL = 17
"連体詞"
CONJUNCTION = 18
"接続詞"
INTERJECTION = 19
"感動詞"
PREFIX = 20
"接頭語"
COUNTER_SUFFIX = 21
"助数詞"
GENERIC_SUFFIX = 22
"接尾一般"
PERSON_NAME_SUFFIX = 23
"接尾人名"
PLACE_NAME_SUFFIX = 24
"接尾地名"
WA_GROUP1_VERB = 25
"動詞ワ行五段"
KA_GROUP1_VERB = 26
"動詞カ行五段"
SA_GROUP1_VERB = 27
"動詞サ行五段"
TA_GROUP1_VERB = 28
"動詞タ行五段"
NA_GROUP1_VERB = 29
"動詞ナ行五段"
MA_GROUP1_VERB = 30
"動詞マ行五段"
RA_GROUP1_VERB = 31
"動詞ラ行五段"
GA_GROUP1_VERB = 32
"動詞ガ行五段"
BA_GROUP1_VERB = 33
"動詞バ行五段"
HA_GROUP1_VERB = 34
"動詞ハ行四段"
GROUP2_VERB = 35
"動詞一段"
KURU_GROUP3_VERB = 36
"動詞カ変"
SURU_GROUP3_VERB = 37
"動詞サ変"
ZURU_GROUP3_VERB = 38
"動詞ザ変"
RU_GROUP3_VERB = 39
"動詞ラ変"
ADJECTIVE = 40
"形容詞"
SENTENCE_ENDING_PARTICLE = 41
"終助詞"
PUNCTUATION = 42
"句読点"
FREE_STANDING_WORD = 43
"独立語"
SUPPRESSION_WORD = 44
"抑制単語"
Used in:
required UserDictionaryCommand.CommandType type = 1
optional uint64 session_id = 2
optional uint64 dictionary_id = 3
optional string dictionary_name = 4
repeated int32 entry_index = 5
optional entry = 6
optional string data = 7
optional bool ensure_non_empty_storage = 8
Used in:
NO_OPERATION = 0
Does nothing.
CLEAR_STORAGE = 1
Unlink the user dictionary file if necessary. We can do this operation without creating a session. This operation is introduced as a last resort to clean up user dictionary, so it *forces* to unlink the file regardless of the current user dictionary session status.
CREATE_SESSION = 2
Creates a new session, and returns its id via UserDictionaryCommandStatus::session_id.
DELETE_SESSION = 3
Deletes the session identified by session_id.
SET_DEFAULT_DICTIONARY_NAME = 4
Sets the default dictionary name. It will be used when ensure_non_empty_storage is enabled and the operation supporting the flag is invoked.
CHECK_UNDOABILITY = 5
Checks if the session is currently undoable or not.
UNDO = 6
Undoes the last operation.
LOAD = 7
Loads from local storage.
SAVE = 8
Saves to local storage.
GET_USER_DICTIONARY_NAME_LIST = 9
Returns a list of name and dictionary-id pairs. They are filled in the form of UserDictionary without any entries in UserDictionaryCommandStatus::storage.
GET_ENTRY_SIZE = 10
Returns the number of entries in the dictionary with the given dictionary_id.
GET_ENTRY = 11
Returns an entry in the dictionary specified by dictionary_id. The position of the entry should be specified via entry_index(0).
CHECK_NEW_DICTIONARY_AVAILABILITY = 12
Returns if it is possible to add new dictionary or not. The result is returned by using status code.
CREATE_DICTIONARY = 13
Creates a new dictionary with the dictionary_name.
DELETE_DICTIONARY = 14
Deletes the dictionary with the given dictionary_id.
RENAME_DICTIONARY = 15
Renames the dictionary with the given dictionary_id to dictionary_name.
CHECK_NEW_ENTRY_AVAILABILITY = 16
Returns if it is possible to add new entry to the dictionary with the given dictionary_id or not.
ADD_ENTRY = 17
Adds an entry to the dictionary with the given dictionary_id. Added entry should be located at the end of the dictionary, and the data should be passed via entry field.
EDIT_ENTRY = 18
Edits an entry in the dictionary with the given dictionary_id. The new data should be passed via entry. The edit target should be specified via entry_index(0).
DELETE_ENTRY = 19
Deletes entries in the dictionary with the given dictionary_id. The target entries should be specified based on index in entry_index.
IMPORT_DATA = 20
Imports entries from the given data into a dictionary. There are two ways to specify the dictionary: 1) set dictionary_id for the dictionary 2) set dictionary_name to create a new dictionary with the name.
GET_STORAGE = 21
Gets the entire UserDictionaryStorage data. Note: The result of this command could be too large for IPC, which has a size limitation of the response data.
Used in:
required UserDictionaryCommandStatus.Status status = 1
optional uint64 session_id = 2
optional storage = 3
optional entry = 4
optional uint64 dictionary_id = 5
optional uint32 entry_size = 6
Note: this status code is now temporary assgined. It may be updated (incl. re-numbering) to organize the code. I.e., the code shouldn't be saved in serialized format for now. TODO(hidehiko): Re-organize and re-number the enum values, after we check all necessary codes in.
Used in:
USER_DICTIONARY_COMMAND_SUCCESS = 1
Note: SUCCEEDED is conflicting Windows MACRO.
UNKNOWN_ERROR = 2
UNKNOWN_COMMAND = 3
INVALID_ARGUMENT = 4
UNKNOWN_SESSION_ID = 5
FILE_NOT_FOUND = 6
INVALID_FILE_FORMAT = 7
FILE_SIZE_LIMIT_EXCEEDED = 8
Note: currently if we recieve this error status, the file is actually saved.
DICTIONARY_SIZE_LIMIT_EXCEEDED = 9
ENTRY_SIZE_LIMIT_EXCEEDED = 10
UNKNOWN_DICTIONARY_ID = 11
ENTRY_INDEX_OUT_OF_RANGE = 12
DICTIONARY_NAME_EMPTY = 13
Errors for dictionary names.
DICTIONARY_NAME_TOO_LONG = 14
DICTIONARY_NAME_CONTAINS_INVALID_CHARACTER = 15
DICTIONARY_NAME_DUPLICATED = 16
READING_EMPTY = 17
Errors for entry data.
READING_TOO_LONG = 18
READING_CONTAINS_INVALID_CHARACTER = 19
WORD_EMPTY = 20
WORD_TOO_LONG = 21
WORD_CONTAINS_INVALID_CHARACTER = 22
INVALID_POS_TYPE = 23
COMMENT_TOO_LONG = 24
COMMENT_CONTAINS_INVALID_CHARACTER = 25
IMPORT_TOO_MANY_WORDS = 26
Errors for importing.
IMPORT_INVALID_ENTRIES = 27
NO_UNDO_HISTORY = 28
Used in:
optional int32 version = 1
version of user dictionary
repeated dictionaries = 2
dictionary body
optional UserDictionaryStorage.StorageType storage_type = 10
Used in:
SNAPSHOT = 1
This storage is a snapshot.
UPDATE = 2
This storage is a diff of some snapshots.