Sha256: 9ff6e85d2ea9f3f2d487fd07edbbc32de6a0bc11f8b8764fdb04fd3ded2e2133
Contents?: true
Size: 1.96 KB
Versions: 14
Compression:
Stored size: 1.96 KB
Contents
# Phrase::KeysSearchParameters
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**branch** | **String** | specify the branch to use | [optional]
**sort** | **String** | Sort by field. Can be one of: name, created_at, updated_at. | [optional]
**order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
**q** | **String** | Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - whitespaces need to be prefixed with a backspace (\\\"\\\\\\\")</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. | [optional]
**locale_id** | **String** | Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
## Code Sample
```ruby
require 'Phrase'
instance = Phrase::KeysSearchParameters.new(branch: my-feature-branch,
sort: updated_at,
order: desc,
q: mykey* translated:true,
locale_id: abcd1234abcd1234abcd1234abcd1234)
```
Version data entries
14 entries across 14 versions & 1 rubygems