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

sort

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

Instance Method Summary collapse

Instance Method Details

#locale_id=(val) ⇒ Object 



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

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

#order=(val) ⇒ Object 



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

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

#q=(val) ⇒ Object 



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

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

#sort=(val) ⇒ Object 



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

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

#validate ⇒ Object 



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

def validate
  
end