Sha256: 9823dd55b2e097fa5405958721af84b6cfac11756b16bf1ae26831d6717fc35b

Contents?: true

Size: 1.86 KB

Versions: 14

Compression:

Stored size: 1.86 KB

Contents

# Phrase::KeysTagParameters

## 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 - 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] 
**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::KeysTagParameters.new(branch: my-feature-branch,
                                 q: mykey* translated:true,
                                 locale_id: abcd1234abcd1234abcd1234abcd1234,
                                 tags: landing-page,release-1.2)
```


Version data entries

14 entries across 14 versions & 1 rubygems

Version Path
phrase-2.0.0 docs/KeysTagParameters.md
phrase-1.0.14 docs/KeysTagParameters.md
phrase-1.0.13 docs/KeysTagParameters.md
phrase-1.0.12 docs/KeysTagParameters.md
phrase-1.0.11 docs/KeysTagParameters.md
phrase-1.0.10 docs/KeysTagParameters.md
phrase-1.0.9 docs/KeysTagParameters.md
phrase-1.0.8 docs/KeysTagParameters.md
phrase-1.0.7 docs/KeysTagParameters.md
phrase-1.0.6 docs/KeysTagParameters.md
phrase-1.0.5 docs/KeysTagParameters.md
phrase-1.0.4 docs/KeysTagParameters.md
phrase-1.0.3 docs/KeysTagParameters.md
phrase-1.0.2 docs/KeysTagParameters.md