Sha256: 8348b86a555d9d7bf329d19df35a04973511c339058af6eaeaa6fb2e1d205077
Contents?: true
Size: 1.81 KB
Versions: 47
Compression:
Stored size: 1.81 KB
Contents
# Phrase::KeysIncludeParameters
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**branch** | **String** | specify the branch to use | [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 - spaces, commas, and colons need to be escaped with double backslashes</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]
**target_locale_id** | **String** | Locale used to exlcude or include keys. | [optional]
**tags** | **String** | Tag or comma-separated list of tags to add to the matching collection of keys | [optional]
## Code Sample
```ruby
require 'Phrase'
instance = Phrase::KeysIncludeParameters.new(branch: my-feature-branch,
q: mykey* translated:true,
target_locale_id: abcd1234abcd1234abcd1234abcd1234,
tags: landing-page,release-1.2)
```
Version data entries
47 entries across 47 versions & 1 rubygems