Class: PhraseApp::RequestParams::KeysUntagParams

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

Overview

KeysUntagParams

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-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 



1157
1158
1159
 
# File 'lib/phraseapp-ruby.rb', line 1157

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

#q=(val) ⇒ Object 



1161
1162
1163
 
# File 'lib/phraseapp-ruby.rb', line 1161

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

#tags=(val) ⇒ Object 



1165
1166
1167
 
# File 'lib/phraseapp-ruby.rb', line 1165

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

#validate ⇒ Object 



1169
1170
1171
1172
1173
 
# File 'lib/phraseapp-ruby.rb', line 1169

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