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

Specify a search term query including wildcard or exact matching. It will search the key metadata for matching results. Searched fields include key name, description, tags, translations.
Also supports the following qualifiers in the query:
<ul> <li>name:key_name for text queries on key names</li> <li>translated:{true|false} for translation status (also requires locale_id to be specified)</li> <li>updated_at{>=|<=}2013-02-21T00:00:00Z for date range queries</li> </ul> Please note that the argument is named --query when using the <a href=“phraseapp.com/cli” target=“_blank”>PhraseApp Client</a>. <br /><br /> Find more examples <a href=“/api/v2/general/examples/”>here</a>.

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 



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

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

#q=(val) ⇒ Object 



1138
1139
1140
 
# File 'lib/phraseapp-ruby.rb', line 1138

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

#tags=(val) ⇒ Object 



1142
1143
1144
 
# File 'lib/phraseapp-ruby.rb', line 1142

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

#validate ⇒ Object 



1146
1147
1148
1149
1150
 
# File 'lib/phraseapp-ruby.rb', line 1146

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