Skip to content

Latest commit

History

History
28 lines (24 loc) · 2.77 KB

File metadata and controls

28 lines (24 loc) · 2.77 KB

KeyUpdateParameters

Properties

NameTypeDescriptionNotes
branchstrspecify the branch to use[optional]
namestrKey name[optional]
descriptionstrKey description (usually includes contextual information for translators)[optional]
pluralboolIndicates whether key supports pluralization[optional]
use_ordinal_rulesboolIndicates whether key uses ordinal rules for pluralization[optional]
name_pluralstrPlural name for the key (used in some file formats, e.g. Gettext)[optional]
data_typestrType of the key. Can be one of the following: string, number, boolean, array, markdown.[optional]
tagsstrList of tags separated by comma to be associated with the key.[optional]
max_characters_allowedintMax. number of characters translations for this key can have.[optional]
screenshotbytearrayScreenshot/image for the key. This parameter is deprecated. Please use the Screenshots endpoint instead.[optional]
remove_screenshotboolIndicates whether the screenshot will be deleted. This parameter is deprecated. Please use the Screenshots endpoint instead.[optional]
unformattedboolIndicates whether the key should be exported as "unformatted". Supported by Android XML and other formats.[optional]
xml_space_preserveboolIndicates whether the key should be exported with "xml:space=preserve". Supported by several XML-based formats.[optional]
original_filestrOriginal file attribute. Used in some formats, e.g. XLIFF.[optional]
localized_format_stringstrNSStringLocalizedFormatKey attribute. Used in .stringsdict format.[optional]
localized_format_keystrNSStringLocalizedFormatKey attribute. Used in .stringsdict format.[optional]
custom_metadataobjectUpdates/Creates custom metadata property name and value pairs to be associated with key. If you want to delete a custom metadata property, you can set its value to null. If you want to update a custom metadata property, you can set its value to the new value.[optional]
excluded_in_localesList[str]Locales for which translations of this key are excluded from exports. Pass an empty array to clear exclusions.[optional]
format_value_typestrOverride of the value type for the key in the export. Most useful for formats like Android XML that distinguish string vs. plural resources.[optional]

[Back to Model list][Back to API list][Back to README]