uni小程序API文档.pdf - 第2页
uni ⼩程序 API ⽂档 .md 2023/3/27 2 / 10 o p t i o n s 参 数 说 明 J S O N O b j e c t 类 型 属 性 类 型 默 认 值 必 填 说 明 a p p i d S t r i n g ⽆ 是 u n i ⼩ 程 序 的 a p p i d w g t F i l e S t r i n g ⽆ 是 w g t 资 源 ⽂ 件 路 径 p a s s w o r d S …
uni⼩程序API⽂档.md
2023/3/27
1 / 10
为了便于
理
解
un
i
⼩
程
序
API
的
使
⽤
，
需
要
知
道
两
种
un
i
-
a
pp
项
⽬
，⼀
种
是
un
i
-
a
pp
宿
主
A
pp
项
⽬
（
简称
“
宿
主
A
pp
”
），⼀
种
是
un
i
-
a
pp
⼩
程
序
A
pp
项
⽬
（
简称
“
un
i
⼩
程
序
”
），
以
下
将
分别
从
这
两
种
项
⽬
作为
调
⽤
者
的
⻆
度
来
介
绍
相
关
API
。
宿
主
A
pp
使
⽤
的
API
宿
主
A
pp
是
通过
uniMP
模
块
管
理
un
i
⼩
程
序
，
云
端
打
包
时
需
要
在
宿
主
A
pp
项
⽬的
m
a
n
ife
st
.
j
son
中
配
置
使
⽤
un
i
⼩
程
序
模
块
。
在
"app-plus"->"modules"
节
点
下
添
加
"UniMP"
模
块
，
示
例
如
下：
"app-plus" : {
"modules" : {
"UniMP": {
"description": "uni
⼩
程
序
"
}
},
//...
}
HB
u
ilde
r
X
中
⾃
带
的
标
准
基
座
已
经
包
含
un
i
⼩
程
序
模
块
，
可
以
直
接
调
⽤
un
i
⼩
程
序
相
关
API
配
置
后
需
提
交云
端
打
包
后
才
能
⽣
效
，
真
机
运
⾏
时
推
荐
使
⽤
⾃
定
义
调试
基
座
加
载
un
i
MP
模
块
在
调
⽤
un
i
⼩
程
序
API
时
需
先
调
⽤
un
i
.
r
e
qu
i
r
e
N
a
t
i
v
e
P
l
u
gi
n
⽅
法
加
载
un
i
⼩
程
序
管
理
模
块
。
示
例
如
下：
const mp = uni.requireNativePlugin('uniMP');
//
通过
mp
可
调
⽤
⽅
法
操
作
uni
⼩
程
序
mp.openUniMP({
appid:'
⼩
程
序
的
appid'
});
注
：
如
果
返
回
的
mp
为
un
defi
n
ed
，
说
明
当
前
环
境
不
⽀
持
un
i
⼩
程
序
i
nst
all
U
n
i
MP
(
opt
i
ons
,
callback
)
通过
w
g
t
安
装
uni
⼩
程
序
到
宿
主
A
pp
中
，
示
例
如
下：
mp.installUniMP({
appid: 'uni
⼩
程
序
的
appid',
wgtFile: 'uni
⼩
程
序
的
wgt
⽂
件
路
径
'
}, (ret)=>{
console.log('installUniMP: '+JSON.stringify(ret));
});
uni⼩程序API⽂档.md
2023/3/27
2 / 10
opt
i
ons
参
数
说
明
JSON O
bjec
t
类
型
属
性
类
型
默
认
值
必
填
说
明
a
pp
id
S
tr
i
n
g
⽆
是
un
i
⼩
程
序
的
a
pp
id
w
g
t
F
ile
S
tr
i
n
g
⽆
是
w
g
t
资
源
⽂
件
路
径
p
a
sswor
d
S
tr
i
n
g
⽆
否
w
g
t
解
压
密
码
callback
回
调
参
数
说
明
JSON O
bjec
t
类
型
属
性
类
型
说
明
typ
e
S
tr
i
n
g
"
su
cce
ss
"
表
示
成
功
，
"
fail
"
表
示
失
败
c
o
de
N
um
be
r
成
功
返
回
0
，
失
败
返
回
相
应
c
o
de
码
m
e
ss
age
S
tr
i
n
g
失
败
描
述
op
e
n
U
n
i
MP
(
opt
i
ons
,
callback
)
打
开
uni
⼩
程
序
，
示
例
如
下：
mp.openUniMP({
appid: 'uni
⼩
程
序
的
appid'
}, (ret)=>{
console.log('openUniMP: '+JSON.stringify(ret));
});
opt
i
ons
参
数
说
明
JSON O
bjec
t
类
型
属
性
类
型
默
认
值
必
填
说
明
a
pp
id
S
tr
i
n
g
⽆
是
un
i
⼩
程
序
的
a
pp
id
ic
on
S
tr
i
n
g
⽆
否
启
动
⼩
程
序
sp
la
s
h
⻚⾯
显
示
的
图
⽚
，
默
认
显
示
a
pp
l
o
g
o
p
a
t
h
S
tr
i
n
g
⽆
否
HB
u
ilde
r
X
3.3.1+
版
本
新
增
打
开
的
⻚⾯
路
径
，
如
果
为
空
则
打
开
⾸
⻚
。
p
a
t
h
中
?
后
⾯
的
部
分
会
成
为
qu
e
ry
，
注
意
：
传
⼊
此
参
数
后
应
⽤
会
重
启
uni⼩程序API⽂档.md
2023/3/27
3 / 10
属
性
类
型
默
认
值
必
填
说
明
e
xtr
a
D
a
t
a
O
bjec
t
⽆
否
HB
u
ilde
r
X
3.3.1+
版
本
新
增
需
要
传
递
给
⽬
标
⼩
程
序
的
数据
。
⼩
程
序
接收
参
考
uni
⼩
程
序
中
获
取启
动
参
数
f
rom
A
pp
id
S
tr
i
n
g
⽆
否
HB
u
ilde
r
X
3.3.1+
版
本
新
增
打
开
un
i
⼩
程
序
的
来
源
a
pp
id
s
ce
n
e
N
um
be
r
⽆
否
HB
u
ilde
r
X
3.3.1+
版
本
新
增
启
动
⼩
程
序
的
场
景
值
，
由
宿
主
⾃
定
义
op
e
n
M
o
de
S
tr
i
n
g
pr
e
s
e
nt
否
HB
u
ilde
r
X
3.5.1+
版
本
新
增
启
动
⼩
程
序
的
动
画
⽅
式
present
:
从
当
前
⻚⾯
下
⾯
打
开
⼩
程
序
push
:
从
当
前
⻚⾯
右
侧
打
开
⼩
程
序
(
仅
i
os
⽀
持
)
e
n
able
G
e
stur
e
C
l
os
e
B
oo
lea
n tru
e
否
HB
u
ilde
r
X
3.5.1+
版
本
新
增
是
否
开
启
⼿
势关
闭
⼩
程
序
默
认
开
启
(
仅
i
os
⽀
持
)
e
n
able
S
h
ow
A
n
i
m
a
t
ed
B
oo
lea
n tru
e
否
HB
u
ilde
r
X
3.5.1+
版
本
新
增
是
否
开
启
打
开
⼩
程
序
时
的
动
画
默
认
开
启
(
仅
i
os
⽀
持
)
e
n
able
H
ide
A
n
i
m
a
t
ed
B
oo
lea
n tru
e
否
HB
u
ilde
r
X
3.5.1+
版
本
新
增
是
否
开
启
关
闭
⼩
程
序
时
的
动
画
默
认
开
启
(
仅
i
os
⽀
持
)
e
n
able
B
ackg
roun
d
B
oo
lea
n tru
e
否
HB
u
ilde
r
X
3.5.1+
版
本
新
增
是
否
开
启
⼩
程
序
后台
运
⾏
的
能
⼒
默
认
开
启
如
果
设
置
为
false
退
出
⼩
程
序
后
⼩
程
序
⽴
即
会
被
释
放
，下
次
打
开
后
会
重
新
加
载
callback
回
调
参
数
说
明
JSON O
bjec
t
类
型
属
性
类
型
说
明
typ
e
S
tr
i
n
g
"
su
cce
ss
"
表
示
成
功
，
"
fail
"
表
示
失
败
c
o
de
N
um
be
r
成
功
返
回
0,
失
败
返
回
相
应
c
o
de
码
m
e
ss
age
S
tr
i
n
g
失
败
描
述
cl
os
e
U
n
i
MP
(
a
pp
id
,
callback
)
HB
u
ilde
r
X
3.4.3+
版
本
新
增
⽀
持
关
闭
已
经
运
⾏
的
uni
⼩
程
序
，
示
例
如
下：
mp.closeUniMP('uni
⼩
程
序
的
appid', (ret)=>{
console.log('closeUniMP: '+JSON.stringify(ret));