APIs

1. In the method definition of the following APIs, the value after the colon (:) is the return value type of the method. For example, in the method definition checkSystemRequirements():Promise<Result>:

- Method name: checkSystemRequirements

- Return value type: Promise<Result>, which indicates a Promise object is returned.

2. For details about how to use promises, visit https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Asynchronous/Promises.

1
2
3
4

promise.then( 
    function(result) { /* handle a successful result */ }, 
    function(error) { /* handle an error */ 
});

The returned result and error of web SDK APIs use the same external structure.

- For details about the result structure, see Table 1.

- For details about the error structure, see Table 3.