api/devs.ouya.tv/api-v1-partner_builds.rst

   1 ==================================================
   2 ``GET https://devs.ouya.tv/api/v1/partner_builds``
   3 ==================================================
   4
   5 Fetch commands for the "OUYA Everywhere" installer.
   6
   7
   8 HTTP request
   9 ============
  10 Protocol
  11   ``https``
  12 Method
  13   ``GET``
  14 Host
  15   ``devs.ouya.tv``
  16 Path
  17   ``/api/v1/partner_builds``
  18 Headers
  19   ``User-Agent``
  20     Known values:
  21
  22     - ``ouya-everywhere-installer (MadCatz/mojo-TS/mojo:4.2.2/JDQ39/MO0205-TS:user/release-keys)``
  23     - ``ouya-everywhere-installer (razer/pearlyn/pearlyn:6.0.1/M-MMB29M-rzs-us-sf-bld2-19HP-08.02.AM/144:user/release-keys)``
  24   ``Accept-Language``
  25     ``de``
  26   ``X-InstallerVersionCode``
  27     ??
  28   ``X-InstallerVersionName``
  29     ??
  30   ``X-InstallerPackageName``
  31     ??
  32   ``X-OUYA-Console-Id``
  33     Build serial number
  34   ``X-Device``
  35     ??
  36   ``X-Product``
  37     ??
  38   ``X-Model``
  39     ??
  40   ``X-Brand``
  41     ??
  42   ``X-Display``
  43     ??
  44   ``X-BuildId``
  45     ??
  46   ``X-Manufacturer``
  47     ??
  48   ``OUYAUsername``
  49     When logged in.
  50
  51
  52 HTTP response
  53 =============
  54 Status code
  55   ``200 OK``
  56 Content-type
  57   ``application/json; charset=utf-8``
  58
  59
  60 Response body definition
  61 ------------------------
  62 The response is a list of commands that the OUYA Everywhere installer
  63 will execute one after another.
  64
  65 The top-level object contains a key ``actions``, which is an array of
  66 action objects.
  67 Each action has a ``action`` property that defines its type.
  68
  69
  70 exit action
  71 -----------
  72 Just stop the installer.
  73
  74 No additional properties.
  75
  76 .. include:: api-v1-partner_builds.exit.json
  77    :code:
  78
  79
  80 installFile action
  81 ------------------
  82 Install the given .apk file if it has not yet been installed.
  83
  84 ``action``
  85   ``installFile``
  86 ``packageName``
  87   Name of package to install. Example: ``de.ouya.cweiske.foo``
  88 ``friendlyName``
  89   Name shown on screen during installation
  90 ``md5``
  91   Example: ``d3b07384d113edec49eaa6238ad5ff00``
  92 ``filesize``
  93   ``12345``
  94 ``downloadUrl``
  95   ``http://example.org/app.apk``
  96 ``versionCode``
  97   Optional property. Example: ``23``.
  98
  99   Only install when the current version is lower than this number.
 100
 101
 102 launch action
 103 -------------
 104 Start the given application
 105
 106 ``action``
 107   ``launch``
 108 ``packageName``
 109   Application to start. Example: ``de.ouya.cweiske.foo``
 110
 111
 112 showDialog action
 113 -----------------
 114 Show a message that the user has to confirm.
 115
 116 ``action``
 117   ``showDialog``
 118 ``title``
 119   Message dialog title string
 120 ``message``
 121   Actual text
 122 ``verticalMargin``
 123   Optional. Example: ``1.0``
 124
 125
 126 uninstallFile action
 127 --------------------
 128 Remove a package
 129
 130 ``action``
 131   ``uninstallFile``
 132 ``packageName``
 133   Example: ``de.ouya.cweiske.foo``
 134 ``keepData``
 135   Optional boolean. Example: ``false``
 136 ``ifLessThanVersionCode``
 137   Optional integer. Example: ``12``
 138 ``ifGreaterThanVersionCode``
 139   Optional integer. Example: ``42``
 140
 141
 142 Example
 143 -------
 144
 145 .. include:: api-v1-partner_builds.response.json
 146    :code: