Skip to content

Latest commit

 

History

History
45 lines (38 loc) · 3.83 KB

LocaleDownloadCreateParameters.md

File metadata and controls

45 lines (38 loc) · 3.83 KB
Raw

Phrase::LocaleDownloadCreateParameters

Properties

Name Type Description Notes
file_format String File format name. See the <a href=&quot;https://support.phrase.com/hc/en-us/sections/6111343326364\&quot;&gt;format guide</a> for all supported file formats.
branch String specify the branch to use [optional]
tags String Limit results to keys tagged with a list of comma separated tag names. [optional]
include_empty_translations Boolean Indicates whether keys without translations should be included in the output as well. [optional]
exclude_empty_zero_forms Boolean Indicates whether zero forms should be included when empty in pluralized keys. [optional]
include_translated_keys Boolean Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys. [optional]
keep_notranslate_tags Boolean Indicates whether [NOTRANSLATE] tags should be kept. [optional]
format_options Object Additional formatting and render options. See the <a href=&quot;https://support.phrase.com/hc/en-us/sections/6111343326364\&quot;&gt;format guide</a> for a list of options available for each format. Specify format options like this: <code>...&format_options[foo]=bar</code> [optional]
encoding String Enforces a specific encoding on the file contents. Valid options are &quot;UTF-8&quot;, &quot;UTF-16&quot; and &quot;ISO-8859-1&quot;. [optional]
include_unverified_translations Boolean if set to false unverified translations are excluded [optional]
use_last_reviewed_version Boolean If set to true the last reviewed version of a translation is used. This is only available if the review workflow is enabled for the project. [optional]
locale_ids Array<String> Locale IDs or locale names [optional]
fallback_locale_id String If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to <code>true</code>. [optional]
source_locale_id String Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a <code>tag</code> parameter indicating a specific job. [optional]
custom_metadata_filters Object Custom metadata filters. Provide the name of the metadata field and the value to filter by. Only keys with matching metadata will be included in the download. [optional]

Code Sample

require 'Phrase'

instance = Phrase::LocaleDownloadCreateParameters.new(file_format: yml,
                                 branch: my-feature-branch,
                                 tags: feature1,feature2,
                                 include_empty_translations: true,
                                 exclude_empty_zero_forms: true,
                                 include_translated_keys: true,
                                 keep_notranslate_tags: true,
                                 format_options: null,
                                 encoding: UTF-8,
                                 include_unverified_translations: true,
                                 use_last_reviewed_version: null,
                                 locale_ids: [&quot;de&quot;,&quot;en&quot;],
                                 fallback_locale_id: abcd1234abcd1234abcd1234abcd1234,
                                 source_locale_id: abcd1234abcd1234abcd1234abcd1234,
                                 custom_metadata_filters: null)