Class: PhraseApp::RequestParams::KeysSearchParams

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

Overview

KeysSearchParams

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 



1101
1102
1103
 
# File 'lib/phraseapp-ruby.rb', line 1101

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

#order=(val) ⇒ Object 



1105
1106
1107
 
# File 'lib/phraseapp-ruby.rb', line 1105

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

#q=(val) ⇒ Object 



1109
1110
1111
 
# File 'lib/phraseapp-ruby.rb', line 1109

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

#sort=(val) ⇒ Object 



1113
1114
1115
 
# File 'lib/phraseapp-ruby.rb', line 1113

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

#validate ⇒ Object 



1117
1118
1119
 
# File 'lib/phraseapp-ruby.rb', line 1117

def validate
  
end