Skip to content

Latest commit

 

History

History
29 lines (24 loc) · 3.84 KB

KeyUpdateParameters.md

File metadata and controls

29 lines (24 loc) · 3.84 KB

KeyUpdateParameters

Properties

Name Type Description Notes
Branch string specify the branch to use [optional]
Name string Key name [optional]
Description Pointer to NullableString Key description (usually includes contextual information for translators). Send an empty string or `null` to clear the description; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. [optional]
Plural bool Indicates whether key supports pluralization [optional]
UseOrdinalRules bool Indicates whether key uses ordinal rules for pluralization [optional]
NamePlural Pointer to NullableString Plural name for the key (used in some file formats, e.g. Gettext) Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. [optional]
DataType string Type of the key. Can be one of the following: string, number, boolean, array, markdown. [optional]
Tags string List of tags separated by comma to be associated with the key. [optional]
MaxCharactersAllowed int32 Max. number of characters translations for this key can have. [optional]
Screenshot *os.File Screenshot/image for the key. This parameter is deprecated. Please use the Screenshots endpoint instead. [optional]
RemoveScreenshot bool Indicates whether the screenshot will be deleted. This parameter is deprecated. Please use the Screenshots endpoint instead. [optional]
Unformatted bool Indicates whether the key should be exported as "unformatted". Supported by Android XML and other formats. [optional]
XmlSpacePreserve bool Indicates whether the key should be exported with "xml:space=preserve". Supported by several XML-based formats. [optional]
OriginalFile Pointer to NullableString Original file attribute. Used in some formats, e.g. XLIFF. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. [optional]
LocalizedFormatString Pointer to NullableString NSStringLocalizedFormatKey attribute. Used in .stringsdict format. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. [optional]
LocalizedFormatKey Pointer to NullableString NSStringLocalizedFormatKey attribute. Used in .stringsdict format. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. [optional]
CustomMetadata map[string]interface{} Updates/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]
ExcludedInLocales []string Locales for which translations of this key are excluded from exports. Pass an empty array to clear exclusions. [optional]
FormatValueType string Override 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]