Sha256: b0d7e34737bd7f6f1ad2e23af38780fc13d7a35cd78eea398c043592fa20f037

Contents?: true

Size: 1.81 KB

Versions: 47

Compression:

Stored size: 1.81 KB

Contents

# Phrase::KeysExcludeParameters

## 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::KeysExcludeParameters.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

Version Path
phrase-2.5.1 docs/KeysExcludeParameters.md
phrase-2.5.0 docs/KeysExcludeParameters.md
phrase-2.4.0 docs/KeysExcludeParameters.md
phrase-2.3.1 docs/KeysExcludeParameters.md
phrase-2.3.0 docs/KeysExcludeParameters.md
phrase-2.2.0 docs/KeysExcludeParameters.md
phrase-2.1.0 docs/KeysExcludeParameters.md