~ubuntu-branches/ubuntu/trusty/unity-scopes-api/trusty-proposed

« back to all changes in this revision

Viewing changes to RELEASE_NOTES.txt

  • Committer: Package Import Robot
  • Author(s): Ubuntu daily release, Pawel Stolowski
  • Date: 2014-02-11 17:55:05 UTC
  • mfrom: (1.1.8)
  • Revision ID: package-import@ubuntu.com-20140211175505-av3z0612p7o8w54b
Tags: 0.3.1+14.04.20140211.2-0ubuntu1
[ Pawel Stolowski ]
* [ Pawel Stolowski ]
* Added preliminary API for filters and departments.
* Changes to preview action activation API: support for widget id.
* Changes to Annotation API.
* Return ScopeProxy from Result::target_scope_proxy (replaces activation_scope_name).

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Release Notes for unity-scopes-api
 
2
==================================
 
3
 
 
4
Changes in version 0.3.1
 
5
========================
 
6
- Scope::activate_preview_action() and ScopeBase::activate_preview_action() were
 
7
  renamed to perform_action(). They now also require widget identifier
 
8
  along with action id and hints.
 
9
- Added SearchMetadata and ActionMetadata classes; these classes are now passed
 
10
  to create_query(), activate(), perform_action(), preview() methods of
 
11
  ScopeBase and Scope (ScopeProxy) instead of a plain VariantMap.
 
12
- The 'Handled' state was removed from ActivationResponse::Status and two new
 
13
  values were added instead: ShowDash and HideDash.
 
14
- Annotation API changes: annotations of 'Card' type were removed and Annotation
 
15
  doesn't support category attribute anymore. SearchReply::push() method for
 
16
  annotations was renamed to register_annotation(). Annotations are now going to
 
17
  be displayed in the order they were registered by scopes.
 
18
- Result::activation_scope_name() method was renamed to target_scope_proxy() and
 
19
  it now returns ScopeProxy instead of a string. Client code can now use that
 
20
  proxy for result activation or preview calls, instead of having to do an extra
 
21
  registry lookup.
 
22
 
 
23
Changes in version 0.3.0
 
24
========================
 
25
 
 
26
- Preliminary API for filters has been added via OptionSelectorFilter and
 
27
  FilterState classes. This part of the API is not yet supported by Unity shell
 
28
  and should be considered highly experimental. 
 
29
 
 
30
- ScopeBase::create_query() method now takes Query object instance instead of
 
31
  just a search query string. Search query string is now encapsulated in the
 
32
  Query class and can be retrieved via Query::query_string().
 
33
 
 
34
- ScopeProxy class provides overloaded create_query methods for passing filter
 
35
  state and department id. Note: departments are not yet supported across the
 
36
  API.
 
37
 
 
38
- The scoperegistry allows extra scopes to be added on the command line now:
 
39
 
 
40
    $ scoperegistry some/path/Runtime.ini some/other/path/Fred.ini Joe.ini
 
41
 
 
42
  This loads Fred and Joe scopes in addition to any scopes picked up
 
43
  via the normal configuration. If Fred or Joe appear in configuration
 
44
  as well as on the command line, the config file on the command line
 
45
  takes precedence. The .so for additional scopes is expected to be
 
46
  in the same directory as the corresponding .ini file.