Difference between revisions of "Preferences Server Payload Examples"

From wiki.gpii
Jump to: navigation, search
(Created page with " h2. Screen Magnifier h3. 2x Magnification with Mouse Tracking and GNOME-specific Cross Hairs <pre> { "display": { "screenEnhancement": { "magnificati...")
 
m (typo)
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
== Request ==
  
h2. Screen Magnifier
+
<pre>
 +
    GET /user/<token>
 +
</pre>
 +
 
 +
== Response (Flat Style) ==
  
h3. 2x Magnification with Mouse Tracking and GNOME-specific Cross Hairs
+
FOR REVIEW BY ARCHITECTURE TEAM!
 +
 
 +
<pre>{
 +
  "http://registry.gpii.org/common/magnification": [
 +
    { "value": 2.0 }
 +
  ],
 +
  "http://registry.gpii.org/common/tracking": [
 +
    { "value": "mouse" }
 +
  ],
 +
  "http://registry.gpii.org/applications/org.gnome.desktop.a11y.magnifier.mouse-tracking": [
 +
    { "value": "proportional" } // the value "mouse" is not supported by GNOME Magnifier
 +
  ],
 +
  "http://registry.gpii.org/applications/org.gnome.desktop.a11y.magnifier.applicationPriority": [
 +
    { "value": 100 }
 +
    // "application priority" is not a GNOME Magnifier setting.
 +
    // Is there a way to use a common term apply to a specific application?
 +
  ],
 +
  "http://registry.gpii.org/applications/org.gnome.desktop.a11y.magnifier.show-cross-hairs": [
 +
    { "value": "true" }
 +
  ],
 +
  "http://registry.gpii.org/applications/com.microsoft.windows.screenmagnifier.applicationPriority": [
 +
    { "value": 0 }
 +
    // "application priority" is not a GNOME Magnifier setting.
 +
    // Is there a way to use a common term apply to a specific application?
 +
  ],
 +
  "http://registry.gpii.org/applications/com.microsoft.windows.screenmagnifier.MagnifierUIWindowMinimized": [
 +
    { "value": 0 }
 +
  ]
 +
}</pre>
 +
 
 +
See also the examples on GitHub:
 +
* using only common terms (including some marked as "provisional"): [https://github.com/GPII/universal/blob/master/testData/preferences/MikelVargas.json Mikel Vargas], [https://github.com/GPII/universal/blob/master/testData/preferences/sammy.json sammy.json],
 +
* [https://github.com/GPII/universal/blob/master/testData/preferences/andrei.json andrei.json],
 +
* using both common terms and application-unique terms: [https://github.com/GPII/universal/blob/master/testData/preferences/carla.json carla.json], [https://github.com/GPII/universal/blob/master/testData/preferences/nisha.json nisha.json], [https://github.com/GPII/universal/blob/master/testData/preferences/timothy.json timothy.json].
 +
 
 +
== Response (Old, Hierarchical Style) ==
 +
 
 +
=== 2x Magnification with Mouse Tracking and GNOME-specific Cross Hairs ===
 
<pre>
 
<pre>
 
{
 
{
Line 12: Line 54:
 
                 "name": "GNOME Shell Magnifier",
 
                 "name": "GNOME Shell Magnifier",
 
                 "id": "org.gnome.desktop.a11y.magnifier",
 
                 "id": "org.gnome.desktop.a11y.magnifier",
 +
                "priority": 100,
 +
                "parameters": {
 +
                    "show-cross-hairs": true
 +
                }
 +
            }, {
 +
                "name": "Windows Magnifier",
 +
                "id": "com.microsoft.windows.screenmagnifier",
 
                 "priority": 0,
 
                 "priority": 0,
 
                 "parameters": {
 
                 "parameters": {
                     "show-cross-hairs": true
+
                     "MagnifierUIWindowMinimized": 0
 
                 }
 
                 }
 
             }]
 
             }]
Line 21: Line 70:
 
}
 
}
 
</pre>
 
</pre>
 +
 +
 +
[[Category:GPII Architecture]]

Latest revision as of 11:47, 29 August 2014

Request

    GET /user/<token>

Response (Flat Style)

FOR REVIEW BY ARCHITECTURE TEAM!

{
  "http://registry.gpii.org/common/magnification": [
    { "value": 2.0 }
  ],
  "http://registry.gpii.org/common/tracking": [
    { "value": "mouse" }
  ],
  "http://registry.gpii.org/applications/org.gnome.desktop.a11y.magnifier.mouse-tracking": [
    { "value": "proportional" } // the value "mouse" is not supported by GNOME Magnifier
  ],
  "http://registry.gpii.org/applications/org.gnome.desktop.a11y.magnifier.applicationPriority": [
    { "value": 100 } 
    // "application priority" is not a GNOME Magnifier setting. 
    // Is there a way to use a common term apply to a specific application?
  ],
  "http://registry.gpii.org/applications/org.gnome.desktop.a11y.magnifier.show-cross-hairs": [
    { "value": "true" } 
  ],
  "http://registry.gpii.org/applications/com.microsoft.windows.screenmagnifier.applicationPriority": [
    { "value": 0 } 
    // "application priority" is not a GNOME Magnifier setting. 
    // Is there a way to use a common term apply to a specific application?
  ],
  "http://registry.gpii.org/applications/com.microsoft.windows.screenmagnifier.MagnifierUIWindowMinimized": [
    { "value": 0 } 
  ]
}

See also the examples on GitHub:

Response (Old, Hierarchical Style)

2x Magnification with Mouse Tracking and GNOME-specific Cross Hairs

{
    "display": {
        "screenEnhancement": {
            "magnification": 2.0,
            "tracking": "mouse",
            "applications": [{
                "name": "GNOME Shell Magnifier",
                "id": "org.gnome.desktop.a11y.magnifier",
                "priority": 100,
                "parameters": {
                    "show-cross-hairs": true
                }
            }, {
                "name": "Windows Magnifier",
                "id": "com.microsoft.windows.screenmagnifier",
                "priority": 0,
                "parameters": {
                    "MagnifierUIWindowMinimized": 0
                }
            }]
        }
    }
}