Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
5df2c931
D
Docs
项目概览
OpenHarmony
/
Docs
接近 2 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
5df2c931
编写于
5月 12, 2022
作者:
O
openharmony_ci
提交者:
Gitee
5月 12, 2022
浏览文件
操作
浏览文件
下载
差异文件
!3955 issuse修改
Merge pull request !3955 from 孙悦/master
上级
6f29a110
a8e173ad
变更
5
隐藏空白更改
内联
并排
Showing
5 changed file
with
396 addition
and
301 deletion
+396
-301
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
+16
-16
zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md
...plication-dev/reference/apis/js-apis-inputmethodengine.md
+87
-67
zh-cn/application-dev/reference/apis/js-apis-request.md
zh-cn/application-dev/reference/apis/js-apis-request.md
+110
-83
zh-cn/application-dev/reference/apis/js-apis-system-time.md
zh-cn/application-dev/reference/apis/js-apis-system-time.md
+88
-65
zh-cn/application-dev/reference/apis/js-apis-wallpaper.md
zh-cn/application-dev/reference/apis/js-apis-wallpaper.md
+95
-70
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
浏览文件 @
5df2c931
...
@@ -40,13 +40,13 @@ getInputMethodController(): InputMethodController
...
@@ -40,13 +40,13 @@ getInputMethodController(): InputMethodController
**系统能力**
:SystemCapability.Miscservices.InputMethodFramework
**系统能力**
:SystemCapability.Miscservices.InputMethodFramework
-
返回值
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| [InputMethodController](#InputMethodController) | 回调返回当前客户端实例。 |
| [InputMethodController](#InputMethodController) | 回调返回当前客户端实例。 |
-
示例
**示例:**
```
js
```
js
var
InputMethodController
=
inputMethod
.
getInputMethodController
();
var
InputMethodController
=
inputMethod
.
getInputMethodController
();
```
```
...
@@ -58,14 +58,14 @@ getInputMethodSetting(): InputMethodSetting
...
@@ -58,14 +58,14 @@ getInputMethodSetting(): InputMethodSetting
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
返回值
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ----------------------------------------- | ---------------------------- |
| ----------------------------------------- | ---------------------------- |
|
[
InputMethodSetting
](
#InputMethodSetting
)
| 回调返回当前客户端设置实例。 |
|
[
InputMethodSetting
](
#InputMethodSetting
)
| 回调返回当前客户端设置实例。 |
-
示例
**示例:**
```
js
```
js
var
InputMethodSetting
=
inputMethod
.
getInputMethodSetting
();
var
InputMethodSetting
=
inputMethod
.
getInputMethodSetting
();
```
```
...
@@ -82,13 +82,13 @@ stopInput(callback: AsyncCallback<boolean>): void
...
@@ -82,13 +82,13 @@ stopInput(callback: AsyncCallback<boolean>): void
**系统能力**
:SystemCapability.Miscservices.InputMethodFramework
**系统能力**
:SystemCapability.Miscservices.InputMethodFramework
-
参数
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 返回输入法隐藏是否成功。 |
| callback | AsyncCallback
<
boolean
>
| 是 | 返回输入法隐藏是否成功。 |
-
示例
**示例:**
```
js
```
js
InputMethodController
.
stopInput
((
error
)
=>
{
InputMethodController
.
stopInput
((
error
)
=>
{
...
@@ -104,13 +104,13 @@ stopInput(): Promise<boolean>
...
@@ -104,13 +104,13 @@ stopInput(): Promise<boolean>
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
返回值
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
boolean
>
| 返回输入法隐藏是否成功。 |
| Promise
<
boolean
>
| 返回输入法隐藏是否成功。 |
-
示例
**示例:**
```
js
```
js
...
@@ -130,12 +130,12 @@ listInputMethod(callback: AsyncCallback<Array<InputMethodProperty>>)
...
@@ -130,12 +130,12 @@ listInputMethod(callback: AsyncCallback<Array<InputMethodProperty>>)
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------------------- | ---- | ---------------------- |
| -------- | -------------------------------------------------- | ---- | ---------------------- |
| callback | Array
<
[
InputMethodProperty
](
#InputMethodProperty
)
>
| 是 | 返回已安装输入法列表。 |
| callback | Array
<
[
InputMethodProperty
](
#InputMethodProperty
)
>
| 是 | 返回已安装输入法列表。 |
-
示例
**示例:**
```
js
```
js
InputMethodSetting
.
listInputMethod
((
properties
)
=>
{
InputMethodSetting
.
listInputMethod
((
properties
)
=>
{
for
(
var
i
=
0
;
i
<
properties
.
length
;
i
++
)
{
for
(
var
i
=
0
;
i
<
properties
.
length
;
i
++
)
{
...
@@ -153,12 +153,12 @@ listInputMethod(): Promise<Array<InputMethodProperty>>
...
@@ -153,12 +153,12 @@ listInputMethod(): Promise<Array<InputMethodProperty>>
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
返回值
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ----------------------------------------------------------- | ---------------------- |
| ----------------------------------------------------------- | ---------------------- |
| Promise
<Array
<[
InputMethodProperty
](
#InputMethodProperty
)
>
> | 返回已安装输入法列表。 |
| Promise
<Array
<[
InputMethodProperty
](
#InputMethodProperty
)
>
> | 返回已安装输入法列表。 |
-
示例
**示例:**
```
js
```
js
var
properties
=
InputMethodSetting
.
listInputMethod
();
var
properties
=
InputMethodSetting
.
listInputMethod
();
for
(
var
i
=
0
;
i
<
properties
.
length
;
i
++
)
{
for
(
var
i
=
0
;
i
<
properties
.
length
;
i
++
)
{
...
@@ -175,13 +175,13 @@ displayOptionalInputMethod(callback: AsyncCallback<void>): void
...
@@ -175,13 +175,13 @@ displayOptionalInputMethod(callback: AsyncCallback<void>): void
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
-
示例
**示例:**
```
js
```
js
InputMethodSetting
.
displayOptionalInputMethod
(()
=>
{
InputMethodSetting
.
displayOptionalInputMethod
(()
=>
{
console
.
info
(
'
displayOptionalInputMethod is called
'
);
console
.
info
(
'
displayOptionalInputMethod is called
'
);
...
@@ -196,13 +196,13 @@ displayOptionalInputMethod(callback: AsyncCallback<void>): void
...
@@ -196,13 +196,13 @@ displayOptionalInputMethod(callback: AsyncCallback<void>): void
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
返回值
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
void
>
| 回调函数。 |
| Promise
<
void
>
| 回调函数。 |
-
示例
**示例:**
```
js
```
js
InputMethodSetting
.
displayOptionalInputMethod
();
InputMethodSetting
.
displayOptionalInputMethod
();
```
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md
浏览文件 @
5df2c931
...
@@ -52,13 +52,13 @@ getInputMethodEngine(): InputMethodEngine
...
@@ -52,13 +52,13 @@ getInputMethodEngine(): InputMethodEngine
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
返回值
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| --------------------------------------- | ------------ |
| --------------------------------------- | ------------ |
|
[
InputMethodEngine
](
#InputMethodEngine
)
| 服务端实例。 |
|
[
InputMethodEngine
](
#InputMethodEngine
)
| 服务端实例。 |
-
示例
**示例:**
```
js
```
js
var
InputMethodEngine
=
inputMethodEngine
.
getInputMethodEngine
();
var
InputMethodEngine
=
inputMethodEngine
.
getInputMethodEngine
();
...
@@ -72,13 +72,13 @@ createKeyboardDelegate(): KeyboardDelegate
...
@@ -72,13 +72,13 @@ createKeyboardDelegate(): KeyboardDelegate
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
返回值
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------------------------- | ---------------- |
| ------------------------------------- | ---------------- |
|
[
KeyboardDelegate
](
#KeyboardDelegate
)
| 客户端监听实例。 |
|
[
KeyboardDelegate
](
#KeyboardDelegate
)
| 客户端监听实例。 |
-
示例
**示例:**
```
js
```
js
var
KeyboardDelegate
=
inputMethodEngine
.
createKeyboardDelegate
();
var
KeyboardDelegate
=
inputMethodEngine
.
createKeyboardDelegate
();
...
@@ -96,14 +96,14 @@ on(type: 'inputStart', callback: (kbController: KeyboardController, textInputCli
...
@@ -96,14 +96,14 @@ on(type: 'inputStart', callback: (kbController: KeyboardController, textInputCli
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ------------------------------------------------------------ |
| -------- | ------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 设置监听类型。
<br/>
-type为‘inputStart’时表示订阅输入法绑定。 |
| type | string | 是 | 设置监听类型。
<br/>
-type为‘inputStart’时表示订阅输入法绑定。 |
| callback |
[
KeyboardController
](
#KeyboardController
)
,
[
TextInputClient
](
#TextInputClient
)
| 是 | 回调返回输入法操作相关实例。 |
| callback |
[
KeyboardController
](
#KeyboardController
)
,
[
TextInputClient
](
#TextInputClient
)
| 是 | 回调返回输入法操作相关实例。 |
-
示例:
**示例:**
```
js
```
js
InputMethodEngine
.
on
(
'
inputStart
'
,
(
kbController
,
textInputClient
)
=>
{
InputMethodEngine
.
on
(
'
inputStart
'
,
(
kbController
,
textInputClient
)
=>
{
...
@@ -120,7 +120,7 @@ off(type: 'inputStart', callback?: (kbController: KeyboardController, textInputC
...
@@ -120,7 +120,7 @@ off(type: 'inputStart', callback?: (kbController: KeyboardController, textInputC
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ |
| -------- | -------------------- | ---- | ------------------------ |
...
@@ -129,7 +129,7 @@ off(type: 'inputStart', callback?: (kbController: KeyboardController, textInputC
...
@@ -129,7 +129,7 @@ off(type: 'inputStart', callback?: (kbController: KeyboardController, textInputC
-
示例:
**示例:**
```
js
```
js
InputMethodEngine
.
off
(
'
inputStart
'
);
InputMethodEngine
.
off
(
'
inputStart
'
);
...
@@ -143,14 +143,14 @@ on(type: 'keyboardShow'|'keyboardHide', callback: () => void): void
...
@@ -143,14 +143,14 @@ on(type: 'keyboardShow'|'keyboardHide', callback: () => void): void
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------------------------------------------------------ |
| -------- | ------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 设置监听类型。
<br/>
-
type为'keyboardShow',表示订阅输入法显示。
<br/>
-
type为'keyboardHide',表示订阅输入法隐藏。 |
| type | string | 是 | 设置监听类型。
<br/>
-
type为'keyboardShow',表示订阅输入法显示。
<br/>
-
type为'keyboardHide',表示订阅输入法隐藏。 |
| callback | void | 否 | 回调函数。 |
| callback | void | 否 | 回调函数。 |
-
示例:
**示例:**
```
js
```
js
InputMethodEngine
.
on
(
'
keyboardShow
'
,
(
err
)
=>
{
InputMethodEngine
.
on
(
'
keyboardShow
'
,
(
err
)
=>
{
...
@@ -166,14 +166,14 @@ off(type: 'keyboardShow'|'keyboardHide', callback?: () => void): void
...
@@ -166,14 +166,14 @@ off(type: 'keyboardShow'|'keyboardHide', callback?: () => void): void
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------------------------------------------------------ |
| -------- | ------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 设置监听类型。
<br/>
-
type为'keyboardShow',表示订阅输入法显示。
<br/>
-
type为'keyboardHide',表示订阅输入法隐藏。 |
| type | string | 是 | 设置监听类型。
<br/>
-
type为'keyboardShow',表示订阅输入法显示。
<br/>
-
type为'keyboardHide',表示订阅输入法隐藏。 |
| callback | void | 否 | 回调函数。 |
| callback | void | 否 | 回调函数。 |
-
示例:
**示例:**
```
js
```
js
InputMethodEngine
.
off
(
'
keyboardShow
'
);
InputMethodEngine
.
off
(
'
keyboardShow
'
);
...
@@ -192,7 +192,7 @@ on(type: 'keyDown'|'keyUp', callback: (event: KeyEvent) => boolean): void
...
@@ -192,7 +192,7 @@ on(type: 'keyDown'|'keyUp', callback: (event: KeyEvent) => boolean): void
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ------------------------------------------------------------ |
| -------- | ------------------------------- | ---- | ------------------------------------------------------------ |
...
@@ -201,7 +201,7 @@ on(type: 'keyDown'|'keyUp', callback: (event: KeyEvent) => boolean): void
...
@@ -201,7 +201,7 @@ on(type: 'keyDown'|'keyUp', callback: (event: KeyEvent) => boolean): void
-
示例:
**示例:**
```
js
```
js
KeyboardDelegate
.
on
(
'
keyDown
'
,
(
event
)
=>
{
KeyboardDelegate
.
on
(
'
keyDown
'
,
(
event
)
=>
{
...
@@ -217,14 +217,14 @@ off(type: 'keyDown'|'keyUp', callback?: (event: KeyEvent) => boolean): void
...
@@ -217,14 +217,14 @@ off(type: 'keyDown'|'keyUp', callback?: (event: KeyEvent) => boolean): void
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ------------------------------------------------------------ |
| -------- | --------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 设置监听类型。
<br/>
-
type为'keyDown',表示订阅硬键盘按下。
<br/>
-
type为'keyUp',表示订阅硬键盘抬起。 |
| type | string | 是 | 设置监听类型。
<br/>
-
type为'keyDown',表示订阅硬键盘按下。
<br/>
-
type为'keyUp',表示订阅硬键盘抬起。 |
| callback |
[
KeyEvent
](
#KeyEvent
)
| 否 | 回调返回按键信息。 |
| callback |
[
KeyEvent
](
#KeyEvent
)
| 否 | 回调返回按键信息。 |
-
示例:
**示例:**
```
js
```
js
KeyboardDelegate
.
off
(
'
keyDown
'
);
KeyboardDelegate
.
off
(
'
keyDown
'
);
...
@@ -238,7 +238,7 @@ on(type: 'cursorContextChange', callback: (x: number, y:number, height:number) =
...
@@ -238,7 +238,7 @@ on(type: 'cursorContextChange', callback: (x: number, y:number, height:number) =
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------------------------------------------------------ |
| -------- | ------ | ---- | ------------------------------------------------------------ |
...
@@ -247,7 +247,7 @@ on(type: 'cursorContextChange', callback: (x: number, y:number, height:number) =
...
@@ -247,7 +247,7 @@ on(type: 'cursorContextChange', callback: (x: number, y:number, height:number) =
-
示例:
**示例:**
```
js
```
js
KeyboardDelegate
.
on
(
'
cursorContextChange
'
,
(
x
,
y
,
height
)
=>
{
KeyboardDelegate
.
on
(
'
cursorContextChange
'
,
(
x
,
y
,
height
)
=>
{
...
@@ -263,7 +263,7 @@ off(type: 'cursorContextChange', callback?: (x: number, y:number, height:number)
...
@@ -263,7 +263,7 @@ off(type: 'cursorContextChange', callback?: (x: number, y:number, height:number)
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ |
| -------- | -------------------- | ---- | ------------------------ |
...
@@ -271,7 +271,7 @@ off(type: 'cursorContextChange', callback?: (x: number, y:number, height:number)
...
@@ -271,7 +271,7 @@ off(type: 'cursorContextChange', callback?: (x: number, y:number, height:number)
| callback | number | 否 | 回调返回光标信息。 |
| callback | number | 否 | 回调返回光标信息。 |
-
示例:
**示例:**
```js
```js
KeyboardDelegate.off('cursorContextChange');
KeyboardDelegate.off('cursorContextChange');
...
@@ -284,14 +284,14 @@ on(type: 'selectionChange', callback: (oldBegin: number, oldEnd: number, newBegi
...
@@ -284,14 +284,14 @@ on(type: 'selectionChange', callback: (oldBegin: number, oldEnd: number, newBegi
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------------------------------------------------------ |
| -------- | ------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 文本选择变化事件。<br/>-type为’selectionChange‘时,表示选择文本变化。 |
| type | string | 是 | 文本选择变化事件。<br/>-type为’selectionChange‘时,表示选择文本变化。 |
| callback | number | 是 | 回调返回文本选择信息。 |
| callback | number | 是 | 回调返回文本选择信息。 |
-
示例:
**示例:**
```
js
```
js
KeyboardDelegate
.
on
(
'
selectionChange
'
,
(
oldBegin
,
oldEnd
,
newBegin
,
newEnd
)
=>
{
KeyboardDelegate
.
on
(
'
selectionChange
'
,
(
oldBegin
,
oldEnd
,
newBegin
,
newEnd
)
=>
{
...
@@ -307,14 +307,14 @@ off(type: 'selectionChange', callback?: (oldBegin: number, oldEnd: number, newBe
...
@@ -307,14 +307,14 @@ off(type: 'selectionChange', callback?: (oldBegin: number, oldEnd: number, newBe
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ |
| -------- | -------------------- | ---- | ------------------------ |
| type | string | 是 | 文本选择变化事件。<br/>-type为’selectionChange‘时,表示选择文本变化。 |
| type | string | 是 | 文本选择变化事件。<br/>-type为’selectionChange‘时,表示选择文本变化。 |
| callback | number | 否 | 回调返回文本选择信息。 |
| callback | number | 否 | 回调返回文本选择信息。 |
-
示例:
**示例:**
```js
```js
KeyboardDelegate.off('selectionChange');
KeyboardDelegate.off('selectionChange');
...
@@ -329,14 +329,14 @@ on(type: 'textChange', callback: (text: string) => void): void
...
@@ -329,14 +329,14 @@ on(type: 'textChange', callback: (text: string) => void): void
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ------------------------------------------------------------ |
| -------- | ------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 文本变化事件。<br/>-type为’textChange‘时,表示当前文本变化。 |
| type | string | 是 | 文本变化事件。<br/>-type为’textChange‘时,表示当前文本变化。 |
| callback | string | 是 | 回调返回当前文本内容。 |
| callback | string | 是 | 回调返回当前文本内容。 |
-
示例:
**示例:**
```js
```js
KeyboardDelegate.on('textChange', (text) => {
KeyboardDelegate.on('textChange', (text) => {
...
@@ -352,14 +352,14 @@ off(type: 'textChange', callback?: (text: string) => void): void
...
@@ -352,14 +352,14 @@ off(type: 'textChange', callback?: (text: string) => void): void
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ |
| -------- | -------------------- | ---- | ------------------------ |
| type | string | 是 | 文本变化事件。<br/>-type为’textChange‘时,表示当前文本变化。 |
| type | string | 是 | 文本变化事件。<br/>-type为’textChange‘时,表示当前文本变化。 |
| callback | string | 否 | 回调返回当前文本内容。 |
| callback | string | 否 | 回调返回当前文本内容。 |
-
示例:
**示例:**
```js
```js
KeyboardDelegate.off('textChange');
KeyboardDelegate.off('textChange');
...
@@ -377,13 +377,13 @@ hideKeyboard(callback: AsyncCallback<void>): void
...
@@ -377,13 +377,13 @@ hideKeyboard(callback: AsyncCallback<void>): void
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | -------- |
| -------- | ---------------------- | ---- | -------- |
| callback | AsyncCallback
<
void> | 否 | 回调函数 |
| callback | AsyncCallback
<
void> | 否 | 回调函数 |
-
示例
**示例:**
```
js
```
js
...
@@ -399,14 +399,13 @@ hideKeyboard(): Promise<void>
...
@@ -399,14 +399,13 @@ hideKeyboard(): Promise<void>
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
返回值
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ---------------- | -------- |
| ---------------- | -------- |
| Promise
<
void> | 回调函数 |
| Promise
<
void> | 回调函数 |
-
示例
**示例:**
```
js
```
js
KeyboardController
.
hideKeyboard
();
KeyboardController
.
hideKeyboard
();
...
@@ -424,14 +423,15 @@ getForward(length:number, callback: AsyncCallback<string>): void
...
@@ -424,14 +423,15 @@ getForward(length:number, callback: AsyncCallback<string>): void
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| length | number | 是 | 文本长度。 |
| length | number | 是 | 文本长度。 |
| callback | AsyncCallback
<
string
>
| 是 | 返回文本。 |
| callback | AsyncCallback
<
string
>
| 是 | 返回文本。 |
-
示例
**示例:**
```
js
```
js
TextInputClient
.
getForward
(
5
,(
text
)
=>
{
TextInputClient
.
getForward
(
5
,(
text
)
=>
{
console
.
info
(
"
text =
"
+
text
);
console
.
info
(
"
text =
"
+
text
);
...
@@ -446,18 +446,20 @@ getForward(length:number): Promise<string>
...
@@ -446,18 +446,20 @@ getForward(length:number): Promise<string>
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| length | number | 是 | 文本长度。 |
| length | number | 是 | 文本长度。 |
-
返回值
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------------------- | ------------------------------------------------------------ |
| ------------------------------- | ------------------------------------------------------------ |
| Promise
<
string
>
| 返回文本。 |
| Promise
<
string
>
| 返回文本。 |
-
示例
**示例:**
```
js
```
js
var
text
=
TextInputClient
.
getForward
(
5
);
var
text
=
TextInputClient
.
getForward
(
5
);
console
.
info
(
"
text =
"
+
text
);
console
.
info
(
"
text =
"
+
text
);
...
@@ -471,14 +473,15 @@ getBackward(length:number, callback: AsyncCallback<string>): void
...
@@ -471,14 +473,15 @@ getBackward(length:number, callback: AsyncCallback<string>): void
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| length | number | 是 | 文本长度。 |
| length | number | 是 | 文本长度。 |
| callback | AsyncCallback
<
string
>
| 是 | 返回文本。 |
| callback | AsyncCallback
<
string
>
| 是 | 返回文本。 |
-
示例
**示例:**
```
js
```
js
TextInputClient
.
getBackward
(
5
,(
text
)
=>
{
TextInputClient
.
getBackward
(
5
,(
text
)
=>
{
console
.
info
(
"
text =
"
+
text
);
console
.
info
(
"
text =
"
+
text
);
...
@@ -493,18 +496,20 @@ getBackward(length:number): Promise<string>
...
@@ -493,18 +496,20 @@ getBackward(length:number): Promise<string>
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| length | number | 是 | 文本长度。 |
| length | number | 是 | 文本长度。 |
-
返回值
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------------------- | ------------------------------------------------------------ |
| ------------------------------- | ------------------------------------------------------------ |
| Promise
<
string
>
| 返回文本。 |
| Promise
<
string
>
| 返回文本。 |
-
示例
**示例:**
```
js
```
js
var
text
=
TextInputClient
.
getBackward
(
5
);
var
text
=
TextInputClient
.
getBackward
(
5
);
console
.
info
(
"
text =
"
+
text
);
console
.
info
(
"
text =
"
+
text
);
...
@@ -518,14 +523,15 @@ deleteForward(length:number, callback: AsyncCallback<boolean>): void
...
@@ -518,14 +523,15 @@ deleteForward(length:number, callback: AsyncCallback<boolean>): void
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| length | number | 是 | 文本长度。 |
| length | number | 是 | 文本长度。 |
| callback | AsyncCallback
<
boolean
>
| 是 | 操作成功与否。 |
| callback | AsyncCallback
<
boolean
>
| 是 | 操作成功与否。 |
-
示例
**示例:**
```
js
```
js
TextInputClient
.
deleteForward
(
5
,(
isSuccess
)
=>
{
TextInputClient
.
deleteForward
(
5
,(
isSuccess
)
=>
{
console
.
info
(
"
isSuccess =
"
+
isSuccess
);
console
.
info
(
"
isSuccess =
"
+
isSuccess
);
...
@@ -539,18 +545,20 @@ deleteForward(length:number): Promise<boolean>
...
@@ -539,18 +545,20 @@ deleteForward(length:number): Promise<boolean>
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| length | number | 是 | 文本长度。 |
| length | number | 是 | 文本长度。 |
-
返回值
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------------------- | ------------------------------------------------------------ |
| ------------------------------- | ------------------------------------------------------------ |
| Promise<boolean> | 操作成功与否。 |
| Promise<boolean> | 操作成功与否。 |
-
示例
**示例:**
```js
```js
var isSuccess = TextInputClient.deleteForward(5);
var isSuccess = TextInputClient.deleteForward(5);
console.info("isSuccess = " + isSuccess);
console.info("isSuccess = " + isSuccess);
...
@@ -564,14 +572,15 @@ deleteBackward(length:number, callback: AsyncCallback<boolean>): void
...
@@ -564,14 +572,15 @@ deleteBackward(length:number, callback: AsyncCallback<boolean>): void
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| length | number | 是 | 文本长度。 |
| length | number | 是 | 文本长度。 |
| callback | AsyncCallback<boolean> | 是 | 操作成功与否。 |
| callback | AsyncCallback<boolean> | 是 | 操作成功与否。 |
-
示例
**示例:**
```js
```js
TextInputClient.deleteBackward(5, (isSuccess)=>{
TextInputClient.deleteBackward(5, (isSuccess)=>{
console.info("isSuccess = " + isSuccess);
console.info("isSuccess = " + isSuccess);
...
@@ -586,17 +595,18 @@ deleteBackward(length:number): Promise<boolean>
...
@@ -586,17 +595,18 @@ deleteBackward(length:number): Promise<boolean>
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| length | number | 是 | 文本长度。 |
| length | number | 是 | 文本长度。 |
-
返回值
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------------------- | ------------------------------------------------------------ |
| ------------------------------- | ------------------------------------------------------------ |
| Promise
<
boolean
>
| 操作成功与否。 |
| Promise
<
boolean
>
| 操作成功与否。 |
-
示例
**示例:**
```js
```js
var isSuccess = TextInputClient.deleteBackward(5);
var isSuccess = TextInputClient.deleteBackward(5);
...
@@ -610,14 +620,15 @@ sendKeyFunction(action:number, callback: AsyncCallback<boolean>): void
...
@@ -610,14 +620,15 @@ sendKeyFunction(action:number, callback: AsyncCallback<boolean>): void
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| action | number | 是 | 编辑框属性。 |
| action | number | 是 | 编辑框属性。 |
| callback | AsyncCallback<boolean> | 是 | 操作成功与否。 |
| callback | AsyncCallback<boolean> | 是 | 操作成功与否。 |
-
示例
**示例:**
```js
```js
TextInputClient.sendKeyFunction(inputMethod.ENTER_KEY_TYPE_NEXT,(isSuccess)=>{
TextInputClient.sendKeyFunction(inputMethod.ENTER_KEY_TYPE_NEXT,(isSuccess)=>{
console.info("isSuccess = " + isSuccess);
console.info("isSuccess = " + isSuccess);
...
@@ -632,17 +643,19 @@ sendKeyFunction(action:number): Promise<boolean>
...
@@ -632,17 +643,19 @@ sendKeyFunction(action:number): Promise<boolean>
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| action | number | 是 | 编辑框属性。 |
| action | number | 是 | 编辑框属性。 |
-
返回值
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------------------- | ------------------------------------------------------------ |
| ------------------------------- | ------------------------------------------------------------ |
| Promise
<
boolean
>
| 操作成功与否。 |
| Promise
<
boolean
>
| 操作成功与否。 |
-
示例
**示例:**
```
js
```
js
var
isSuccess
=
TextInputClient
.
sendKeyFunction
(
inputMethod
.
ENTER_KEY_TYPE_NEXT
);
var
isSuccess
=
TextInputClient
.
sendKeyFunction
(
inputMethod
.
ENTER_KEY_TYPE_NEXT
);
...
@@ -657,14 +670,15 @@ insertText(text:string, callback: AsyncCallback<boolean>): void
...
@@ -657,14 +670,15 @@ insertText(text:string, callback: AsyncCallback<boolean>): void
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| text | string | 是 | 文本。 |
| text | string | 是 | 文本。 |
| callback | AsyncCallback<boolean> | 是 | 操作成功与否。 |
| callback | AsyncCallback<boolean> | 是 | 操作成功与否。 |
-
示例
**示例:**
```js
```js
TextInputClient.insertText("test", (isSuccess)=>{
TextInputClient.insertText("test", (isSuccess)=>{
console.info("isSuccess = " + isSuccess);
console.info("isSuccess = " + isSuccess);
...
@@ -679,17 +693,19 @@ insertText(text:string): Promise<boolean>
...
@@ -679,17 +693,19 @@ insertText(text:string): Promise<boolean>
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| text | string | 是 | 文本。 |
| text | string | 是 | 文本。 |
-
返回值
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------------------- | ------------------------------------------------------------ |
| ------------------------------- | ------------------------------------------------------------ |
| Promise
<
boolean
>
| 操作成功与否。 |
| Promise
<
boolean
>
| 操作成功与否。 |
-
示例
**示例:**
```
js
```
js
var
isSuccess
=
TextInputClient
.
insertText
(
"
test
"
);
var
isSuccess
=
TextInputClient
.
insertText
(
"
test
"
);
...
@@ -704,12 +720,14 @@ getEditorAttribute(callback: AsyncCallback<EditorAttribute>): void
...
@@ -704,12 +720,14 @@ getEditorAttribute(callback: AsyncCallback<EditorAttribute>): void
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
参数
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| ------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| callback | AsyncCallback
<
[EditorAttribute](#EditorAttribute)
>
| 是 | 编辑框属性值。 |
| callback | AsyncCallback
<
[EditorAttribute](#EditorAttribute)
>
| 是 | 编辑框属性值。 |
-
示例
**示例:**
```
js
```
js
TextInputClient
.
getEditorAttribute
((
EditorAttribute
)
=>
{
TextInputClient
.
getEditorAttribute
((
EditorAttribute
)
=>
{
});
});
...
@@ -723,12 +741,14 @@ getEditorAttribute(): Promise<EditorAttribute>
...
@@ -723,12 +741,14 @@ getEditorAttribute(): Promise<EditorAttribute>
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
-
返回值
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------------------- | ------------------------------------------------------------ |
| ------------------------------- | ------------------------------------------------------------ |
| Promise
<
[EditorAttribute](#EditorAttribute)
>
| 返回编辑框属性值。 |
| Promise
<
[EditorAttribute](#EditorAttribute)
>
| 返回编辑框属性值。 |
-
示例
**示例:**
```
js
```
js
var
EditorAttribute
=
TextInputClient
.
getEditorAttribute
();
var
EditorAttribute
=
TextInputClient
.
getEditorAttribute
();
```
```
...
...
zh-cn/application-dev/reference/apis/js-apis-request.md
浏览文件 @
5df2c931
...
@@ -69,17 +69,19 @@ upload(config: UploadConfig): Promise<UploadTask>
...
@@ -69,17 +69,19 @@ upload(config: UploadConfig): Promise<UploadTask>
**系统能力**
: SystemCapability.MiscServices.Upload
**系统能力**
: SystemCapability.MiscServices.Upload
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| config |
[
UploadConfig
](
#uploadconfig
)
| 是 | 上传的配置信息。 |
| config |
[
UploadConfig
](
#uploadconfig
)
| 是 | 上传的配置信息。 |
-
返回值:
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
[UploadTask](#uploadtask)
>
| 返回上传任务。 |
| Promise
<
[UploadTask](#uploadtask)
>
| 返回上传任务。 |
-
示例:
**示例:**
```
js
```
js
request
.
upload
({
url
:
'
https://patch
'
}).
then
((
data
)
=>
{
request
.
upload
({
url
:
'
https://patch
'
}).
then
((
data
)
=>
{
...
@@ -100,13 +102,14 @@ upload(config: UploadConfig, callback: AsyncCallback<UploadTask>): void
...
@@ -100,13 +102,14 @@ upload(config: UploadConfig, callback: AsyncCallback<UploadTask>): void
**系统能力**
: SystemCapability.MiscServices.Upload
**系统能力**
: SystemCapability.MiscServices.Upload
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| config |
[
UploadConfig
](
#uploadconfig
)
| 是 | 上传的配置信息。 |
| config |
[
UploadConfig
](
#uploadconfig
)
| 是 | 上传的配置信息。 |
| callback | AsyncCallback
<
[UploadTask](#uploadtask)
>
| 否 | 回调函数,异步返回UploadTask对象。 |
| callback | AsyncCallback
<
[UploadTask](#uploadtask)
>
| 否 | 回调函数,异步返回UploadTask对象。 |
-
示例:
**示例:**
```
js
```
js
request
.
upload
({
url
:
'
https://patch
'
},
(
err
,
data
)
=>
{
request
.
upload
({
url
:
'
https://patch
'
},
(
err
,
data
)
=>
{
...
@@ -134,20 +137,21 @@ on(type: 'progress', callback:(uploadedSize: number, totalSize: number) => vo
...
@@ -134,20 +137,21 @@ on(type: 'progress', callback:(uploadedSize: number, totalSize: number) => vo
**系统能力**
: SystemCapability.MiscServices.Upload
**系统能力**
: SystemCapability.MiscServices.Upload
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 订阅的事件类型,取值为'progress'(上传的进度信息)。 |
| type | string | 是 | 订阅的事件类型,取值为'progress'(上传的进度信息)。 |
| callback | function | 是 | 上传进度的回调函数。 |
| callback | function | 是 | 上传进度的回调函数。 |
回调函数的参数
:
回调函数的参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| uploadedSize | number | 是 | 当前已上传文件大小,单位为KB。 |
| uploadedSize | number | 是 | 当前已上传文件大小,单位为KB。 |
| totalSize | number | 是 | 上传文件的总大小,单位为KB。 |
| totalSize | number | 是 | 上传文件的总大小,单位为KB。 |
-
示例:
**示例:**
```
js
```
js
uploadTask
.
on
(
'
progress
'
,
function
callback
(
uploadedSize
,
totalSize
)
{
uploadTask
.
on
(
'
progress
'
,
function
callback
(
uploadedSize
,
totalSize
)
{
...
@@ -167,8 +171,9 @@ on(type: 'headerReceive', callback: (header: object) => void): void
...
@@ -167,8 +171,9 @@ on(type: 'headerReceive', callback: (header: object) => void): void
**系统能力**
: SystemCapability.MiscServices.Upload
**系统能力**
: SystemCapability.MiscServices.Upload
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 订阅的事件类型,取值为'headerReceive'(接收响应头)。 |
| type | string | 是 | 订阅的事件类型,取值为'headerReceive'(接收响应头)。 |
| callback | function | 是 | HTTP
Response
Header事件的回调函数。 |
| callback | function | 是 | HTTP
Response
Header事件的回调函数。 |
...
@@ -179,7 +184,7 @@ on(type: 'headerReceive', callback: (header: object) => void): void
...
@@ -179,7 +184,7 @@ on(type: 'headerReceive', callback: (header: object) => void): void
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| header | object | 是 | HTTP
Response
Header。 |
| header | object | 是 | HTTP
Response
Header。 |
-
示例:
**示例:**
```
js
```
js
uploadTask
.
on
(
'
headerReceive
'
,
function
callback
(
headers
){
uploadTask
.
on
(
'
headerReceive
'
,
function
callback
(
headers
){
...
@@ -199,8 +204,9 @@ off(type: 'progress', callback?: (uploadedSize: number, totalSize: number) =&g
...
@@ -199,8 +204,9 @@ off(type: 'progress', callback?: (uploadedSize: number, totalSize: number) =&g
**系统能力**
: SystemCapability.MiscServices.Upload
**系统能力**
: SystemCapability.MiscServices.Upload
-
参数:
**参数:**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 取消订阅的事件类型,取值为'progress'(上传的进度信息)。 |
| type | string | 是 | 取消订阅的事件类型,取值为'progress'(上传的进度信息)。 |
| callback | function | 否 | 上传任务的回调函数。 |
| callback | function | 否 | 上传任务的回调函数。 |
...
@@ -212,7 +218,7 @@ off(type: 'progress', callback?: (uploadedSize: number, totalSize: number) =&g
...
@@ -212,7 +218,7 @@ off(type: 'progress', callback?: (uploadedSize: number, totalSize: number) =&g
| uploadedSize | number | 是 | 当前已上传文件的大小,单位为KB。 |
| uploadedSize | number | 是 | 当前已上传文件的大小,单位为KB。 |
| totalSize | number | 是 | 上传文件的总大小,单位为KB。 |
| totalSize | number | 是 | 上传文件的总大小,单位为KB。 |
-
示例:
**示例:**
```
js
```
js
uploadTask
.
off
(
'
progress
'
,
function
callback
(
uploadedSize
,
totalSize
)
{
uploadTask
.
off
(
'
progress
'
,
function
callback
(
uploadedSize
,
totalSize
)
{
...
@@ -232,8 +238,9 @@ off(type: 'headerReceive', callback?: (header: object) => void): void
...
@@ -232,8 +238,9 @@ off(type: 'headerReceive', callback?: (header: object) => void): void
**系统能力**
: SystemCapability.MiscServices.Upload
**系统能力**
: SystemCapability.MiscServices.Upload
-
参数:
**参数:**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 取消订阅的事件类型,取值为'headerReceive'(接收响应头)。 |
| type | string | 是 | 取消订阅的事件类型,取值为'headerReceive'(接收响应头)。 |
| callback | function | 否 | HTTP
Response
Header事件的回调函数。 |
| callback | function | 否 | HTTP
Response
Header事件的回调函数。 |
...
@@ -244,7 +251,7 @@ off(type: 'headerReceive', callback?: (header: object) => void): void
...
@@ -244,7 +251,7 @@ off(type: 'headerReceive', callback?: (header: object) => void): void
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| header | object | 是 | HTTP
Response
Header。 |
| header | object | 是 | HTTP
Response
Header。 |
-
示例:
**示例:**
```
js
```
js
uploadTask
.
off
(
'
headerReceive
'
,
function
callback
(
headers
)
{
uploadTask
.
off
(
'
headerReceive
'
,
function
callback
(
headers
)
{
...
@@ -264,12 +271,13 @@ remove(): Promise<boolean>
...
@@ -264,12 +271,13 @@ remove(): Promise<boolean>
**系统能力**
: SystemCapability.MiscServices.Upload
**系统能力**
: SystemCapability.MiscServices.Upload
-
返回值:
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
boolean
>
| 移除任务是否成功。true:成功,false:不成功。 |
| Promise
<
boolean
>
| 移除任务是否成功。true:成功,false:不成功。 |
-
示例
**示例:**
```
js
```
js
uploadTask
.
remove
().
then
((
result
)
=>
{
uploadTask
.
remove
().
then
((
result
)
=>
{
...
@@ -294,12 +302,13 @@ remove(callback: AsyncCallback<boolean>): void
...
@@ -294,12 +302,13 @@ remove(callback: AsyncCallback<boolean>): void
**系统能力**
: SystemCapability.MiscServices.Upload
**系统能力**
: SystemCapability.MiscServices.Upload
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 移除任务的回调函数。 |
| callback | AsyncCallback
<
boolean
>
| 是 | 移除任务的回调函数。 |
-
示例
**示例:**
```
js
```
js
uploadTask
.
remove
((
err
,
result
)
=>
{
uploadTask
.
remove
((
err
,
result
)
=>
{
...
@@ -361,17 +370,19 @@ download(config: DownloadConfig): Promise<DownloadTask>
...
@@ -361,17 +370,19 @@ download(config: DownloadConfig): Promise<DownloadTask>
**系统能力**
: SystemCapability.MiscServices.Download
**系统能力**
: SystemCapability.MiscServices.Download
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| config |
[
DownloadConfig
](
#downloadconfig
)
| 是 | 下载的配置信息。 |
| config |
[
DownloadConfig
](
#downloadconfig
)
| 是 | 下载的配置信息。 |
-
返回值:
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
[DownloadTask](#downloadtask)
>
| 返回下载任务。 |
| Promise
<
[DownloadTask](#downloadtask)
>
| 返回下载任务。 |
-
示例
**示例:**
```
js
```
js
request
.
download
({
url
:
'
https://xxxx/xxxx.hap
'
}).
then
((
data
)
=>
{
request
.
download
({
url
:
'
https://xxxx/xxxx.hap
'
}).
then
((
data
)
=>
{
...
@@ -392,13 +403,14 @@ download(config: DownloadConfig, callback: AsyncCallback<DownloadTask>): v
...
@@ -392,13 +403,14 @@ download(config: DownloadConfig, callback: AsyncCallback<DownloadTask>): v
**系统能力**
: SystemCapability.MiscServices.Download
**系统能力**
: SystemCapability.MiscServices.Download
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| config |
[
DownloadConfig
](
#downloadconfig
)
| 是 | 下载的配置信息。 |
| config |
[
DownloadConfig
](
#downloadconfig
)
| 是 | 下载的配置信息。 |
| callback | AsyncCallback
<
[DownloadTask](#downloadtask)
>
| 否 | 下载接口的回调函数。 |
| callback | AsyncCallback
<
[DownloadTask](#downloadtask)
>
| 否 | 下载接口的回调函数。 |
-
示例
**示例:**
```
js
```
js
request
.
download
({
url
:
'
https://xxxx/xxxxx.hap
'
,
request
.
download
({
url
:
'
https://xxxx/xxxxx.hap
'
,
...
@@ -427,8 +439,9 @@ on(type: 'progress', callback:(receivedSize: number, totalSize: number) => vo
...
@@ -427,8 +439,9 @@ on(type: 'progress', callback:(receivedSize: number, totalSize: number) => vo
**系统能力**
: SystemCapability.MiscServices.Download
**系统能力**
: SystemCapability.MiscServices.Download
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 订阅的事件类型,取值为'progress'(下载的进度信息)。 |
| type | string | 是 | 订阅的事件类型,取值为'progress'(下载的进度信息)。 |
| callback | function | 是 | 下载的回调函数。 |
| callback | function | 是 | 下载的回调函数。 |
...
@@ -440,7 +453,7 @@ on(type: 'progress', callback:(receivedSize: number, totalSize: number) => vo
...
@@ -440,7 +453,7 @@ on(type: 'progress', callback:(receivedSize: number, totalSize: number) => vo
| receivedSize | number | 是 | 当前下载的进度,单位为KB。 |
| receivedSize | number | 是 | 当前下载的进度,单位为KB。 |
| totalSize | number | 是 | 下载文件的总大小,单位为KB。 |
| totalSize | number | 是 | 下载文件的总大小,单位为KB。 |
-
示例:
**示例:**
```
js
```
js
request
.
download
({
url
:
'
https://xxxx/xxxx.hap
'
},
(
err
,
data
)
=>
{
request
.
download
({
url
:
'
https://xxxx/xxxx.hap
'
},
(
err
,
data
)
=>
{
...
@@ -467,8 +480,9 @@ off(type: 'progress', callback?: (receivedSize: number, totalSize: number) =>
...
@@ -467,8 +480,9 @@ off(type: 'progress', callback?: (receivedSize: number, totalSize: number) =>
**系统能力**
: SystemCapability.MiscServices.Download
**系统能力**
: SystemCapability.MiscServices.Download
-
参数:
**参数:**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 取消订阅的事件类型,取值为'progress'(下载的进度信息)。 |
| type | string | 是 | 取消订阅的事件类型,取值为'progress'(下载的进度信息)。 |
| callback | function | 否 | 下载任务的回调函数。 |
| callback | function | 否 | 下载任务的回调函数。 |
...
@@ -480,7 +494,7 @@ off(type: 'progress', callback?: (receivedSize: number, totalSize: number) =>
...
@@ -480,7 +494,7 @@ off(type: 'progress', callback?: (receivedSize: number, totalSize: number) =>
| receivedSize | number | 是 | 当前下载的进度。 |
| receivedSize | number | 是 | 当前下载的进度。 |
| totalSize | number | 是 | 下载文件的总大小。 |
| totalSize | number | 是 | 下载文件的总大小。 |
-
示例:
**示例:**
```
js
```
js
request
.
download
({
url
:
'
https://xxxx/xxxx.hap
'
},
(
err
,
data
)
=>
{
request
.
download
({
url
:
'
https://xxxx/xxxx.hap
'
},
(
err
,
data
)
=>
{
...
@@ -507,13 +521,14 @@ on(type: 'complete'|'pause'|'remove', callback:() => void): void
...
@@ -507,13 +521,14 @@ on(type: 'complete'|'pause'|'remove', callback:() => void): void
**系统能力**
: SystemCapability.MiscServices.Download
**系统能力**
: SystemCapability.MiscServices.Download
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 订阅的事件类型。
<br>
- 取值为'complete',表示下载任务完成;
<br/>
- 取值为'pause',表示下载任务暂停;
<br/>
- 取值为'remove',表示下载任务移除。 |
| type | string | 是 | 订阅的事件类型。
<br>
- 取值为'complete',表示下载任务完成;
<br/>
- 取值为'pause',表示下载任务暂停;
<br/>
- 取值为'remove',表示下载任务移除。 |
| callback | function | 是 | 回调函数。 |
| callback | function | 是 | 回调函数。 |
-
示例:
**示例:**
```
js
```
js
request
.
download
({
url
:
'
https://xxxx/xxxx.hap
'
},
(
err
,
data
)
=>
{
request
.
download
({
url
:
'
https://xxxx/xxxx.hap
'
},
(
err
,
data
)
=>
{
...
@@ -540,13 +555,14 @@ off(type: 'complete'|'pause'|'remove', callback?:() => void): void
...
@@ -540,13 +555,14 @@ off(type: 'complete'|'pause'|'remove', callback?:() => void): void
**系统能力**
: SystemCapability.MiscServices.Download
**系统能力**
: SystemCapability.MiscServices.Download
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 取消订阅的事件类型。
<br/>
- 取值为'complete',表示下载任务完成;
<br/>
- 取值为'pause',表示下载任务暂停;
<br/>
- 取值为'remove',表示下载任务移除。 |
| type | string | 是 | 取消订阅的事件类型。
<br/>
- 取值为'complete',表示下载任务完成;
<br/>
- 取值为'pause',表示下载任务暂停;
<br/>
- 取值为'remove',表示下载任务移除。 |
| callback | function | 否 | 回调函数。 |
| callback | function | 否 | 回调函数。 |
-
示例:
**示例:**
```
js
```
js
request
.
download
({
url
:
'
https://xxxx/xxxx.hap
'
},
(
err
,
data
)
=>
{
request
.
download
({
url
:
'
https://xxxx/xxxx.hap
'
},
(
err
,
data
)
=>
{
...
@@ -573,8 +589,9 @@ on(type: 'fail', callback: (err: number) => void): void
...
@@ -573,8 +589,9 @@ on(type: 'fail', callback: (err: number) => void): void
**系统能力**
: SystemCapability.MiscServices.Download
**系统能力**
: SystemCapability.MiscServices.Download
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 订阅的事件类型,取值为'fail'(下载失败)。 |
| type | string | 是 | 订阅的事件类型,取值为'fail'(下载失败)。 |
| callback | function | 是 | 下载失败的回调函数。 |
| callback | function | 是 | 下载失败的回调函数。 |
...
@@ -585,7 +602,7 @@ on(type: 'fail', callback: (err: number) => void): void
...
@@ -585,7 +602,7 @@ on(type: 'fail', callback: (err: number) => void): void
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| err | number | 是 | 下载失败的错误码,错误原因见
[
ERROR.*
](
#常量
)
。 |
| err | number | 是 | 下载失败的错误码,错误原因见
[
ERROR.*
](
#常量
)
。 |
-
示例
**示例:**
```
js
```
js
request
.
download
({
url
:
'
https://xxxx/xxxx.hap
'
},
(
err
,
data
)
=>
{
request
.
download
({
url
:
'
https://xxxx/xxxx.hap
'
},
(
err
,
data
)
=>
{
...
@@ -612,8 +629,9 @@ off(type: 'fail', callback?: (err: number) => void): void
...
@@ -612,8 +629,9 @@ off(type: 'fail', callback?: (err: number) => void): void
**系统能力**
: SystemCapability.MiscServices.Download
**系统能力**
: SystemCapability.MiscServices.Download
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 取消订阅的事件类型,取值为'fail'(下载失败)。 |
| type | string | 是 | 取消订阅的事件类型,取值为'fail'(下载失败)。 |
| callback | function | 否 | 取消下载失败的回调函数。 |
| callback | function | 否 | 取消下载失败的回调函数。 |
...
@@ -624,7 +642,7 @@ off(type: 'fail', callback?: (err: number) => void): void
...
@@ -624,7 +642,7 @@ off(type: 'fail', callback?: (err: number) => void): void
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| err | number | 是 | 下载失败的错误码。错误原因见
[
ERROR_*
](
#常量
)
。 |
| err | number | 是 | 下载失败的错误码。错误原因见
[
ERROR_*
](
#常量
)
。 |
-
示例
**示例:**
```
js
```
js
request
.
download
({
url
:
'
https://xxxx/xxxx.hap
'
},
(
err
,
data
)
=>
{
request
.
download
({
url
:
'
https://xxxx/xxxx.hap
'
},
(
err
,
data
)
=>
{
...
@@ -651,12 +669,13 @@ remove(): Promise<boolean>
...
@@ -651,12 +669,13 @@ remove(): Promise<boolean>
**系统能力**
: SystemCapability.MiscServices.Download
**系统能力**
: SystemCapability.MiscServices.Download
-
返回值:
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
boolean
>
| 移除任务是否成功。 |
| Promise
<
boolean
>
| 移除任务是否成功。 |
-
示例
**示例:**
```
js
```
js
downloadTask
.
remove
().
then
((
result
)
=>
{
downloadTask
.
remove
().
then
((
result
)
=>
{
...
@@ -681,12 +700,13 @@ remove(callback: AsyncCallback<boolean>): void
...
@@ -681,12 +700,13 @@ remove(callback: AsyncCallback<boolean>): void
**系统能力**
: SystemCapability.MiscServices.Download
**系统能力**
: SystemCapability.MiscServices.Download
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 移除任务是否成功。 |
| callback | AsyncCallback
<
boolean
>
| 是 | 移除任务是否成功。 |
-
示例
**示例:**
```
js
```
js
downloadTask
.
remove
((
err
,
result
)
=>
{
downloadTask
.
remove
((
err
,
result
)
=>
{
...
@@ -713,12 +733,12 @@ query(): Promise<DownloadInfo>
...
@@ -713,12 +733,12 @@ query(): Promise<DownloadInfo>
**系统能力**
: SystemCapability.MiscServices.Download
**系统能力**
: SystemCapability.MiscServices.Download
-
参数:
**参数:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
[DownloadInfo](#downloadinfo7)
>
| 查询下载任务信息。 |
| Promise
<
[DownloadInfo](#downloadinfo7)
>
| 查询下载任务信息。 |
-
示例
**示例:**
```
js
```
js
downloadTask
.
query
().
then
((
downloadInfo
)
=>
{
downloadTask
.
query
().
then
((
downloadInfo
)
=>
{
...
@@ -739,12 +759,13 @@ query(callback: AsyncCallback<DownloadInfo>): void
...
@@ -739,12 +759,13 @@ query(callback: AsyncCallback<DownloadInfo>): void
**系统能力**
: SystemCapability.MiscServices.Download
**系统能力**
: SystemCapability.MiscServices.Download
-
参数:
**参数:**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
[DownloadInfo](#downloadinfo7)
>
| 是 | 查询下载任务的回调函数。 |
| callback | AsyncCallback
<
[DownloadInfo](#downloadinfo7)
>
| 是 | 查询下载任务的回调函数。 |
-
示例:
**示例:**
```
js
```
js
downloadTask
.
query
((
err
,
downloadInfo
)
=>
{
downloadTask
.
query
((
err
,
downloadInfo
)
=>
{
...
@@ -767,12 +788,13 @@ queryMimeType(): Promise<string>
...
@@ -767,12 +788,13 @@ queryMimeType(): Promise<string>
**系统能力**
: SystemCapability.MiscServices.Download
**系统能力**
: SystemCapability.MiscServices.Download
-
返回值:
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
string
>
| 查询下载任务的MimeType。 |
| Promise
<
string
>
| 查询下载任务的MimeType。 |
-
示例
**示例:**
```
js
```
js
downloadTask
.
queryMimeType
().
then
((
data
)
=>
{
downloadTask
.
queryMimeType
().
then
((
data
)
=>
{
...
@@ -793,12 +815,13 @@ queryMimeType(callback: AsyncCallback<string>): void;
...
@@ -793,12 +815,13 @@ queryMimeType(callback: AsyncCallback<string>): void;
**系统能力**
: SystemCapability.MiscServices.Download
**系统能力**
: SystemCapability.MiscServices.Download
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
string
>
| 是 | 查询下载任务的MimeType的回调函数。 |
| callback | AsyncCallback
<
string
>
| 是 | 查询下载任务的MimeType的回调函数。 |
-
示例
**示例:**
```
js
```
js
downloadTask
.
queryMimeType
((
err
,
data
)
=>
{
downloadTask
.
queryMimeType
((
err
,
data
)
=>
{
...
@@ -821,12 +844,13 @@ pause(): Promise<void>
...
@@ -821,12 +844,13 @@ pause(): Promise<void>
**系统能力**
: SystemCapability.MiscServices.Download
**系统能力**
: SystemCapability.MiscServices.Download
-
返回值:
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
void
>
| 暂停下载任务是否成功。 |
| Promise
<
void
>
| 暂停下载任务是否成功。 |
-
示例
**示例:**
```
js
```
js
downloadTask
.
pause
().
then
((
result
)
=>
{
downloadTask
.
pause
().
then
((
result
)
=>
{
...
@@ -851,12 +875,13 @@ pause(callback: AsyncCallback<void>): void
...
@@ -851,12 +875,13 @@ pause(callback: AsyncCallback<void>): void
**系统能力**
: SystemCapability.MiscServices.Download
**系统能力**
: SystemCapability.MiscServices.Download
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
void
>
| 是 | 暂停下载任务的回调函数。 |
| callback | AsyncCallback
<
void
>
| 是 | 暂停下载任务的回调函数。 |
-
示例
**示例:**
```
js
```
js
downloadTask
.
pause
((
err
,
result
)
=>
{
downloadTask
.
pause
((
err
,
result
)
=>
{
...
@@ -883,12 +908,13 @@ resume(): Promise<void>
...
@@ -883,12 +908,13 @@ resume(): Promise<void>
**系统能力**
: SystemCapability.MiscServices.Download
**系统能力**
: SystemCapability.MiscServices.Download
-
参数:
**参数:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
void
>
| 重新启动暂停的下载任务是否成功。 |
| Promise
<
void
>
| 重新启动暂停的下载任务是否成功。 |
-
示例
**示例:**
```
js
```
js
downloadTask
.
resume
().
then
((
result
)
=>
{
downloadTask
.
resume
().
then
((
result
)
=>
{
...
@@ -914,12 +940,13 @@ resume(callback: AsyncCallback<void>): void
...
@@ -914,12 +940,13 @@ resume(callback: AsyncCallback<void>): void
**系统能力**
: SystemCapability.MiscServices.Download
**系统能力**
: SystemCapability.MiscServices.Download
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 说明 |
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
void
>
| 是 | 重新启动暂停的下载任务的回调函数。 |
| callback | AsyncCallback
<
void
>
| 是 | 重新启动暂停的下载任务的回调函数。 |
-
示例
**示例:**
```
js
```
js
downloadTask
.
resume
((
err
,
result
)
=>
{
downloadTask
.
resume
((
err
,
result
)
=>
{
...
@@ -947,7 +974,7 @@ resume(callback: AsyncCallback<void>): void
...
@@ -947,7 +974,7 @@ resume(callback: AsyncCallback<void>): void
| enableMetered | boolean | 否 | 允许在按流量计费的连接下下载。 |
| enableMetered | boolean | 否 | 允许在按流量计费的连接下下载。 |
| enableRoaming | boolean | 否 | 允许在漫游网络中下载。 |
| enableRoaming | boolean | 否 | 允许在漫游网络中下载。 |
| description | string | 否 | 设置下载会话的描述。 |
| description | string | 否 | 设置下载会话的描述。 |
| filePath
<sup>
7+
</sup>
| string | 否 | 设置下载路径(默认在
[
ERROR:Invalid link:zh-cn_topic_0000001135742582.xml#xref8132147102215,link:zh-cn_topic_0000001127125012.xml#section1856519365229
](
zh-cn_topic_0000001127125012.xml#section1856519365229
)
路径下)。
<br/>
-
filePath:'workspace/test.txt':默认路径下创建workspace路径,并将文件存储在workspace路径下。
<br/>
-
filePath:'test.txt':将文件存储在默认路径下。
<br/>
-
filePath:'workspace/':默认路径下创建workspace路径,并将文件存储在workspace路径下。 |
| filePath
<sup>
7+
</sup>
| string | 否 | 设置下载路径(默认在
'internal://cache/'
路径下)。
<br/>
-
filePath:'workspace/test.txt':默认路径下创建workspace路径,并将文件存储在workspace路径下。
<br/>
-
filePath:'test.txt':将文件存储在默认路径下。
<br/>
-
filePath:'workspace/':默认路径下创建workspace路径,并将文件存储在workspace路径下。 |
| networkType | number | 否 | 设置允许下载的网络类型。 |
| networkType | number | 否 | 设置允许下载的网络类型。 |
| title | string | 否 | 设置下载会话标题。 |
| title | string | 否 | 设置下载会话标题。 |
...
...
zh-cn/application-dev/reference/apis/js-apis-system-time.md
浏览文件 @
5df2c931
# 设置系统时间
# 设置系统时间
本模块用来设置、获取当前系统时间,设置、获取当前系统日期和设置、获取当前系统时区。
>  **说明:**
>  **说明:**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
@@ -22,13 +23,14 @@ setTime(time : number, callback : AsyncCallback<void>) : void
...
@@ -22,13 +23,14 @@ setTime(time : number, callback : AsyncCallback<void>) : void
**系统能力:**
SystemCapability.Miscservices.Time
**系统能力:**
SystemCapability.Miscservices.Time
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| time | number | 是 | 目标时间戳(
毫秒
)。 |
| time | number | 是 | 目标时间戳(
ms
)。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,可以在回调函数中处理接口返回值。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,可以在回调函数中处理接口返回值。 |
-
示例:
**示例:**
```
js
```
js
// time对应的时间为2021-01-20 02:36:25
// time对应的时间为2021-01-20 02:36:25
...
@@ -53,17 +55,19 @@ setTime(time : number) : Promise<void>
...
@@ -53,17 +55,19 @@ setTime(time : number) : Promise<void>
**系统能力:**
SystemCapability.MiscServices.Time
**系统能力:**
SystemCapability.MiscServices.Time
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| time | number | 是 | 目标时间戳(毫秒)。 |
| time | number | 是 | 目标时间戳(ms)。 |
**返回值:**
-
返回值:
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
void
>
| 返回的异步回调函数。 |
| Promise
<
void
>
| 返回的异步回调函数。 |
-
示例:
**示例:**
```
js
```
js
// time对应的时间为2021-01-20 02:36:25
// time对应的时间为2021-01-20 02:36:25
...
@@ -84,13 +88,14 @@ getCurrentTime(isNano?: boolean, callback: AsyncCallback<number>): void
...
@@ -84,13 +88,14 @@ getCurrentTime(isNano?: boolean, callback: AsyncCallback<number>): void
**系统能力:**
SystemCapability.MiscServices.Time
**系统能力:**
SystemCapability.MiscServices.Time
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| isNano | boolean | 否 | 如果是true,返回纳秒数;否则返回毫秒数。 |
| isNano | boolean | 否 | 如果是true,返回纳秒数;否则返回毫秒数。 |
| callback | AsyncCallback
<
number
>
| 是 | 回调函数,返回自
Unix
纪元以来经过的时间。 |
| callback | AsyncCallback
<
number
>
| 是 | 回调函数,返回自
Unix
纪元以来经过的时间。 |
-
示例:
**示例:**
```
js
```
js
systemTime
.
getCurrentTime
(
true
,
(
error
,
data
)
=>
{
systemTime
.
getCurrentTime
(
true
,
(
error
,
data
)
=>
{
...
@@ -111,17 +116,19 @@ getCurrentTime(isNano?: boolean): Promise<number>
...
@@ -111,17 +116,19 @@ getCurrentTime(isNano?: boolean): Promise<number>
**系统能力:**
SystemCapability.MiscServices.Time
**系统能力:**
SystemCapability.MiscServices.Time
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| isNano | boolean | 否 | 如果是true,返回纳秒数;否则返回毫秒数。 |
| isNano | boolean | 否 | 如果是true,返回纳秒数;否则返回毫秒数。 |
-
返回值:
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
number
>
| 以Promise形式返回结果,返回自
Unix
纪元以来经过的时间。 |
| Promise
<
number
>
| 以Promise形式返回结果,返回自
Unix
纪元以来经过的时间。 |
-
示例:
**示例:**
```
js
```
js
systemTime
.
getCurrentTime
().
then
((
data
)
=>
{
systemTime
.
getCurrentTime
().
then
((
data
)
=>
{
...
@@ -140,13 +147,14 @@ getRealActiveTime(isNano?: boolean, callback: AsyncCallback<number>): void
...
@@ -140,13 +147,14 @@ getRealActiveTime(isNano?: boolean, callback: AsyncCallback<number>): void
**系统能力:**
SystemCapability.MiscServices.Time
**系统能力:**
SystemCapability.MiscServices.Time
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| isNano | boolean | 否 | 如果是true,返回纳秒数;否则返回毫秒数。 |
| isNano | boolean | 否 | 如果是true,返回纳秒数;否则返回毫秒数。 |
| callback | AsyncCallback
<
number
>
| 是 | 回调函数,返回自系统启动以来但不包括度睡眠时间经过的时间。 |
| callback | AsyncCallback
<
number
>
| 是 | 回调函数,返回自系统启动以来但不包括度睡眠时间经过的时间。 |
-
示例:
**示例:**
```
js
```
js
systemTime
.
getRealActiveTime
(
true
,
(
error
,
data
)
=>
{
systemTime
.
getRealActiveTime
(
true
,
(
error
,
data
)
=>
{
...
@@ -167,17 +175,19 @@ getRealActiveTime(isNano?: boolean): Promise<number>
...
@@ -167,17 +175,19 @@ getRealActiveTime(isNano?: boolean): Promise<number>
**系统能力:**
SystemCapability.MiscServices.Time
**系统能力:**
SystemCapability.MiscServices.Time
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| isNano | boolean | 否 | 如果是true,返回纳秒数;否则返回毫秒数。 |
| isNano | boolean | 否 | 如果是true,返回纳秒数;否则返回毫秒数。 |
-
返回值:
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
number
>
| 以Promise形式返回结果,返回自系统启动以来
但不包括度睡眠时间经过的
时间。 |
| Promise
<
number
>
| 以Promise形式返回结果,返回自系统启动以来
经过的时间,但不包括深度睡眠
时间。 |
-
示例:
**示例:**
```
js
```
js
systemTime
.
getCurrentTime
().
then
((
data
)
=>
{
systemTime
.
getCurrentTime
().
then
((
data
)
=>
{
...
@@ -196,13 +206,14 @@ getRealTime(callback: AsyncCallback<number>): void
...
@@ -196,13 +206,14 @@ getRealTime(callback: AsyncCallback<number>): void
**系统能力:**
SystemCapability.MiscServices.Time
**系统能力:**
SystemCapability.MiscServices.Time
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| isNano | boolean | 否 | 如果是true,返回纳秒数;否则返回毫秒数。 |
| isNano | boolean | 否 | 如果是true,返回纳秒数;否则返回毫秒数。 |
| callback | AsyncCallback
<
number
>
| 是 | 回调函数,返回自系统启动以来
包括深度睡眠时间经过的毫秒数
。 |
| callback | AsyncCallback
<
number
>
| 是 | 回调函数,返回自系统启动以来
经过的时间,包括深度睡眠时间
。 |
-
示例:
**示例:**
```
js
```
js
systemTime
.
getRealTime
(
true
,
(
error
,
data
)
=>
{
systemTime
.
getRealTime
(
true
,
(
error
,
data
)
=>
{
...
@@ -223,17 +234,19 @@ getRealTime(): Promise<number>
...
@@ -223,17 +234,19 @@ getRealTime(): Promise<number>
**系统能力:**
SystemCapability.MiscServices.Time
**系统能力:**
SystemCapability.MiscServices.Time
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| isNano | boolean | 否 | 如果是true,返回纳秒数;否则返回毫秒数。 |
| isNano | boolean | 否 | 如果是true,返回纳秒数;否则返回毫秒数。 |
-
返回值:
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
number
>
| 以Promise形式返回结果,返回自系统启动以来
包括深度睡眠时间经过的
时间。 |
| Promise
<
number
>
| 以Promise形式返回结果,返回自系统启动以来
经过的时间,包括深度睡眠
时间。 |
-
示例:
**示例:**
```
js
```
js
systemTime
.
getRealTime
().
then
((
data
)
=>
{
systemTime
.
getRealTime
().
then
((
data
)
=>
{
...
@@ -254,13 +267,14 @@ setDate(date: Date, callback: AsyncCallback<void>): void
...
@@ -254,13 +267,14 @@ setDate(date: Date, callback: AsyncCallback<void>): void
**系统能力:**
SystemCapability.MiscServices.Time
**系统能力:**
SystemCapability.MiscServices.Time
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| date | Date | 是 | 目标日期。 |
| date | Date | 是 | 目标日期。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,可以在回调函数中处理接口返回值。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,可以在回调函数中处理接口返回值。 |
-
示例:
**示例:**
```
js
```
js
var
data
=
new
Date
(
"
October 13, 2020 11:13:00
"
);
var
data
=
new
Date
(
"
October 13, 2020 11:13:00
"
);
...
@@ -284,17 +298,19 @@ setDate(date: Date): Promise<void>
...
@@ -284,17 +298,19 @@ setDate(date: Date): Promise<void>
**系统能力:**
SystemCapability.MiscServices.Time
**系统能力:**
SystemCapability.MiscServices.Time
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| date | Date | 是 | 目标日期。 |
| date | Date | 是 | 目标日期。 |
-
返回值:
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
void
>
| 返回的异步回调函数。 |
| Promise
<
void
>
| 返回的异步回调函数。 |
-
示例:
**示例:**
```
js
```
js
var
data
=
new
Date
(
"
October 13, 2020 11:13:00
"
);
var
data
=
new
Date
(
"
October 13, 2020 11:13:00
"
);
...
@@ -314,12 +330,13 @@ getDate(callback: AsyncCallback<Date>): void
...
@@ -314,12 +330,13 @@ getDate(callback: AsyncCallback<Date>): void
**系统能力:**
SystemCapability.MiscServices.Time
**系统能力:**
SystemCapability.MiscServices.Time
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
Date
>
| 是 | 回调函数,返回当前系统日期。 |
| callback | AsyncCallback
<
Date
>
| 是 | 回调函数,返回当前系统日期。 |
-
示例:
**示例:**
```
js
```
js
systemTime
.
getDate
((
error
,
data
)
=>
{
systemTime
.
getDate
((
error
,
data
)
=>
{
...
@@ -340,12 +357,13 @@ getDate(): Promise<Date>
...
@@ -340,12 +357,13 @@ getDate(): Promise<Date>
**系统能力:**
SystemCapability.MiscServices.Time
**系统能力:**
SystemCapability.MiscServices.Time
-
返回值:
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
Date
>
| 以Promise形式返回结果,返回当前系统日期。 |
| Promise
<
Date
>
| 以Promise形式返回结果,返回当前系统日期。 |
-
示例:
**示例:**
```
js
```
js
systemTime
.
getDate
().
then
((
data
)
=>
{
systemTime
.
getDate
().
then
((
data
)
=>
{
...
@@ -366,13 +384,14 @@ setTimezone(timezone: string, callback: AsyncCallback<void>): void
...
@@ -366,13 +384,14 @@ setTimezone(timezone: string, callback: AsyncCallback<void>): void
**系统能力:**
SystemCapability.MiscServices.Time
**系统能力:**
SystemCapability.MiscServices.Time
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| timezone | string | 是 | 系统时区。 |
| timezone | string | 是 | 系统时区。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,可以在回调函数中处理接口返回值。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,可以在回调函数中处理接口返回值。 |
-
示例:
**示例:**
```
js
```
js
systemTime
.
setTimezone
(
'
Asia/Shanghai
'
,
(
error
,
data
)
=>
{
systemTime
.
setTimezone
(
'
Asia/Shanghai
'
,
(
error
,
data
)
=>
{
...
@@ -395,17 +414,19 @@ setTimezone(timezone: string): Promise<void>
...
@@ -395,17 +414,19 @@ setTimezone(timezone: string): Promise<void>
**系统能力:**
SystemCapability.MiscServices.Time
**系统能力:**
SystemCapability.MiscServices.Time
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| timezone | string | 是 | 系统时区。 |
| timezone | string | 是 | 系统时区。 |
-
返回值:
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
void
>
| 返回的异步回调函数。 |
| Promise
<
void
>
| 返回的异步回调函数。 |
-
示例:
**示例:**
```
js
```
js
systemTime
.
setTimezone
(
'
Asia/Shanghai
'
).
then
((
data
)
=>
{
systemTime
.
setTimezone
(
'
Asia/Shanghai
'
).
then
((
data
)
=>
{
...
@@ -424,12 +445,13 @@ getTimezone(callback: AsyncCallback<string>): void
...
@@ -424,12 +445,13 @@ getTimezone(callback: AsyncCallback<string>): void
**系统能力:**
SystemCapability.MiscServices.Time
**系统能力:**
SystemCapability.MiscServices.Time
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
string
>
| 是 | 回调函数,返回系统时区。 |
| callback | AsyncCallback
<
string
>
| 是 | 回调函数,返回系统时区。 |
-
示例:
**示例:**
```
js
```
js
systemTime
.
getTimezone
((
error
,
data
)
=>
{
systemTime
.
getTimezone
((
error
,
data
)
=>
{
...
@@ -450,12 +472,13 @@ getTimezone(): Promise<string>
...
@@ -450,12 +472,13 @@ getTimezone(): Promise<string>
**系统能力:**
SystemCapability.MiscServices.Time
**系统能力:**
SystemCapability.MiscServices.Time
-
返回值:
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
string
>
| 以Promise形式返回结果,返回系统时区。 |
| Promise
<
string
>
| 以Promise形式返回结果,返回系统时区。 |
-
示例:
**示例:**
```
js
```
js
systemTime
.
getTimezone
().
then
((
data
)
=>
{
systemTime
.
getTimezone
().
then
((
data
)
=>
{
...
...
zh-cn/application-dev/reference/apis/js-apis-wallpaper.md
浏览文件 @
5df2c931
...
@@ -32,13 +32,14 @@ getColors(wallpaperType: WallpaperType, callback: AsyncCallback<Array<Rgba
...
@@ -32,13 +32,14 @@ getColors(wallpaperType: WallpaperType, callback: AsyncCallback<Array<Rgba
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统能力**
: SystemCapability.MiscServices.Wallpaper
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| wallpaperType |
[
WallpaperType
](
#wallpapertype
)
| 是 | 壁纸类型。 |
| wallpaperType |
[
WallpaperType
](
#wallpapertype
)
| 是 | 壁纸类型。 |
| callback | AsyncCallback
<
Array
<
[RgbaColor](#rgbacolor)
>>
| 是 | 回调函数,返回壁纸的主要颜色信息。 |
| callback | AsyncCallback
<
Array
<
[RgbaColor](#rgbacolor)
>>
| 是 | 回调函数,返回壁纸的主要颜色信息。 |
-
示例:
**示例:**
```
js
```
js
wallpaper
.
getColors
(
wallpaper
.
WallpaperType
.
WALLPAPER_SYSTEM
,
(
error
,
data
)
=>
{
wallpaper
.
getColors
(
wallpaper
.
WallpaperType
.
WALLPAPER_SYSTEM
,
(
error
,
data
)
=>
{
...
@@ -59,17 +60,19 @@ getColors(wallpaperType: WallpaperType): Promise<Array<RgbaColor>>
...
@@ -59,17 +60,19 @@ getColors(wallpaperType: WallpaperType): Promise<Array<RgbaColor>>
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统能力**
: SystemCapability.MiscServices.Wallpaper
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| wallpaperType |
[
WallpaperType
](
#wallpapertype
)
| 是 | 壁纸类型。 |
| wallpaperType |
[
WallpaperType
](
#wallpapertype
)
| 是 | 壁纸类型。 |
-
返回值:
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
Array
<
[RgbaColor](#rgbacolor)
>>
| 返回壁纸的主要颜色信息。 |
| Promise
<
Array
<
[RgbaColor](#rgbacolor)
>>
| 返回壁纸的主要颜色信息。 |
-
示例:
**示例:**
```
js
```
js
wallpaper
.
getColors
(
wallpaper
.
WallpaperType
.
WALLPAPER_SYSTEM
).
then
((
data
)
=>
{
wallpaper
.
getColors
(
wallpaper
.
WallpaperType
.
WALLPAPER_SYSTEM
).
then
((
data
)
=>
{
...
@@ -88,13 +91,14 @@ getId(wallpaperType: WallpaperType, callback: AsyncCallback<number>): void
...
@@ -88,13 +91,14 @@ getId(wallpaperType: WallpaperType, callback: AsyncCallback<number>): void
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统能力**
: SystemCapability.MiscServices.Wallpaper
-
参数
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| wallpaperType |
[
WallpaperType
](
#wallpapertype
)
| 是 | 壁纸类型。 |
| wallpaperType |
[
WallpaperType
](
#wallpapertype
)
| 是 | 壁纸类型。 |
| callback | AsyncCallback
<
number
>
| 是 | 回调函数,返回壁纸的ID。如果配置了指定类型的壁纸就返回一个大于等于0的数,否则返回-1。取值范围是-1~2^31-1。 |
| callback | AsyncCallback
<
number
>
| 是 | 回调函数,返回壁纸的ID。如果配置了指定类型的壁纸就返回一个大于等于0的数,否则返回-1。取值范围是-1~2^31-1。 |
-
示例:
**示例:**
```
js
```
js
wallpaper
.
getId
(
wallpaper
.
WallpaperType
.
WALLPAPER_SYSTEM
,
(
error
,
data
)
=>
{
wallpaper
.
getId
(
wallpaper
.
WallpaperType
.
WALLPAPER_SYSTEM
,
(
error
,
data
)
=>
{
...
@@ -116,17 +120,19 @@ getId(wallpaperType: WallpaperType): Promise<number>
...
@@ -116,17 +120,19 @@ getId(wallpaperType: WallpaperType): Promise<number>
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统能力**
: SystemCapability.MiscServices.Wallpaper
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| wallpaperType |
[
WallpaperType
](
#wallpapertype
)
| 是 | 壁纸类型。 |
| wallpaperType |
[
WallpaperType
](
#wallpapertype
)
| 是 | 壁纸类型。 |
-
返回值:
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
number
>
| 壁纸的ID。如果配置了这种壁纸类型的壁纸就返回一个大于等于0的数,否则返回-1。取值范围是-1~2^31-1。 |
| Promise
<
number
>
| 壁纸的ID。如果配置了这种壁纸类型的壁纸就返回一个大于等于0的数,否则返回-1。取值范围是-1~2^31-1。 |
-
示例:
**示例:**
```
js
```
js
wallpaper
.
getId
(
wallpaper
.
WallpaperType
.
WALLPAPER_SYSTEM
).
then
((
data
)
=>
{
wallpaper
.
getId
(
wallpaper
.
WallpaperType
.
WALLPAPER_SYSTEM
).
then
((
data
)
=>
{
...
@@ -145,12 +151,13 @@ getMinHeight(callback: AsyncCallback<number>): void
...
@@ -145,12 +151,13 @@ getMinHeight(callback: AsyncCallback<number>): void
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统能力**
: SystemCapability.MiscServices.Wallpaper
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
number
>
| 是 | 回调函数,返回壁纸的最小高度值,单位是像素。如果返回值等于0,说明没有设置壁纸,调用者应该使用默认显示的高度值代替。 |
| callback | AsyncCallback
<
number
>
| 是 | 回调函数,返回壁纸的最小高度值,单位是像素。如果返回值等于0,说明没有设置壁纸,调用者应该使用默认显示的高度值代替。 |
-
示例:
**示例:**
```
js
```
js
wallpaper
.
getMinHeight
((
error
,
data
)
=>
{
wallpaper
.
getMinHeight
((
error
,
data
)
=>
{
...
@@ -172,12 +179,13 @@ getMinHeight(): Promise<number>
...
@@ -172,12 +179,13 @@ getMinHeight(): Promise<number>
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统能力**
: SystemCapability.MiscServices.Wallpaper
-
返回值:
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
number
>
| 返回壁纸的最小高度值,单位是像素。如果返回值等于0,说明没有设置壁纸,调用者应该使用默认显示的高度值代替。 |
| Promise
<
number
>
| 返回壁纸的最小高度值,单位是像素。如果返回值等于0,说明没有设置壁纸,调用者应该使用默认显示的高度值代替。 |
-
示例:
**示例:**
```
js
```
js
wallpaper
.
getMinHeight
().
then
((
data
)
=>
{
wallpaper
.
getMinHeight
().
then
((
data
)
=>
{
...
@@ -197,12 +205,13 @@ getMinWidth(callback: AsyncCallback<number>): void
...
@@ -197,12 +205,13 @@ getMinWidth(callback: AsyncCallback<number>): void
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统能力**
: SystemCapability.MiscServices.Wallpaper
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
number
>
| 是 | 回调函数,壁纸的最小宽度值,单位是像素。如果返回值等于0,说明没有设置壁纸,调用者应该使用默认显示的宽度值代替。 |
| callback | AsyncCallback
<
number
>
| 是 | 回调函数,壁纸的最小宽度值,单位是像素。如果返回值等于0,说明没有设置壁纸,调用者应该使用默认显示的宽度值代替。 |
-
示例:
**示例:**
```
js
```
js
wallpaper
.
getMinWidth
((
error
,
data
)
=>
{
wallpaper
.
getMinWidth
((
error
,
data
)
=>
{
...
@@ -223,12 +232,13 @@ getMinWidth(): Promise<number>
...
@@ -223,12 +232,13 @@ getMinWidth(): Promise<number>
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统能力**
: SystemCapability.MiscServices.Wallpaper
-
返回值:
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
number
>
| 壁纸的最小宽度值,单位是像素。如果返回值等于0,说明没有设置壁纸,调用者应该使用默认显示的宽度值代替。 |
| Promise
<
number
>
| 壁纸的最小宽度值,单位是像素。如果返回值等于0,说明没有设置壁纸,调用者应该使用默认显示的宽度值代替。 |
-
示例:
**示例:**
```
js
```
js
wallpaper
.
getMinWidth
().
then
((
data
)
=>
{
wallpaper
.
getMinWidth
().
then
((
data
)
=>
{
...
@@ -247,12 +257,13 @@ isChangePermitted(callback: AsyncCallback<boolean>): void
...
@@ -247,12 +257,13 @@ isChangePermitted(callback: AsyncCallback<boolean>): void
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统能力**
: SystemCapability.MiscServices.Wallpaper
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调函数,返回是否允许应用改变当前用户的壁纸。如果允许返回true,否则返回false。 |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调函数,返回是否允许应用改变当前用户的壁纸。如果允许返回true,否则返回false。 |
-
示例:
**示例:**
```
js
```
js
wallpaper
.
isChangePermitted
((
error
,
data
)
=>
{
wallpaper
.
isChangePermitted
((
error
,
data
)
=>
{
...
@@ -273,12 +284,13 @@ isChangePermitted(): Promise<boolean>
...
@@ -273,12 +284,13 @@ isChangePermitted(): Promise<boolean>
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统能力**
: SystemCapability.MiscServices.Wallpaper
-
返回值:
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
boolean
>
| 返回是否允许应用改变当前用户的壁纸。如果允许返回true,否则返回false。 |
| Promise
<
boolean
>
| 返回是否允许应用改变当前用户的壁纸。如果允许返回true,否则返回false。 |
-
示例:
**示例:**
```
js
```
js
wallpaper
.
isChangePermitted
().
then
((
data
)
=>
{
wallpaper
.
isChangePermitted
().
then
((
data
)
=>
{
...
@@ -297,12 +309,13 @@ isOperationAllowed(callback: AsyncCallback<boolean>): void
...
@@ -297,12 +309,13 @@ isOperationAllowed(callback: AsyncCallback<boolean>): void
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统能力**
: SystemCapability.MiscServices.Wallpaper
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调函数,返回是否允许用户设置壁纸。如果允许返回true,否则返回false。 |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调函数,返回是否允许用户设置壁纸。如果允许返回true,否则返回false。 |
-
示例:
**示例:**
```
js
```
js
wallpaper
.
isOperationAllowed
((
error
,
data
)
=>
{
wallpaper
.
isOperationAllowed
((
error
,
data
)
=>
{
...
@@ -323,12 +336,13 @@ isOperationAllowed(): Promise<boolean>
...
@@ -323,12 +336,13 @@ isOperationAllowed(): Promise<boolean>
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统能力**
: SystemCapability.MiscServices.Wallpaper
-
返回值:
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
boolean
>
| 异步回调函数,返回是否允许用户设置壁纸。如果允许返回true,否则返回false。 |
| Promise
<
boolean
>
| 异步回调函数,返回是否允许用户设置壁纸。如果允许返回true,否则返回false。 |
-
示例:
**示例:**
```
js
```
js
wallpaper
.
isOperationAllowed
().
then
((
data
)
=>
{
wallpaper
.
isOperationAllowed
().
then
((
data
)
=>
{
...
@@ -349,13 +363,14 @@ reset(wallpaperType: WallpaperType, callback: AsyncCallback<void>): void
...
@@ -349,13 +363,14 @@ reset(wallpaperType: WallpaperType, callback: AsyncCallback<void>): void
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统能力**
: SystemCapability.MiscServices.Wallpaper
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| wallpaperType |
[
WallpaperType
](
#wallpapertype
)
| 是 | 壁纸类型。 |
| wallpaperType |
[
WallpaperType
](
#wallpapertype
)
| 是 | 壁纸类型。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,调用成功则返回是否移除成功的结果,调用失败则返回error信息。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,调用成功则返回是否移除成功的结果,调用失败则返回error信息。 |
-
示例:
**示例:**
```
js
```
js
wallpaper
.
reset
(
wallpaper
.
WallpaperType
.
WALLPAPER_SYSTEM
,
(
error
,
data
)
=>
{
wallpaper
.
reset
(
wallpaper
.
WallpaperType
.
WALLPAPER_SYSTEM
,
(
error
,
data
)
=>
{
...
@@ -378,17 +393,19 @@ reset(wallpaperType: WallpaperType): Promise<void>
...
@@ -378,17 +393,19 @@ reset(wallpaperType: WallpaperType): Promise<void>
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统能力**
: SystemCapability.MiscServices.Wallpaper
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| wallpaperType |
[
WallpaperType
](
#wallpapertype
)
| 是 | 壁纸类型。 |
| wallpaperType |
[
WallpaperType
](
#wallpapertype
)
| 是 | 壁纸类型。 |
-
返回值:
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
void
>
| 调用成功则返回是否移除成功的结果,调用失败则返回error信息。 |
| Promise
<
void
>
| 调用成功则返回是否移除成功的结果,调用失败则返回error信息。 |
-
示例:
**示例:**
```
js
```
js
wallpaper
.
reset
(
wallpaper
.
WallpaperType
.
WALLPAPER_SYSTEM
).
then
((
data
)
=>
{
wallpaper
.
reset
(
wallpaper
.
WallpaperType
.
WALLPAPER_SYSTEM
).
then
((
data
)
=>
{
...
@@ -409,14 +426,15 @@ setWallpaper(source: string | image.PixelMap, wallpaperType: WallpaperType, call
...
@@ -409,14 +426,15 @@ setWallpaper(source: string | image.PixelMap, wallpaperType: WallpaperType, call
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统能力**
: SystemCapability.MiscServices.Wallpaper
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| source | string
\|
[
PixelMap
](
js-apis-image.md#pixelmap7
)
| | JPEG或PNG文件的Uri路径,或者PNG格式文件的位图。 |
| source | string
\|
[
PixelMap
](
js-apis-image.md#pixelmap7
)
| | JPEG或PNG文件的Uri路径,或者PNG格式文件的位图。 |
| wallpaperType |
[
WallpaperType
](
#wallpapertype
)
| 是 | 壁纸类型。 |
| wallpaperType |
[
WallpaperType
](
#wallpapertype
)
| 是 | 壁纸类型。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,调用成功则返回是返回设置的结果,调用失败则返回error信息。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,调用成功则返回是返回设置的结果,调用失败则返回error信息。 |
-
示例:
**示例:**
```
js
```
js
// source类型为string
// source类型为string
...
@@ -462,18 +480,20 @@ setWallpaper(source: string | image.PixelMap, wallpaperType: WallpaperType): Pro
...
@@ -462,18 +480,20 @@ setWallpaper(source: string | image.PixelMap, wallpaperType: WallpaperType): Pro
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统能力**
: SystemCapability.MiscServices.Wallpaper
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| source | string
\|
[
PixelMap
](
js-apis-image.md#pixelmap7
)
| 是 | JPEG或PNG文件的Uri路径,或者PNG格式文件的位图。 |
| source | string
\|
[
PixelMap
](
js-apis-image.md#pixelmap7
)
| 是 | JPEG或PNG文件的Uri路径,或者PNG格式文件的位图。 |
| wallpaperType |
[
WallpaperType
](
#wallpapertype
)
| 是 | 壁纸类型。 |
| wallpaperType |
[
WallpaperType
](
#wallpapertype
)
| 是 | 壁纸类型。 |
-
返回值:
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
void
>
| 调用成功则返回是返回设置的结果,调用失败则返回error信息。 |
| Promise
<
void
>
| 调用成功则返回是返回设置的结果,调用失败则返回error信息。 |
-
示例:
**示例:**
```
js
```
js
// source类型为string
// source类型为string
...
@@ -514,13 +534,14 @@ getFile(wallpaperType: WallpaperType, callback: AsyncCallback<number>): vo
...
@@ -514,13 +534,14 @@ getFile(wallpaperType: WallpaperType, callback: AsyncCallback<number>): vo
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统能力**
: SystemCapability.MiscServices.Wallpaper
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| wallpaperType |
[
WallpaperType
](
#wallpapertype
)
| 是 | 壁纸类型。 |
| wallpaperType |
[
WallpaperType
](
#wallpapertype
)
| 是 | 壁纸类型。 |
| callback | AsyncCallback
<
number
>
| 是 | 回调函数,调用成功则返回壁纸文件描述符ID,调用失败则返回error信息。 |
| callback | AsyncCallback
<
number
>
| 是 | 回调函数,调用成功则返回壁纸文件描述符ID,调用失败则返回error信息。 |
-
示例:
**示例:**
```
js
```
js
wallpaper
.
getFile
(
wallpaper
.
WallpaperType
.
WALLPAPER_SYSTEM
,
(
error
,
data
)
=>
{
wallpaper
.
getFile
(
wallpaper
.
WallpaperType
.
WALLPAPER_SYSTEM
,
(
error
,
data
)
=>
{
...
@@ -542,17 +563,19 @@ getFile(wallpaperType: WallpaperType): Promise<number>
...
@@ -542,17 +563,19 @@ getFile(wallpaperType: WallpaperType): Promise<number>
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统能力**
: SystemCapability.MiscServices.Wallpaper
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| wallpaperType |
[
WallpaperType
](
#wallpapertype
)
| 是 | 壁纸类型。 |
| wallpaperType |
[
WallpaperType
](
#wallpapertype
)
| 是 | 壁纸类型。 |
-
返回值:
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
number
>
| 调用成功则返回壁纸文件描述符ID,调用失败则返回error信息。 |
| Promise
<
number
>
| 调用成功则返回壁纸文件描述符ID,调用失败则返回error信息。 |
-
示例:
**示例:**
```
js
```
js
wallpaper
.
getFile
(
wallpaper
.
WallpaperType
.
WALLPAPER_SYSTEM
).
then
((
data
)
=>
{
wallpaper
.
getFile
(
wallpaper
.
WallpaperType
.
WALLPAPER_SYSTEM
).
then
((
data
)
=>
{
...
@@ -571,13 +594,14 @@ on(type: 'colorChange', callback: (colors: Array<RgbaColor>, wallpaperType
...
@@ -571,13 +594,14 @@ on(type: 'colorChange', callback: (colors: Array<RgbaColor>, wallpaperType
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统能力**
: SystemCapability.MiscServices.Wallpaper
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 取值为'colorChange',表示壁纸颜色变化结果上报事件。 |
| type | string | 是 | 取值为'colorChange',表示壁纸颜色变化结果上报事件。 |
| callback | function | 是 | 壁纸颜色变化触发该回调方法,返回壁纸类型和壁纸的主要颜色信息。
<br/>
-
colors
<br/>
壁纸的主要颜色信息,其类型见[RgbaColor](#rgbacolor)。
<br/>
-
wallpaperType
<br/>
壁纸类型。 |
| callback | function | 是 | 壁纸颜色变化触发该回调方法,返回壁纸类型和壁纸的主要颜色信息。
<br/>
-
colors
<br/>
壁纸的主要颜色信息,其类型见[RgbaColor](#rgbacolor)。
<br/>
-
wallpaperType
<br/>
壁纸类型。 |
-
示例:
**示例:**
```
js
```
js
let
listener
=
(
colors
,
wallpaperType
)
=>
{
let
listener
=
(
colors
,
wallpaperType
)
=>
{
...
@@ -595,13 +619,14 @@ off(type: 'colorChange', callback?: (colors: Array<RgbaColor>, wallpaperTy
...
@@ -595,13 +619,14 @@ off(type: 'colorChange', callback?: (colors: Array<RgbaColor>, wallpaperTy
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统能力**
: SystemCapability.MiscServices.Wallpaper
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 取值为'colorChange',表示取消订阅壁纸颜色变化结果上报事件。 |
| type | string | 是 | 取值为'colorChange',表示取消订阅壁纸颜色变化结果上报事件。 |
| callback | function | 否 |
表示取消壁纸颜色变化结果上报,不填写该参数则取消订阅该type对应的所有回调。
<br/>
-
colors
<br/>
壁纸的主要颜色信息,其类型见[RgbaColor](#rgbacolor)。
<br/>
-
wallpaperType
<br/>
壁纸类型。 |
| callback | function | 否 |
表示取消壁纸颜色变化结果上报,不填写该参数则取消订阅该type对应的所有回调。
<br/>
-
colors
<br/>
壁纸的主要颜色信息,其类型见[RgbaColor](#rgbacolor)。
<br/>
-
wallpaperType
<br/>
壁纸类型。 |
-
示例:
**示例:**
```
js
```
js
let
listener
=
(
colors
,
wallpaperType
)
=>
{
let
listener
=
(
colors
,
wallpaperType
)
=>
{
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录