OLD | NEW |
1 // Copyright 2006 Google Inc. All Rights Reserved. | 1 // Copyright 2009-2010 Google Inc. |
2 // | 2 // |
3 // Author: Vivek Rao - vivekrao@google.com | 3 // Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 // you may not use this file except in compliance with the License. |
| 5 // You may obtain a copy of the License at |
4 // | 6 // |
5 // The proxy clsid #defined as PROXY_CLSID_IS in mk_common needs to be changed | 7 // http://www.apache.org/licenses/LICENSE-2.0 |
6 // anytime any interface below changes, or if a new interface is added. | 8 // |
| 9 // Unless required by applicable law or agreed to in writing, software |
| 10 // distributed under the License is distributed on an "AS IS" BASIS, |
| 11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 // See the License for the specific language governing permissions and |
| 13 // limitations under the License. |
| 14 // ======================================================================== |
7 | 15 |
8 import "oaidl.idl"; | 16 import "oaidl.idl"; |
9 import "ocidl.idl"; | 17 import "ocidl.idl"; |
10 | 18 |
| 19 // When adding interfaces to this file: |
| 20 // * Do not use "Google" or "GoogleUpdate" directly. Instead, use preprocessor |
| 21 // defines. |
| 22 // * Add a test for the Google-specific value to |
| 23 // omaha_customization_goopdate_apis_unittest.cc. |
| 24 |
| 25 // |
| 26 // Enums. |
| 27 // These values can be passed to interface methods and/or compared to their |
| 28 // output. |
| 29 // |
| 30 |
| 31 // Must be kept in sync with the enum in base/browser_utils.h. |
| 32 typedef enum BrowserType { |
| 33 BROWSER_UNKNOWN = 0, |
| 34 BROWSER_DEFAULT = 1, |
| 35 BROWSER_INTERNET_EXPLORER = 2, |
| 36 BROWSER_FIREFOX = 3, |
| 37 BROWSER_CHROME = 4, |
| 38 } BrowserType; |
| 39 |
| 40 // The normal install flow proceeds from STATE_INIT through |
| 41 // STATE_INSTALL_COMPLETE in order, skipping states that are not relevant. |
| 42 // All exceptions and terminal states are start with STATE_INSTALL_COMPLETE. |
| 43 typedef enum CurrentState { |
| 44 STATE_INIT = 1, |
| 45 STATE_WAITING_TO_CHECK_FOR_UPDATE = 2, |
| 46 STATE_CHECKING_FOR_UPDATE = 3, |
| 47 STATE_UPDATE_AVAILABLE = 4, |
| 48 STATE_WAITING_TO_DOWNLOAD = 5, |
| 49 STATE_RETRYING_DOWNLOAD = 6, |
| 50 STATE_DOWNLOADING = 7, |
| 51 STATE_DOWNLOAD_COMPLETE = 8, |
| 52 STATE_EXTRACTING = 9, |
| 53 STATE_APPLYING_DIFFERENTIAL_PATCH = 10, |
| 54 // TODO(omaha3): Should we move STATE_DOWNLOAD_COMPLETE here and eliminate |
| 55 // STATE_READY_TO_INSTALL? |
| 56 STATE_READY_TO_INSTALL = 11, |
| 57 STATE_WAITING_TO_INSTALL = 12, |
| 58 STATE_INSTALLING = 13, |
| 59 STATE_INSTALL_COMPLETE = 14, |
| 60 STATE_PAUSED = 15, |
| 61 STATE_NO_UPDATE = 16, |
| 62 STATE_ERROR = 17, |
| 63 } CurrentState; |
| 64 |
| 65 typedef enum InstallPriority { |
| 66 INSTALL_PRIORITY_LOW = 0, |
| 67 INSTALL_PRIORITY_HIGH = 10, |
| 68 } InstallPriority; |
| 69 |
| 70 // Specifies what the client should do after installation. |
| 71 typedef enum PostInstallAction { |
| 72 POST_INSTALL_ACTION_DEFAULT = 0, |
| 73 |
| 74 // Caller should exit silently. |
| 75 POST_INSTALL_ACTION_EXIT_SILENTLY = 1, |
| 76 |
| 77 // Caller should launch the command. |
| 78 POST_INSTALL_ACTION_LAUNCH_COMMAND = 2, |
| 79 |
| 80 // Caller should launch the command and exit silently. |
| 81 POST_INSTALL_ACTION_EXIT_SILENTLY_ON_LAUNCH_COMMAND = 3, |
| 82 |
| 83 // The caller should ask the user to restart the browser. If the value of |
| 84 // IApp's browser is supported and postInstallUrl is valid, the client should |
| 85 // offer to restart the browser. If the user chooses to do so, the client |
| 86 // should launch the ICurrentState::postInstallUrl after shutting down and |
| 87 // restarting the browser. |
| 88 POST_INSTALL_ACTION_RESTART_BROWSER = 4, |
| 89 |
| 90 // Similar to POST_INSTALL_ACTION_RESTART_BROWSER, but ask the user to shut |
| 91 // down all browsers. |
| 92 POST_INSTALL_ACTION_RESTART_ALL_BROWSERS = 5, |
| 93 |
| 94 // The caller should ask the user to reboot the machine. |
| 95 POST_INSTALL_ACTION_REBOOT = 6, |
| 96 } PostInstallAction; |
| 97 |
| 98 [ |
| 99 object, |
| 100 dual, |
| 101 uuid(6DB17455-4E85-46e7-9D23-E555E4B005AF), |
| 102 helpstring("IGoogleUpdate3 Interface"), |
| 103 pointer_default(unique) |
| 104 ] |
| 105 interface IGoogleUpdate3 : IDispatch { |
| 106 // TODO(Omaha): Perhaps this interface exposes helpers such as |
| 107 // RestartBrowsers, etc. |
| 108 |
| 109 // Returns the count of the AppBundles in this IGoogleUpdate3 interface. |
| 110 [id(1), propget] HRESULT Count([out, retval] long* count); |
| 111 |
| 112 // Returns an IDispatch of the AppBundle in this IGoogleUpdate3 interface at |
| 113 // the specified 0-based index. This property has the dispid of DISPID_VALUE |
| 114 // to make it the default property of IGoogleUpdate3. |
| 115 [id(DISPID_VALUE), propget] HRESULT Item([in] long index, |
| 116 [out, retval] IDispatch** bundle); |
| 117 // Returns an IDispatch to a newly created empty AppBundle. |
| 118 [id(2)] HRESULT createAppBundle([out, retval] IDispatch** app_bundle); |
| 119 } |
| 120 |
| 121 [ |
| 122 object, |
| 123 dual, |
| 124 uuid(313cfb25-4888-4fc6-9e19-764d8c5fc8f8), |
| 125 helpstring("IAppBundle Interface"), |
| 126 pointer_default(unique) |
| 127 ] |
| 128 interface IAppBundle : IDispatch { |
| 129 // TODO(omaha3): AppBundle::display_name_ is never used. Should we remove? |
| 130 [propget] HRESULT displayName([out, retval] BSTR*); |
| 131 [propput] HRESULT displayName([in] BSTR); |
| 132 |
| 133 [propget] HRESULT displayLanguage([out, retval] BSTR*); |
| 134 [propput] HRESULT displayLanguage([in] BSTR); |
| 135 |
| 136 [propget] HRESULT installSource([out, retval] BSTR*); |
| 137 [propput] HRESULT installSource([in] BSTR); |
| 138 |
| 139 [propget] HRESULT originURL([out, retval] BSTR*); |
| 140 [propput] HRESULT originURL([in] BSTR); |
| 141 |
| 142 [propget] HRESULT offlineDirectory([out, retval] BSTR* offline_dir); |
| 143 [propput] HRESULT offlineDirectory([in] BSTR offline_dir); |
| 144 |
| 145 [propget] HRESULT sessionId([out, retval] BSTR* session_id); |
| 146 [propput] HRESULT sessionId([in] BSTR session_id); |
| 147 |
| 148 // The priority property determines download speed/priority and the number/ |
| 149 // frequency of retries. Use values from the InstallPriority enum. |
| 150 [propget] HRESULT priority([out, retval] long* priority); |
| 151 [propput] HRESULT priority([in] long priority); |
| 152 |
| 153 // Returns the count of the Apps in the AppBundle. |
| 154 [id(1), propget] HRESULT Count([out, retval] long* count); |
| 155 |
| 156 // Returns an IDispatch of the App in the AppBundle at the specified 0-based |
| 157 // index. This property has the dispid of DISPID_VALUE to make it the default |
| 158 // property of IAppBundle. |
| 159 [id(DISPID_VALUE), propget] HRESULT Item([in] long index, |
| 160 [out, retval] IDispatch** app); |
| 161 |
| 162 // Impersonation and primary tokens set by the client. Typically only |
| 163 // set by the gupdatem service. The gupdatem service exposes a narrow |
| 164 // interface to medium integrity clients. When a medium integrity client calls |
| 165 // into the gupdatem service, the gupdatem service captures the token of the |
| 166 // caller, and then calls put_altTokens() on the gupdate service, so that the |
| 167 // gupdate service can use it for future download() and install() requests. |
| 168 [propput] HRESULT altTokens([in] ULONG_PTR impersonation_token, |
| 169 [in] ULONG_PTR primary_token, |
| 170 [in] DWORD caller_proc_id); |
| 171 |
| 172 // Sets a HWND to associate with the client, if any. This will be used as |
| 173 // the parent window for any dialogs that the server may need to display. |
| 174 [propput] HRESULT parentHWND([in] ULONG_PTR hwnd); |
| 175 |
| 176 // Initializes the bundle with the properties that have been set. |
| 177 [id(2)] HRESULT initialize(); |
| 178 |
| 179 // Returns an IDispatch to a new App for the specified app id. |
| 180 // The App is added to the Bundle. |
| 181 [id(3)] HRESULT createApp([in] BSTR app_id, |
| 182 [out, retval] IDispatch** app); |
| 183 |
| 184 // Returns an IDispatch to a newly created App for the specified app ID. The |
| 185 // App is populated with information from the existing installation and added |
| 186 // to the Bundle. Fails if the specified app is not installed. |
| 187 [id(4)] HRESULT createInstalledApp([in] BSTR app_id, |
| 188 [out, retval] IDispatch** app); |
| 189 |
| 190 // Creates App instances for all installed apps managed by this Omaha |
| 191 // instance. Each App is populated with information from the existing install. |
| 192 [id(5)] HRESULT createAllInstalledApps(); |
| 193 |
| 194 // These methods are non-blocking. The operation is scheduled. |
| 195 [id(6)] HRESULT checkForUpdate(); |
| 196 [id(7)] HRESULT download(); |
| 197 [id(8)] HRESULT install(); |
| 198 |
| 199 // All-in-one function for automatically updating all apps. Populates the |
| 200 // bundle then schedules the update, which includes the update check and |
| 201 // download and install, if necessary. |
| 202 [id(9)] HRESULT updateAllApps(); |
| 203 |
| 204 // These three methods are non-blocking. The operation is requested. |
| 205 [id(10)] HRESULT stop(); |
| 206 [id(11)] HRESULT pause(); |
| 207 [id(12)] HRESULT resume(); |
| 208 |
| 209 // Returns true if the bundle has an uncompleted non-blocking request. |
| 210 [id(13)] HRESULT isBusy([out, retval] VARIANT_BOOL* is_busy); |
| 211 |
| 212 // Downloads a package of an installed application. |
| 213 [id(14)] HRESULT downloadPackage([in] BSTR app_id, [in] BSTR package_name); |
| 214 |
| 215 // TODO(omaha): Define this aggregated bundle state. Is this really a property |
| 216 // or should it be getCurrentState? |
| 217 // The server and bundle are the only thing that can provide aggregated |
| 218 // time estimates for downloads. Also, aggregate percentage is not currently |
| 219 // available to the client because the total bytes to download is not |
| 220 // available from App in all post-update check states. |
| 221 // To do this, we will probably need to know the total expected download |
| 222 // size for all packages to be installed - those that are required or in use - |
| 223 // by the time the update check phase is complete. |
| 224 [id(15), propget] HRESULT currentState([out, retval] VARIANT* current_state); |
| 225 }; |
| 226 |
| 227 [ |
| 228 object, |
| 229 dual, |
| 230 uuid(D999CE21-98B3-4894-BACB-A49A1D50848F), |
| 231 helpstring("IApp Interface"), |
| 232 pointer_default(unique) |
| 233 ] |
| 234 interface IApp : IDispatch { |
| 235 // Returns a version IDispatch object. |
| 236 [id(1), propget] HRESULT currentVersion([out, retval] IDispatch** current); |
| 237 [id(2), propget] HRESULT nextVersion([out, retval] IDispatch** next); |
| 238 |
| 239 [propget] HRESULT appId([out, retval] BSTR*); |
| 240 |
| 241 [propget] HRESULT displayName([out, retval] BSTR*); |
| 242 [propput] HRESULT displayName([in] BSTR); |
| 243 |
| 244 [propget] HRESULT language([out, retval] BSTR*); |
| 245 [propput] HRESULT language([in] BSTR); |
| 246 |
| 247 [propget] HRESULT ap([out, retval] BSTR*); |
| 248 [propput] HRESULT ap([in] BSTR); |
| 249 |
| 250 [propget] HRESULT ttToken([out, retval] BSTR*); |
| 251 [propput] HRESULT ttToken([in] BSTR); |
| 252 |
| 253 [propget] HRESULT iid([out, retval] BSTR*); |
| 254 [propput] HRESULT iid([in] BSTR); |
| 255 |
| 256 [propget] HRESULT brandCode([out, retval] BSTR*); |
| 257 [propput] HRESULT brandCode([in] BSTR); |
| 258 |
| 259 [propget] HRESULT clientId([out, retval] BSTR*); |
| 260 [propput] HRESULT clientId([in] BSTR); |
| 261 |
| 262 [propget] HRESULT labels([out, retval] BSTR*); |
| 263 [propput] HRESULT labels([in] BSTR); |
| 264 |
| 265 [propget] HRESULT referralId([out, retval] BSTR*); |
| 266 [propput] HRESULT referralId([in] BSTR); |
| 267 |
| 268 // Use values from the BrowserType enum. |
| 269 [propget] HRESULT browserType([out, retval] UINT*); |
| 270 [propput] HRESULT browserType([in] UINT); |
| 271 |
| 272 [propget] HRESULT clientInstallData([out, retval] BSTR*); |
| 273 [propput] HRESULT clientInstallData([in] BSTR); |
| 274 |
| 275 [propget] HRESULT serverInstallDataIndex([out, retval] BSTR*); |
| 276 [propput] HRESULT serverInstallDataIndex([in] BSTR); |
| 277 |
| 278 // Set as soon as possible. Error pings are disabled until set to true. |
| 279 [propget] HRESULT isEulaAccepted([out, retval] VARIANT_BOOL*); |
| 280 [propput] HRESULT isEulaAccepted([in] VARIANT_BOOL); |
| 281 |
| 282 [propget] HRESULT usageStatsEnable([out, retval] UINT*); |
| 283 [propput] HRESULT usageStatsEnable([in] UINT); |
| 284 |
| 285 [propget] HRESULT installTimeDiffSec([out, retval] UINT*); |
| 286 |
| 287 // Returns an ICurrentState interface. The object underlying the interface has |
| 288 // static data that does not get updated as the server state changes. To get |
| 289 // the most "current" state, the currentState property needs to be queried |
| 290 // again. |
| 291 [propget] HRESULT currentState([out, retval] IDispatch**); |
| 292 }; |
| 293 |
| 294 [ |
| 295 object, |
| 296 dual, |
| 297 uuid(BCDCB538-01C0-46d1-A6A7-52F4D021C272), |
| 298 helpstring("IAppVersion Interface"), |
| 299 pointer_default(unique) |
| 300 ] |
| 301 interface IAppVersion : IDispatch { |
| 302 [propget] HRESULT version([out, retval] BSTR*); |
| 303 |
| 304 // [propget] HRESULT installManifest([out, retval] BSTR*); |
| 305 |
| 306 // Returns the count of the Packages in the AppVersion. |
| 307 [propget] HRESULT packageCount([out, retval] long* count); |
| 308 |
| 309 // Returns an IDispatch of the Package in the AppVersion at the specified |
| 310 // 0-based index. |
| 311 [propget] HRESULT package([in] long index, |
| 312 [out, retval] IDispatch** package); |
| 313 }; |
| 314 |
| 315 [ |
| 316 object, |
| 317 dual, |
| 318 uuid(DCAB8386-4F03-4dbd-A366-D90BC9F68DE6), |
| 319 helpstring("IPackage Interface"), |
| 320 pointer_default(unique) |
| 321 ] |
| 322 interface IPackage : IDispatch { |
| 323 // Retrieves the package from the package cache and copies it to the |
| 324 // directory provided. Returns an error is the package is not available |
| 325 // locally. |
| 326 [id(1)] HRESULT get([in] BSTR dir); |
| 327 |
| 328 // Returns true if the package has been downloaded and is available |
| 329 // locally. |
| 330 [propget] HRESULT isAvailable([out, retval] VARIANT_BOOL*); |
| 331 |
| 332 // Returns the manifest name of the package. |
| 333 [propget] HRESULT filename([out, retval] BSTR*); |
| 334 }; |
| 335 |
| 336 // TODO(omaha3): We should figure out what else we are going to want in this |
| 337 // interface before dogfood even if we do not implement it. |
| 338 [ |
| 339 object, |
| 340 dual, |
| 341 uuid(247954F9-9EDC-4E68-8CC3-150C2B89EADF), |
| 342 helpstring("ICurrentState Interface"), |
| 343 pointer_default(unique) |
| 344 ] |
| 345 interface ICurrentState : IDispatch { |
| 346 // This interface is exposed to web clients! |
| 347 // TODO(omaha3): Update valid comments once we settle on an implementation. |
| 348 |
| 349 // A value from the CurrentState enum. This value determines which of the |
| 350 // properties below are valid. |
| 351 [propget] HRESULT stateValue([out, retval] LONG*); |
| 352 |
| 353 // The remaining properties are only valid in the specified states. For all |
| 354 // other states, the values are not specified. |
| 355 |
| 356 // This property is valid only when stateValue is STATE_UPDATE_AVAILABLE. |
| 357 [propget] HRESULT availableVersion([out, retval] BSTR*); |
| 358 |
| 359 // The following three properties are only valid when stateValue is |
| 360 // STATE_WAITING_TO_DOWNLOAD, STATE_RETRYING_DOWNLOAD, STATE_DOWNLOADING, |
| 361 // STATE_DOWNLOAD_COMPLETE, STATE_EXTRACTING, |
| 362 // STATE_APPLYING_DIFFERENTIAL_PATCH, or STATE_READY_TO_INSTALL. |
| 363 |
| 364 // Bytes downloaded so far. |
| 365 [propget] HRESULT bytesDownloaded([out, retval] ULONG*); |
| 366 |
| 367 // Total bytes to download. |
| 368 [propget] HRESULT totalBytesToDownload([out, retval] ULONG*); |
| 369 |
| 370 // Estimated download time remaining in ms. -1 indicates unknown. |
| 371 // Progress may not always be available, so clients should handle the -1 case. |
| 372 [propget] HRESULT downloadTimeRemainingMs([out, retval] LONG*); |
| 373 |
| 374 [propget] HRESULT nextRetryTime([out, retval] ULONGLONG*); |
| 375 |
| 376 // TODO(omaha 3): Need some way to indicate reconnecting, retrying, etc. |
| 377 |
| 378 // The following two properties are only valid when stateValue is |
| 379 // STATE_INSTALLING or STATE_INSTALL_COMPLETE. |
| 380 |
| 381 // Current install progress in percentage from 0 to 100. -1 indicates unknown. |
| 382 // Progress may not always be available, so clients should handle the -1 case. |
| 383 [propget] HRESULT installProgress([out, retval] LONG*); |
| 384 |
| 385 // Estimated download time remaining in ms. -1 indicates unknown. |
| 386 // Progress may not always be available, so clients should handle the -1 case. |
| 387 [propget] HRESULT installTimeRemainingMs([out, retval] LONG*); |
| 388 |
| 389 // The following four properties are only valid when stateValue is |
| 390 // STATE_ERROR: |
| 391 |
| 392 // Returns true if the app has been canceled. |
| 393 [propget] HRESULT isCanceled([out, retval] VARIANT_BOOL* is_canceled); |
| 394 |
| 395 // Error code. |
| 396 [propget] HRESULT errorCode([out, retval] LONG*); |
| 397 |
| 398 // Error extra code. |
| 399 [propget] HRESULT extraCode1([out, retval] LONG*); |
| 400 |
| 401 // The following three properties are only valid when stateValue is |
| 402 // STATE_ERROR or STATE_INSTALL_COMPLETE. |
| 403 // TODO(omaha3): If STATE_DOWNLOAD_COMPLETE or STATE_READY_TO_INSTALL becomes |
| 404 // a terminal state, does it support completion messages? |
| 405 |
| 406 // Completion message, localized in the specified language. |
| 407 // TODO(omaha3): If we're going to have bundle error messages too, should the |
| 408 // language be at bundle level? Should bundle have its own language setter? |
| 409 [propget] HRESULT completionMessage([out, retval] BSTR*); |
| 410 |
| 411 // Application installer result code. This is to be used as additional |
| 412 // information only. Success/failure should be determined using errorCode. |
| 413 // This is an error if errorCode is GOOPDATEINSTALL_E_INSTALLER_FAILED. |
| 414 [propget] HRESULT installerResultCode([out, retval] LONG*); |
| 415 |
| 416 // Application installer extra code. |
| 417 [propget] HRESULT installerResultExtraCode1([out, retval] LONG*); |
| 418 |
| 419 // A command that needs to be launched by the client after installation. |
| 420 [propget] HRESULT postInstallLaunchCommandLine([out, retval] BSTR*); |
| 421 |
| 422 // URL to be launched after restarting the browser. |
| 423 [propget] HRESULT postInstallUrl([out, retval] BSTR*); |
| 424 |
| 425 // Returns a PostInstallAction value indicating the action to be taken by the |
| 426 // client after installation. |
| 427 [propget] HRESULT postInstallAction([out, retval] LONG*); |
| 428 } |
| 429 |
| 430 [ |
| 431 object, |
| 432 dual, |
| 433 uuid(4E223325-C16B-4eeb-AEDC-19AA99A237FA), |
| 434 helpstring("IRegistrationUpdateHook Interface"), |
| 435 pointer_default(unique), |
| 436 ] |
| 437 interface IRegistrationUpdateHook : IDispatch { |
| 438 HRESULT UpdateRegistry([in] BSTR app_id, [in] VARIANT_BOOL is_machine); |
| 439 }; |
| 440 |
| 441 [ |
| 442 object, |
| 443 uuid(b3a47570-0a85-4aea-8270-529d47899603), |
| 444 helpstring("ICredentialDialog Interface"), |
| 445 pointer_default(unique), |
| 446 ] |
| 447 interface ICredentialDialog : IUnknown { |
| 448 HRESULT QueryUserForCredentials([in] ULONG_PTR owner_hwnd, |
| 449 [in] BSTR server, |
| 450 [in] BSTR message, |
| 451 [out] BSTR* username, |
| 452 [out] BSTR* password); |
| 453 }; |
| 454 |
| 455 // BEGIN gupdatem interfaces. |
| 456 |
| 457 // The following interfaces are exposed as a narrower version of the |
| 458 // IGoogleUpdate3 interface from the gupdatem service. These interfaces are |
| 459 // meant for use from medium and low integrity clients. |
| 460 |
| 461 [ |
| 462 object, |
| 463 dual, |
| 464 uuid(494B20CF-282E-4BDD-9F5D-B70CB09D351E), |
| 465 helpstring("IGoogleUpdate3Web Interface"), |
| 466 pointer_default(unique), |
| 467 ] |
| 468 interface IGoogleUpdate3Web : IDispatch { |
| 469 HRESULT createAppBundleWeb([out, retval] IDispatch** app_bundle_web); |
| 470 }; |
| 471 |
| 472 [ |
| 473 object, |
| 474 uuid(2D363682-561D-4c3a-81C6-F2F82107562A), |
| 475 helpstring("IGoogleUpdate3WebSecurity Interface"), |
| 476 pointer_default(unique), |
| 477 ] |
| 478 interface IGoogleUpdate3WebSecurity : IUnknown { |
| 479 HRESULT setOriginURL([in] BSTR origin_url); |
| 480 }; |
| 481 |
| 482 [ |
| 483 object, |
| 484 dual, |
| 485 uuid(DD42475D-6D46-496a-924E-BD5630B4CBBA), |
| 486 helpstring("IAppBundleWeb Interface"), |
| 487 pointer_default(unique), |
| 488 ] |
| 489 interface IAppBundleWeb : IDispatch { |
| 490 [id(2)] HRESULT createApp([in] BSTR app_guid, |
| 491 [in] BSTR brand_code, |
| 492 [in] BSTR language, |
| 493 [in] BSTR ap); |
| 494 [id(3)] HRESULT createInstalledApp([in] BSTR app_id); |
| 495 [id(4)] HRESULT createAllInstalledApps(); |
| 496 |
| 497 [propget] HRESULT displayLanguage([out, retval] BSTR*); |
| 498 [propput] HRESULT displayLanguage([in] BSTR); |
| 499 |
| 500 [propput] HRESULT parentHWND([in] ULONG_PTR hwnd); |
| 501 |
| 502 [propget] HRESULT length([out, retval] int* index); |
| 503 [id(DISPID_VALUE), propget] HRESULT appWeb( |
| 504 [in] int index, [out, retval] IDispatch** app_web); |
| 505 |
| 506 HRESULT initialize(); |
| 507 |
| 508 HRESULT checkForUpdate(); |
| 509 HRESULT download(); |
| 510 HRESULT install(); |
| 511 |
| 512 HRESULT pause(); |
| 513 HRESULT resume(); |
| 514 HRESULT cancel(); |
| 515 |
| 516 HRESULT downloadPackage([in] BSTR app_id, [in] BSTR package_name); |
| 517 |
| 518 [propget] HRESULT currentState([out, retval] VARIANT* current_state); |
| 519 }; |
| 520 |
| 521 [ |
| 522 object, |
| 523 dual, |
| 524 uuid(C6398F88-69CE-44ac-B6A7-1D3E2AA46679), |
| 525 helpstring("IAppWeb Interface"), |
| 526 pointer_default(unique), |
| 527 ] |
| 528 interface IAppWeb : IDispatch { |
| 529 [propget] HRESULT appId([out, retval] BSTR*); |
| 530 |
| 531 // Returns an IAppVersionWeb IDispatch object. |
| 532 [propget] HRESULT currentVersionWeb([out, retval] IDispatch** current); |
| 533 [propget] HRESULT nextVersionWeb([out, retval] IDispatch** next); |
| 534 |
| 535 HRESULT cancel(); |
| 536 [propget] HRESULT currentState([out, retval] IDispatch** current_state); |
| 537 HRESULT launch(); |
| 538 HRESULT uninstall(); |
| 539 }; |
| 540 |
| 541 [ |
| 542 object, |
| 543 dual, |
| 544 uuid(0CD01D1E-4A1C-489d-93B9-9B6672877C57), |
| 545 helpstring("IAppVersionWeb Interface"), |
| 546 pointer_default(unique) |
| 547 ] |
| 548 interface IAppVersionWeb : IDispatch { |
| 549 [propget] HRESULT version([out, retval] BSTR*); |
| 550 |
| 551 // Returns the count of the Packages in the AppVersion. |
| 552 [propget] HRESULT packageCount([out, retval] long* count); |
| 553 |
| 554 // TODO(omaha3): Implement this after a security review. |
| 555 // Returns an IDispatch of the Package in the AppVersion at the specified |
| 556 // 0-based index. |
| 557 [propget] HRESULT packageWeb([in] long index, |
| 558 [out, retval] IDispatch** package); |
| 559 }; |
| 560 |
| 561 [ |
| 562 object, |
| 563 dual, |
| 564 uuid(2E629606-312A-482f-9B12-2C4ABF6F0B6D), |
| 565 helpstring("ICoCreateAsyncStatus Interface"), |
| 566 pointer_default(unique) |
| 567 ] |
| 568 interface ICoCreateAsyncStatus : IDispatch { |
| 569 [propget] HRESULT isDone([out, retval] VARIANT_BOOL* is_done); |
| 570 [propget] HRESULT completionHResult([out, retval] LONG* hr); |
| 571 [propget] HRESULT createdInstance([out, retval] IDispatch** instance); |
| 572 }; |
| 573 |
| 574 [ |
| 575 object, |
| 576 uuid(DAB1D343-1B2A-47f9-B445-93DC50704BFE), |
| 577 helpstring("ICoCreateAsync Interface"), |
| 578 pointer_default(unique) |
| 579 ] |
| 580 interface ICoCreateAsync : IUnknown { |
| 581 HRESULT createOmahaMachineServerAsync( |
| 582 [in] BSTR origin_url, |
| 583 [in] BOOL create_elevated, |
| 584 [out, retval] ICoCreateAsyncStatus** status); |
| 585 }; |
| 586 |
| 587 // END gupdatem interfaces. |
| 588 |
| 589 // BEGIN Legacy google_update_idl interfaces. |
| 590 |
11 [ | 591 [ |
12 object, | 592 object, |
13 uuid(5B25A8DC-1780-4178-A629-6BE8B8DEFAA2), | 593 uuid(5B25A8DC-1780-4178-A629-6BE8B8DEFAA2), |
14 oleautomation, | 594 oleautomation, |
15 nonextensible, | 595 nonextensible, |
16 pointer_default(unique) | 596 pointer_default(unique) |
17 ] | 597 ] |
18 interface IBrowserHttpRequest2 : IUnknown { | 598 interface IBrowserHttpRequest2 : IUnknown { |
19 // This method will send request/data from the browser process. | 599 // This method will send request/data from the browser process. |
20 // @param url URL where request will be send. | 600 // @param url URL where request will be send. |
21 // @param post_data POST data, if any. Can be NULL. | 601 // @param post_data POST data, if any. Can be NULL. |
22 // @param request_headers HTTP request headers, if any. Can be NULL. | 602 // @param request_headers HTTP request headers, if any. Can be NULL. |
23 // @param response_headers_needed HTTP response headers that are needed. | 603 // @param response_headers_needed HTTP response headers that are needed. |
24 // Should be one of the values listed here: | 604 // Should be one of the values listed here: |
25 // http://go/queryinfoflags | 605 // http://msdn.microsoft.com/aa385351.aspx |
26 // The input is a SAFEARRAY of DWORD. Can be a | 606 // The input is a SAFEARRAY of DWORD. Can be a |
27 // VT_EMPTY. | 607 // VT_EMPTY. |
28 // @param response_headers HTTP response headers, returned as SAFEARRAY | 608 // @param response_headers HTTP response headers, returned as SAFEARRAY |
29 // of BSTR. The values corresponding one-to-one | 609 // of BSTR. The values corresponding one-to-one |
30 // with the response_headers_needed values. Can | 610 // with the response_headers_needed values. Can |
31 // be NULL if response_headers_needed==VT_EMPTY | 611 // be NULL if response_headers_needed==VT_EMPTY |
32 // @param response_code HTTP response code. | 612 // @param response_code HTTP response code. |
33 // @param cache_filename Cache file that contains the response data. | 613 // @param cache_filename Cache file that contains the response data. |
34 HRESULT Send([in] BSTR url, | 614 HRESULT Send([in] BSTR url, |
35 [in] BSTR post_data, | 615 [in] BSTR post_data, |
(...skipping 23 matching lines...) Expand all Loading... |
59 // @param app_id Unique id to identify the calling client application | 639 // @param app_id Unique id to identify the calling client application |
60 // @param event_id Unique id for the command | 640 // @param event_id Unique id for the command |
61 // @param caller_proc_id The process id of the calling process | 641 // @param caller_proc_id The process id of the calling process |
62 // @param proc_handle The process handle valid in the caller's context | 642 // @param proc_handle The process handle valid in the caller's context |
63 HRESULT LaunchCmdElevated([in, string] const WCHAR* app_guid, | 643 HRESULT LaunchCmdElevated([in, string] const WCHAR* app_guid, |
64 [in, string] const WCHAR* cmd_id, | 644 [in, string] const WCHAR* cmd_id, |
65 [in] DWORD caller_proc_id, | 645 [in] DWORD caller_proc_id, |
66 [out] ULONG_PTR* proc_handle); | 646 [out] ULONG_PTR* proc_handle); |
67 }; | 647 }; |
68 | 648 |
| 649 [ |
| 650 object, |
| 651 oleautomation, |
| 652 uuid(5CCCB0EF-7073-4516-8028-4C628D0C8AAB), |
| 653 helpstring("Google Update IOneClickProcessLauncher Interface"), |
| 654 pointer_default(unique) |
| 655 ] |
| 656 interface IOneClickProcessLauncher : IUnknown { |
| 657 HRESULT LaunchAppCommand([in, string] const WCHAR* app_guid, |
| 658 [in, string] const WCHAR* cmd_id); |
| 659 }; |
| 660 |
69 typedef enum { | 661 typedef enum { |
70 COMPLETION_CODE_SUCCESS = 1, | 662 COMPLETION_CODE_SUCCESS = 1, |
71 COMPLETION_CODE_SUCCESS_CLOSE_UI, | 663 COMPLETION_CODE_SUCCESS_CLOSE_UI, |
72 COMPLETION_CODE_ERROR, | 664 COMPLETION_CODE_ERROR, |
73 COMPLETION_CODE_RESTART_ALL_BROWSERS, | 665 COMPLETION_CODE_RESTART_ALL_BROWSERS, |
74 COMPLETION_CODE_REBOOT, | 666 COMPLETION_CODE_REBOOT, |
75 COMPLETION_CODE_RESTART_BROWSER, | 667 COMPLETION_CODE_RESTART_BROWSER, |
76 COMPLETION_CODE_RESTART_ALL_BROWSERS_NOTICE_ONLY, | 668 COMPLETION_CODE_RESTART_ALL_BROWSERS_NOTICE_ONLY, |
77 COMPLETION_CODE_REBOOT_NOTICE_ONLY, | 669 COMPLETION_CODE_REBOOT_NOTICE_ONLY, |
78 COMPLETION_CODE_RESTART_BROWSER_NOTICE_ONLY, | 670 COMPLETION_CODE_RESTART_BROWSER_NOTICE_ONLY, |
79 COMPLETION_CODE_RUN_COMMAND, | 671 COMPLETION_CODE_RUN_COMMAND, |
80 } CompletionCodes; | 672 } LegacyCompletionCodes; |
81 | 673 |
82 [ | 674 [ |
83 object, | 675 object, |
84 oleautomation, | 676 oleautomation, |
85 uuid(1C642CED-CA3B-4013-A9DF-CA6CE5FF6503), | 677 uuid(1C642CED-CA3B-4013-A9DF-CA6CE5FF6503), |
86 helpstring("GoogleUpdate UI-specific events Interface"), | 678 helpstring("GoogleUpdate UI-specific events Interface"), |
87 pointer_default(unique) | 679 pointer_default(unique) |
88 ] | 680 ] |
89 interface IProgressWndEvents : IUnknown { | 681 interface IProgressWndEvents : IUnknown { |
90 // The UI is closing down. The user has clicked on either the "X" or the | 682 // The UI is closing down. The user has clicked on either the "X" or the |
(...skipping 26 matching lines...) Expand all Loading... |
117 ] | 709 ] |
118 interface IJobObserver : IUnknown { | 710 interface IJobObserver : IUnknown { |
119 HRESULT OnShow(); | 711 HRESULT OnShow(); |
120 HRESULT OnCheckingForUpdate(); | 712 HRESULT OnCheckingForUpdate(); |
121 HRESULT OnUpdateAvailable([in, string] const WCHAR* version_string); | 713 HRESULT OnUpdateAvailable([in, string] const WCHAR* version_string); |
122 HRESULT OnWaitingToDownload(); | 714 HRESULT OnWaitingToDownload(); |
123 HRESULT OnDownloading([in] int time_remaining_ms, [in] int pos); | 715 HRESULT OnDownloading([in] int time_remaining_ms, [in] int pos); |
124 HRESULT OnWaitingToInstall(); | 716 HRESULT OnWaitingToInstall(); |
125 HRESULT OnInstalling(); | 717 HRESULT OnInstalling(); |
126 HRESULT OnPause(); | 718 HRESULT OnPause(); |
127 HRESULT OnComplete([in] CompletionCodes code, | 719 HRESULT OnComplete([in] LegacyCompletionCodes code, |
128 [in, string] const WCHAR* reserved); | 720 [in, string] const WCHAR* reserved); |
129 HRESULT SetEventSink([in] IProgressWndEvents* ui_sink); | 721 HRESULT SetEventSink([in] IProgressWndEvents* ui_sink); |
130 }; | 722 }; |
131 | 723 |
132 // TODO(ganesh): Component story. | |
133 // TODO(ganesh): Should CheckForUpdate be synchronous? We can avoid the | |
134 // observer. However, it may block the UI. | |
135 // TODO(ganesh): On-Demand Installs. | |
136 [ | 724 [ |
137 object, | 725 object, |
138 oleautomation, | 726 oleautomation, |
139 uuid(31AC3F11-E5EA-4a85-8A3D-8E095A39C27B), | 727 uuid(31AC3F11-E5EA-4a85-8A3D-8E095A39C27B), |
140 helpstring("IGoogleUpdate Interface"), | 728 helpstring("IGoogleUpdate Interface"), |
141 pointer_default(unique) | 729 pointer_default(unique) |
142 ] | 730 ] |
143 interface IGoogleUpdate : IUnknown { | 731 interface IGoogleUpdate : IUnknown { |
144 // @param guid The guid for the app to be updated. | 732 // @param guid The guid for the app to be updated. |
145 // @param observer The eventing interface. | 733 // @param observer The eventing interface. |
(...skipping 21 matching lines...) Expand all Loading... |
167 // @param app_id Unique id to identify the calling client application | 755 // @param app_id Unique id to identify the calling client application |
168 // @param event_id Unique id for the command | 756 // @param event_id Unique id for the command |
169 // @param caller_proc_id The process id of the calling process | 757 // @param caller_proc_id The process id of the calling process |
170 // @param proc_handle The process handle valid in the caller's context | 758 // @param proc_handle The process handle valid in the caller's context |
171 HRESULT LaunchCmdElevated([in, string] const WCHAR* app_guid, | 759 HRESULT LaunchCmdElevated([in, string] const WCHAR* app_guid, |
172 [in, string] const WCHAR* cmd_id, | 760 [in, string] const WCHAR* cmd_id, |
173 [in] DWORD caller_proc_id, | 761 [in] DWORD caller_proc_id, |
174 [out] ULONG_PTR* proc_handle); | 762 [out] ULONG_PTR* proc_handle); |
175 }; | 763 }; |
176 | 764 |
| 765 // END Legacy google_update_idl interfaces. |
| 766 |
177 [ | 767 [ |
178 uuid(7E6CD20B-8688-4960-96D9-B979471577B8), | 768 uuid(655DD85A-3C0D-4674-9C58-AF7168C5861E), |
179 version(1.0), | 769 version(1.0), |
180 helpstring("Google Update Type Library") | 770 helpstring("Google Update 3.0 Type Library") |
181 ] | 771 ] |
182 library GoogleUpdateLib { | 772 library GoogleUpdate3Lib { |
183 importlib("stdole2.tlb"); | 773 importlib("stdole2.tlb"); |
| 774 |
| 775 // These Interfaces are forward declared to ensure that they are described in |
| 776 // the generated TLB file. This is required for ATL to correctly implement the |
| 777 // corresponding IDispatch interfaces. |
| 778 interface IGoogleUpdate3; |
| 779 interface IAppBundle; |
| 780 interface IApp; |
| 781 interface IAppVersion; |
| 782 interface IPackage; |
| 783 interface ICurrentState; |
| 784 |
| 785 interface IGoogleUpdate3Web; |
| 786 interface IAppBundleWeb; |
| 787 interface IAppWeb; |
| 788 interface IAppVersionWeb; |
| 789 interface ICoCreateAsyncStatus; |
| 790 |
| 791 [ |
| 792 uuid(022105BD-948A-40c9-AB42-A3300DDF097F), |
| 793 helpstring("GoogleUpdate3 Class for per-user applications") |
| 794 ] |
| 795 coclass GoogleUpdate3UserClass { |
| 796 [default] interface IDispatch; |
| 797 } |
| 798 |
| 799 [ |
| 800 uuid(4EB61BAC-A3B6-4760-9581-655041EF4D69), |
| 801 helpstring("GoogleUpdate3 Service Class for machine applications") |
| 802 ] |
| 803 coclass GoogleUpdate3ServiceClass { |
| 804 [default] interface IDispatch; |
| 805 } |
| 806 |
| 807 [ |
| 808 uuid(22181302-A8A6-4f84-A541-E5CBFC70CC43), |
| 809 helpstring("GoogleUpdate3Web for user applications") |
| 810 ] |
| 811 coclass GoogleUpdate3WebUserClass { |
| 812 [default] interface IDispatch; |
| 813 } |
| 814 |
| 815 [ |
| 816 uuid(8A1D4361-2C08-4700-A351-3EAA9CBFF5E4), |
| 817 helpstring("Pass-through broker for the GoogleUpdate3WebServiceClass") |
| 818 ] |
| 819 coclass GoogleUpdate3WebMachineClass { |
| 820 [default] interface IDispatch; |
| 821 } |
| 822 |
| 823 [ |
| 824 uuid(534F5323-3569-4f42-919D-1E1CF93E5BF6), |
| 825 helpstring("GoogleUpdate3Web") |
| 826 ] |
| 827 coclass GoogleUpdate3WebServiceClass { |
| 828 [default] interface IDispatch; |
| 829 } |
| 830 |
| 831 [ |
| 832 uuid(598FE0E5-E02D-465d-9A9D-37974A28FD42), |
| 833 helpstring("Fallback mechanism if GoogleUpdate3WebServiceClass fails") |
| 834 ] |
| 835 coclass GoogleUpdate3WebMachineFallbackClass { |
| 836 [default] interface IDispatch; |
| 837 } |
| 838 |
| 839 [ |
| 840 uuid(E8CF3E55-F919-49d9-ABC0-948E6CB34B9F), |
| 841 helpstring("CurrentStateUserClass") |
| 842 ] |
| 843 coclass CurrentStateUserClass { |
| 844 [default] interface ICurrentState; |
| 845 } |
| 846 |
| 847 [ |
| 848 uuid(9D6AA569-9F30-41ad-885A-346685C74928), |
| 849 helpstring("CurrentStateMachineClass") |
| 850 ] |
| 851 coclass CurrentStateMachineClass { |
| 852 [default] interface ICurrentState; |
| 853 } |
| 854 |
| 855 [ |
| 856 uuid(7DE94008-8AFD-4c70-9728-C6FBFFF6A73E), |
| 857 helpstring("CoCreateAsyncClass") |
| 858 ] |
| 859 coclass CoCreateAsyncClass { |
| 860 [default] interface IUnknown; |
| 861 } |
| 862 |
| 863 [ |
| 864 uuid(e67be843-bbbe-4484-95fb-05271ae86750), |
| 865 helpstring("CredentialDialogUserClass") |
| 866 ] |
| 867 coclass CredentialDialogUserClass { |
| 868 [default] interface IUnknown; |
| 869 } |
| 870 |
| 871 [ |
| 872 uuid(25461599-633d-42b1-84fb-7cd68d026e53), |
| 873 helpstring("CredentialDialogMachineClass") |
| 874 ] |
| 875 coclass CredentialDialogMachineClass { |
| 876 [default] interface IUnknown; |
| 877 } |
| 878 |
| 879 // BEGIN Legacy google_update_idl coclasses. |
| 880 |
184 [ | 881 [ |
185 uuid(ABC01078-F197-4b0b-ADBC-CFE684B39C82), | 882 uuid(ABC01078-F197-4b0b-ADBC-CFE684B39C82), |
186 helpstring("ProcessLauncherClass Class") | 883 helpstring("ProcessLauncherClass Class") |
187 ] | 884 ] |
188 coclass ProcessLauncherClass { | 885 coclass ProcessLauncherClass { |
189 [default] interface IProcessLauncher; | 886 [default] interface IUnknown; |
190 } | |
191 | |
192 // This coclass declaration exists only for the purpose of forcing | |
193 // ::RegisterTypeLib() to register the interfaces within. This is | |
194 // required so that we can marshal/unmarshal the interfaces using the TypeLib | |
195 // marshaler. | |
196 [ | |
197 uuid(9564861C-3469-4c9a-956A-74D5690790E6), | |
198 helpstring("InterfaceRegistrar Class") | |
199 ] | |
200 coclass InterfaceRegistrar { | |
201 [default] interface IBrowserHttpRequest2; | |
202 interface IJobObserver; | |
203 interface IProgressWndEvents; | |
204 } | 887 } |
205 | 888 |
206 [ | 889 [ |
| 890 uuid(51F9E8EF-59D7-475b-A106-C7EA6F30C119), |
| 891 helpstring("OneClickUserProcessLauncherClass Class") |
| 892 ] |
| 893 coclass OneClickUserProcessLauncherClass { |
| 894 [default] interface IOneClickProcessLauncher; |
| 895 } |
| 896 |
| 897 [ |
| 898 uuid(AAD4AE2E-D834-46d4-8B09-490FAC9C722B), |
| 899 helpstring("OneClickMachineProcessLauncherClass Class") |
| 900 ] |
| 901 coclass OneClickMachineProcessLauncherClass { |
| 902 [default] interface IOneClickProcessLauncher; |
| 903 } |
| 904 |
| 905 [ |
207 uuid(2F0E2680-9FF5-43c0-B76E-114A56E93598), | 906 uuid(2F0E2680-9FF5-43c0-B76E-114A56E93598), |
208 helpstring("OnDemand updates for per-user applications.") | 907 helpstring("OnDemand updates for per-user applications.") |
209 ] | 908 ] |
210 coclass OnDemandUserAppsClass { | 909 coclass OnDemandUserAppsClass { |
211 [default] interface IGoogleUpdate; | 910 [default] interface IUnknown; |
212 } | 911 } |
213 | 912 |
214 [ | 913 [ |
215 uuid(6F8BD55B-E83D-4a47-85BE-81FFA8057A69), | 914 uuid(6F8BD55B-E83D-4a47-85BE-81FFA8057A69), |
216 helpstring("OnDemand updates for per-machine applications.") | 915 helpstring("OnDemand pass-through broker for machine applications.") |
217 ] | 916 ] |
218 coclass OnDemandMachineAppsClass { | 917 coclass OnDemandMachineAppsClass { |
219 [default] interface IGoogleUpdate; | 918 [default] interface IUnknown; |
220 } | 919 } |
221 | 920 |
222 [ | 921 [ |
| 922 uuid(9465B4B4-5216-4042-9A2C-754D3BCDC410), |
| 923 helpstring("OnDemand updates for per-machine applications.") |
| 924 ] |
| 925 coclass OnDemandMachineAppsServiceClass { |
| 926 [default] interface IUnknown; |
| 927 } |
| 928 |
| 929 [ |
| 930 uuid(B3D28DBD-0DFA-40e4-8071-520767BADC7E), |
| 931 helpstring("Fallback for if OnDemandMachineAppsServiceClass fails.") |
| 932 ] |
| 933 coclass OnDemandMachineAppsFallbackClass { |
| 934 [default] interface IUnknown; |
| 935 } |
| 936 |
| 937 [ |
223 uuid(E225E692-4B47-4777-9BED-4FD7FE257F0E), | 938 uuid(E225E692-4B47-4777-9BED-4FD7FE257F0E), |
224 helpstring("GoogleUpdateCore Class") | 939 helpstring("GoogleUpdateCore Class") |
225 ] | 940 ] |
226 coclass GoogleUpdateCoreClass | 941 coclass GoogleUpdateCoreClass |
227 { | 942 { |
228 [default] interface IGoogleUpdateCore; | 943 [default] interface IUnknown; |
229 } | 944 } |
230 | 945 |
| 946 [ |
| 947 uuid(9B2340A0-4068-43d6-B404-32E27217859D), |
| 948 helpstring("GoogleUpdateCore Machine Class") |
| 949 ] |
| 950 coclass GoogleUpdateCoreMachineClass |
| 951 { |
| 952 [default] interface IUnknown; |
| 953 } |
| 954 |
| 955 // END Legacy google_update_idl coclasses. |
231 }; | 956 }; |
OLD | NEW |