Class: PhraseApp::RequestParams::LocaleDownloadParams

Inherits:

OpenStruct

• Object
• OpenStruct
• PhraseApp::RequestParams::LocaleDownloadParams

Defined in:

lib/phraseapp-ruby.rb

Overview

LocaleDownloadParams

Parameters:

branch

specify the branch to use

convert_emoji

Indicates whether Emoji symbols should be converted to actual Emojis. <a href=“phraseapp.com/docs/guides/working-with-phraseapp/emoji-support/”>Working with Emojis</a>.

encoding

Enforces a specific encoding on the file contents. Valid options are “UTF-8”, “UTF-16” and “ISO-8859-1”.

fallback_locale_id

If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the public ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to true.

file_format

File format name. See the format guide for all supported file formats.

format_options

Additional formatting and render options. See the <a href=“phraseapp.com/docs/guides/formats”>format guide</a> for a list of options available for each format. Specify format options like this: ...&format_options[foo]=bar

include_empty_translations

Indicates whether keys without translations should be included in the output as well.

keep_notranslate_tags

Indicates whether [NOTRANSLATE] tags should be kept.

skip_unverified_translations

Indicates whether the locale file should skip all unverified translations.

tag

Limit result to keys tagged with the given tag (identified by its name).

Instance Method Summary

• #branch=(val) ⇒ Object
• #convert_emoji=(val) ⇒ Object
• #encoding=(val) ⇒ Object
• #fallback_locale_id=(val) ⇒ Object
• #file_format=(val) ⇒ Object
• #format_options=(val) ⇒ Object
• #include_empty_translations=(val) ⇒ Object
• #keep_notranslate_tags=(val) ⇒ Object
• #skip_unverified_translations=(val) ⇒ Object
• #tag=(val) ⇒ Object
• #validate ⇒ Object

Instance Method Details

#branch=(val) ⇒ Object

# File 'lib/phraseapp-ruby.rb', line 1994

def branch=(val)
  super(val)
end

#convert_emoji=(val) ⇒ Object

# File 'lib/phraseapp-ruby.rb', line 1998

def convert_emoji=(val)
  if val.is_a?(TrueClass)
    super(true)
  elsif val.is_a?(FalseClass)
    return
  else
    PhraseApp::ParamsHelpers::ParamsValidationError.new("invalid value #{val}")
  end
end

#encoding=(val) ⇒ Object

# File 'lib/phraseapp-ruby.rb', line 2008

def encoding=(val)
  super(val)
end

#fallback_locale_id=(val) ⇒ Object

# File 'lib/phraseapp-ruby.rb', line 2012

def fallback_locale_id=(val)
  super(val)
end

#file_format=(val) ⇒ Object

# File 'lib/phraseapp-ruby.rb', line 2016

def file_format=(val)
  super(val)
end

#format_options=(val) ⇒ Object

# File 'lib/phraseapp-ruby.rb', line 2020

def format_options=(val)
  super(JSON.load(val))
end

#include_empty_translations=(val) ⇒ Object

# File 'lib/phraseapp-ruby.rb', line 2024

def include_empty_translations=(val)
  if val.is_a?(TrueClass)
    super(true)
  elsif val.is_a?(FalseClass)
    return
  else
    PhraseApp::ParamsHelpers::ParamsValidationError.new("invalid value #{val}")
  end
end

#keep_notranslate_tags=(val) ⇒ Object

# File 'lib/phraseapp-ruby.rb', line 2034

def keep_notranslate_tags=(val)
  if val.is_a?(TrueClass)
    super(true)
  elsif val.is_a?(FalseClass)
    return
  else
    PhraseApp::ParamsHelpers::ParamsValidationError.new("invalid value #{val}")
  end
end

#skip_unverified_translations=(val) ⇒ Object

# File 'lib/phraseapp-ruby.rb', line 2044

def skip_unverified_translations=(val)
  if val.is_a?(TrueClass)
    super(true)
  elsif val.is_a?(FalseClass)
    return
  else
    PhraseApp::ParamsHelpers::ParamsValidationError.new("invalid value #{val}")
  end
end

#tag=(val) ⇒ Object

# File 'lib/phraseapp-ruby.rb', line 2054

def tag=(val)
  super(val)
end

#validate ⇒ Object

# File 'lib/phraseapp-ruby.rb', line 2058

def validate
  
  if file_format == nil || file_format == "" 
    raise PhraseApp::ParamsHelpers::ParamsValidationError.new("Required parameter \"file_format\" of \"locale_downloadParams\" not set")
  end
end