Class: PhraseApp::RequestParams::KeysListParams

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

Overview

KeysListParams

Parameters:

locale_id

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

order

Order direction. Can be one of: asc, desc.

q

Specify a <a href=“/guides/working-with-phraseapp/search-terms”>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*</li> <li>updated_at{>=|<=}21-02-2013 for date range queries</li> </ul> *Also requires locale_id to be specified.

sort

Sort by field. Can be one of: name, created_at, updated_at.

Instance Method Summary collapse

Instance Method Details

#locale_id=(val) ⇒ Object 



1059
1060
1061
 
# File 'lib/phraseapp-ruby.rb', line 1059

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

#order=(val) ⇒ Object 



1063
1064
1065
 
# File 'lib/phraseapp-ruby.rb', line 1063

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

#q=(val) ⇒ Object 



1067
1068
1069
 
# File 'lib/phraseapp-ruby.rb', line 1067

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

#sort=(val) ⇒ Object 



1071
1072
1073
 
# File 'lib/phraseapp-ruby.rb', line 1071

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

#validate ⇒ Object 



1075
1076
1077
 
# File 'lib/phraseapp-ruby.rb', line 1075

def validate
  
end