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 <a href=“/api/v2/examples/#word-matching-examples”>search term query</a> 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-21 for date range queries</li> </ul> Find more examples <a href=“/api/v2/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 



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

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

#q=(val) ⇒ Object 



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

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

#tags=(val) ⇒ Object 



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

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

#validate ⇒ Object 



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

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