Skip to content

DistributionCreateParameters.md

Latest commit

 

History

History
33 lines (26 loc) · 2.06 KB

DistributionCreateParameters.md

File metadata and controls

33 lines (26 loc) · 2.06 KB
Raw

Phrase::DistributionCreateParameters

Properties

Name Type Description Notes
name String Name of the distribution
project_id String Project id the distribution should be assigned to.
platforms Array<String> List of platforms the distribution should support. Valid values are: * `android` * `ios` * `flutter` * `i18next` * `rails` [optional]
locale_ids Array<String> List of locale ids that will be part of distribution releases [optional]
format_options Hash<String, String> Additional formatting and render options. Only `enclose_in_cdata` is available for platform `android`. [optional]
fallback_locales_enabled Boolean Use fallback locale if there is no translation in the current locale. [optional]
fallback_to_non_regional_locale Boolean Indicates whether to fallback to non regional locale when locale can not be found [optional]
fallback_to_default_locale Boolean Indicates whether to fallback to projects default locale when locale can not be found [optional]
use_last_reviewed_version Boolean Use last reviewed instead of latest translation in a project [optional]

Code Sample

require 'phrase'

instance = Phrase::DistributionCreateParameters.new(name: 'My Android Distribution',
                                 project_id: 'abcd1234abcd1234abcd1234',
                                 platforms: ["android","ios"],
                                 locale_ids: ["abcd1234cdef1234abcd1234cdef1234","fff565db236400772368235db2c6117e"],
                                 format_options: {xml:{enclose_in_cdata:'1'}},
                                 fallback_locales_enabled: true,
                                 fallback_to_non_regional_locale: true,
                                 fallback_to_default_locale: true,
                                 use_last_reviewed_version: true)