Class: PhraseApp::RequestParams::KeysTagParams

Inherits:
OpenStruct
  • Object
show all
Defined in:
lib/phraseapp-ruby.rb

Overview

KeysTagParams

Parameters:

locale_id

Locale used to determine the translation state of a key when filtering for untranslated or translated keys.

q

Filter the results. Supports text queries for key name with ‘name:key_name’ and qualifiers like translated/untranslated ‘translated:true/false’. Requires an additional locale_id parameter if ‘translated:true/false’ is used.

tags

Tag or comma-separated list of tags to add to the matching collection of keys

Instance Method Summary collapse

Instance Method Details

#locale_id=(val) ⇒ Object 



1127
1128
1129
 
# File 'lib/phraseapp-ruby.rb', line 1127

def locale_id=(val)
  self.locale_id = val
end

#q=(val) ⇒ Object 



1131
1132
1133
 
# File 'lib/phraseapp-ruby.rb', line 1131

def q=(val)
  self.q = val
end

#tags=(val) ⇒ Object 



1135
1136
1137
 
# File 'lib/phraseapp-ruby.rb', line 1135

def tags=(val)
  self.tags = val.split(',')
end

#validate ⇒ Object 



1139
1140
1141
1142
1143
 
# File 'lib/phraseapp-ruby.rb', line 1139

def validate
  if self.tags == nil
    raise PhraseApp::ParamsHelpers::ParamsValidationError.new("Required parameter \"tags\" of \"keys_tagParams\" not set")
  end
end