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 



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

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

#order=(val) ⇒ Object 



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

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

#q=(val) ⇒ Object 



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

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

#sort=(val) ⇒ Object 



1078
1079
1080
 
# File 'lib/phraseapp-ruby.rb', line 1078

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

#validate ⇒ Object 



1082
1083
1084
 
# File 'lib/phraseapp-ruby.rb', line 1082

def validate
  
end