@hyext/types-ext-sdk-hy 3.16.1-beta.2 → 3.16.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +196 -731
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -474,7 +474,7 @@ type DestroyAdReq = {
|
|
|
474
474
|
|
|
475
475
|
/**
|
|
476
476
|
* 关闭信息
|
|
477
|
-
* @property isEnded -
|
|
477
|
+
* @property isEnded - 是否看完, 1-看完, 0-未看完
|
|
478
478
|
*/
|
|
479
479
|
type CloseInfo = {
|
|
480
480
|
isEnded: boolean;
|
|
@@ -1724,6 +1724,129 @@ function onAppear(callback: LifeCallback): void;
|
|
|
1724
1724
|
*/
|
|
1725
1725
|
function onDisappear(callback: LifeCallback): void;
|
|
1726
1726
|
|
|
1727
|
+
/**
|
|
1728
|
+
* audio模块
|
|
1729
|
+
*/
|
|
1730
|
+
namespace audio {
|
|
1731
|
+
/**
|
|
1732
|
+
* 创建音频播放器
|
|
1733
|
+
* @param params - 传入参数
|
|
1734
|
+
* @returns 调用结果
|
|
1735
|
+
*/
|
|
1736
|
+
function createAudio(params: CreateAudioReq): Promise<CreateAudioRsp>;
|
|
1737
|
+
/**
|
|
1738
|
+
* 监听音频播放器事件
|
|
1739
|
+
* @param params - 传入参数
|
|
1740
|
+
* @returns 调用结果
|
|
1741
|
+
*/
|
|
1742
|
+
function onAudioNotices(params: OnAudioNoticesReq): Promise<void>;
|
|
1743
|
+
/**
|
|
1744
|
+
* 取消监听音频播放器事件
|
|
1745
|
+
* @param [params] - 传入参数
|
|
1746
|
+
* @returns 调用结果
|
|
1747
|
+
*/
|
|
1748
|
+
function offAudioNotices(params?: OffAudioNoticesReq): Promise<void>;
|
|
1749
|
+
/**
|
|
1750
|
+
* 播放音频
|
|
1751
|
+
* @param params - 传入参数
|
|
1752
|
+
* @returns 调用结果
|
|
1753
|
+
*/
|
|
1754
|
+
function playAudio(params: PlayAudioReq): Promise<void>;
|
|
1755
|
+
/**
|
|
1756
|
+
* 停止音频播放
|
|
1757
|
+
* @param params - 传入参数
|
|
1758
|
+
* @returns 调用结果
|
|
1759
|
+
*/
|
|
1760
|
+
function stopAudio(params: StopAudioReq): Promise<void>;
|
|
1761
|
+
/**
|
|
1762
|
+
* 音频是否在播放中
|
|
1763
|
+
* @param params - 传入参数
|
|
1764
|
+
* @returns 调用结果
|
|
1765
|
+
*/
|
|
1766
|
+
function isAudioPlaying(params: IsAudioPlayingReq): Promise<IsAudioPlayingRsp>;
|
|
1767
|
+
}
|
|
1768
|
+
|
|
1769
|
+
/**
|
|
1770
|
+
* 创建音频播放器参数
|
|
1771
|
+
* @property url - 音频地址
|
|
1772
|
+
*/
|
|
1773
|
+
type CreateAudioReq = {
|
|
1774
|
+
url: string;
|
|
1775
|
+
};
|
|
1776
|
+
|
|
1777
|
+
/**
|
|
1778
|
+
* 创建音频播放器结果
|
|
1779
|
+
* @property audioId - 播放器实例播放器ID
|
|
1780
|
+
*/
|
|
1781
|
+
type CreateAudioRsp = {
|
|
1782
|
+
audioId: string;
|
|
1783
|
+
};
|
|
1784
|
+
|
|
1785
|
+
/**
|
|
1786
|
+
* 音频播放器事件回调信息
|
|
1787
|
+
* @property audioId - 播放器实例ID
|
|
1788
|
+
* @property eventName - 事件名, ended-播放完毕, error-播放出错
|
|
1789
|
+
* @property data - 回调信息
|
|
1790
|
+
*/
|
|
1791
|
+
type AudioEventInfo = {
|
|
1792
|
+
audioId: string;
|
|
1793
|
+
eventName: string;
|
|
1794
|
+
data: any;
|
|
1795
|
+
};
|
|
1796
|
+
|
|
1797
|
+
/**
|
|
1798
|
+
* @param info - 回调信息
|
|
1799
|
+
*/
|
|
1800
|
+
type AudioEventCallback = (info: AudioEventInfo) => void;
|
|
1801
|
+
|
|
1802
|
+
/**
|
|
1803
|
+
* 监听音频播放器事件参数
|
|
1804
|
+
* @property callback - 音频播放器事件回调
|
|
1805
|
+
*/
|
|
1806
|
+
type OnAudioNoticesReq = {
|
|
1807
|
+
callback: AudioEventCallback;
|
|
1808
|
+
};
|
|
1809
|
+
|
|
1810
|
+
/**
|
|
1811
|
+
* 取消监听音频播放器事件参数
|
|
1812
|
+
* @property [callback] - 音频播放器事件回调
|
|
1813
|
+
*/
|
|
1814
|
+
type OffAudioNoticesReq = {
|
|
1815
|
+
callback?: AudioEventCallback;
|
|
1816
|
+
};
|
|
1817
|
+
|
|
1818
|
+
/**
|
|
1819
|
+
* 播放音频参数
|
|
1820
|
+
* @property audioId - 播放器实例ID
|
|
1821
|
+
*/
|
|
1822
|
+
type PlayAudioReq = {
|
|
1823
|
+
audioId: string;
|
|
1824
|
+
};
|
|
1825
|
+
|
|
1826
|
+
/**
|
|
1827
|
+
* 停止播放参数
|
|
1828
|
+
* @property audioId - 播放器实例ID
|
|
1829
|
+
*/
|
|
1830
|
+
type StopAudioReq = {
|
|
1831
|
+
audioId: string;
|
|
1832
|
+
};
|
|
1833
|
+
|
|
1834
|
+
/**
|
|
1835
|
+
* 音频是否在播放中参数
|
|
1836
|
+
* @property audioId - 播放器实例ID
|
|
1837
|
+
*/
|
|
1838
|
+
type IsAudioPlayingReq = {
|
|
1839
|
+
audioId: string;
|
|
1840
|
+
};
|
|
1841
|
+
|
|
1842
|
+
/**
|
|
1843
|
+
* 音频是否在播放中结果
|
|
1844
|
+
* @property isPlaying - 是否在播放中
|
|
1845
|
+
*/
|
|
1846
|
+
type IsAudioPlayingRsp = {
|
|
1847
|
+
isPlaying: boolean;
|
|
1848
|
+
};
|
|
1849
|
+
|
|
1727
1850
|
/**
|
|
1728
1851
|
* auth模块
|
|
1729
1852
|
*/
|
|
@@ -2240,12 +2363,6 @@ namespace context {
|
|
|
2240
2363
|
* @returns 调起成功
|
|
2241
2364
|
*/
|
|
2242
2365
|
function checkSession(): Promise<void>;
|
|
2243
|
-
/**
|
|
2244
|
-
* 发起支付
|
|
2245
|
-
* @param params - 请求参数
|
|
2246
|
-
* @returns 调起成功
|
|
2247
|
-
*/
|
|
2248
|
-
function requestPayment(params: RequestPaymentReq): Promise<void>;
|
|
2249
2366
|
}
|
|
2250
2367
|
|
|
2251
2368
|
/**
|
|
@@ -2608,6 +2725,7 @@ type ContextInfo = {
|
|
|
2608
2725
|
* @property liveCompany - 交友陪玩直播间, 1-为交友陪玩直播间, 0-为非交友陪玩直播间
|
|
2609
2726
|
* @property liveMode - 开播模式, kGame-【PC主播端】端游直播, kEntertainment-【PC主播端】娱乐直播, kMobile-【PC主播端】手游直播, kMakeFriends-【PC主播端】交友直播, kThirdParty-【PC主播端】第三方推流, kScreenCAP-【助手APP】录屏直播, kCamera-【助手APP】摄像头直播, kVoice-【助手APP】语音直播,
|
|
2610
2727
|
* @property liveSubMode - 开播子模式, process-【PC主播端】端游直播-捕捉游戏画面, desktop-【PC主播端】端游直播-全屏捕捉, area-【PC主播端】端游直播-截取屏幕, window-【PC主播端】端游直播-窗口捕捉, adr-【PC主播端】手游直播-安卓手机, ios-【PC主播端】手游直播-苹果手机, audio-【PC主播端】交友直播-语音开播, video-【PC主播端】交友直播-视频开播, multiPlayersVideo-【PC主播端】派对模式,
|
|
2728
|
+
* @property liveId - 直播ID
|
|
2611
2729
|
*/
|
|
2612
2730
|
type RespLiveInfo = {
|
|
2613
2731
|
gameName: string;
|
|
@@ -2623,6 +2741,7 @@ type RespLiveInfo = {
|
|
|
2623
2741
|
liveCompany: number;
|
|
2624
2742
|
liveMode: string;
|
|
2625
2743
|
liveSubMode: string;
|
|
2744
|
+
liveId: string;
|
|
2626
2745
|
};
|
|
2627
2746
|
|
|
2628
2747
|
/**
|
|
@@ -2883,21 +3002,6 @@ type LoginReq = {
|
|
|
2883
3002
|
timeout?: number;
|
|
2884
3003
|
};
|
|
2885
3004
|
|
|
2886
|
-
/**
|
|
2887
|
-
* @property timeStamp - 时间戳
|
|
2888
|
-
* @property nonceStr - 随机字符串,长度为32个字符以下
|
|
2889
|
-
* @property package - 下单接口返回
|
|
2890
|
-
* @property signType - 签名算法
|
|
2891
|
-
* @property paySign - 签名
|
|
2892
|
-
*/
|
|
2893
|
-
type RequestPaymentReq = {
|
|
2894
|
-
timeStamp: number;
|
|
2895
|
-
nonceStr: string;
|
|
2896
|
-
package: string;
|
|
2897
|
-
signType: string;
|
|
2898
|
-
paySign: string;
|
|
2899
|
-
};
|
|
2900
|
-
|
|
2901
3005
|
/**
|
|
2902
3006
|
* 下载中心
|
|
2903
3007
|
*/
|
|
@@ -3326,10 +3430,6 @@ namespace device {
|
|
|
3326
3430
|
* @param [params] - 输入参数
|
|
3327
3431
|
*/
|
|
3328
3432
|
function offOrientationChange(params?: OffOrientationChangeReq): Promise<void>;
|
|
3329
|
-
/**
|
|
3330
|
-
* 获取窗口信息
|
|
3331
|
-
*/
|
|
3332
|
-
function getWindowInfo(): Promise<WindowInfo>;
|
|
3333
3433
|
}
|
|
3334
3434
|
|
|
3335
3435
|
/**
|
|
@@ -3621,48 +3721,6 @@ type OffOrientationChangeReq = {
|
|
|
3621
3721
|
callback?: OrientationChange;
|
|
3622
3722
|
};
|
|
3623
3723
|
|
|
3624
|
-
/**
|
|
3625
|
-
* 安全区域
|
|
3626
|
-
* @property left - 安全区域左上角横坐标
|
|
3627
|
-
* @property right - 安全区域右下角横坐标
|
|
3628
|
-
* @property top - 安全区域左上角纵坐标
|
|
3629
|
-
* @property bottom - 安全区域右下角纵坐标
|
|
3630
|
-
* @property width - 安全区域的宽度,单位逻辑像素
|
|
3631
|
-
* @property height - 安全区域的高度,单位逻辑像素
|
|
3632
|
-
*/
|
|
3633
|
-
type SafeArea = {
|
|
3634
|
-
left: number;
|
|
3635
|
-
right: number;
|
|
3636
|
-
top: number;
|
|
3637
|
-
bottom: number;
|
|
3638
|
-
width: number;
|
|
3639
|
-
height: number;
|
|
3640
|
-
};
|
|
3641
|
-
|
|
3642
|
-
/**
|
|
3643
|
-
* 窗口信息
|
|
3644
|
-
* @property screenWidth - 屏幕宽度
|
|
3645
|
-
* @property screenHeight - 屏幕高度
|
|
3646
|
-
* @property isLandscape - 屏幕是否是横屏高度
|
|
3647
|
-
* @property pixelRatio - 设备像素比
|
|
3648
|
-
* @property windowWidth - 可使用窗口宽度,单位 px
|
|
3649
|
-
* @property windowHeight - 可使用窗口高度,单位 px
|
|
3650
|
-
* @property statusBarHeight - 状态栏的高度,单位 px
|
|
3651
|
-
* @property screenTop - 窗口上边缘的 y 值
|
|
3652
|
-
* @property [safeArea] - 在竖屏正方向下的安全区域。部分机型没有安全区域概念,则不返回 safeArea 字段
|
|
3653
|
-
*/
|
|
3654
|
-
type WindowInfo = {
|
|
3655
|
-
screenWidth: number;
|
|
3656
|
-
screenHeight: number;
|
|
3657
|
-
isLandscape: boolean;
|
|
3658
|
-
pixelRatio: number;
|
|
3659
|
-
windowWidth: number;
|
|
3660
|
-
windowHeight: number;
|
|
3661
|
-
statusBarHeight: number;
|
|
3662
|
-
screenTop: number;
|
|
3663
|
-
safeArea?: SafeArea;
|
|
3664
|
-
};
|
|
3665
|
-
|
|
3666
3724
|
/**
|
|
3667
3725
|
* 逐步废弃
|
|
3668
3726
|
*/
|
|
@@ -4005,6 +4063,12 @@ namespace feedback {
|
|
|
4005
4063
|
* @returns 返回结果
|
|
4006
4064
|
*/
|
|
4007
4065
|
function openFeedbackForm(params: FeedbackParams): Promise<void>;
|
|
4066
|
+
/**
|
|
4067
|
+
* 反馈
|
|
4068
|
+
* @param params - 请求参数
|
|
4069
|
+
* @returns 返回结果
|
|
4070
|
+
*/
|
|
4071
|
+
function sendFeedback(params: SendFeedbackReq): Promise<SendFeedbackRsp>;
|
|
4008
4072
|
}
|
|
4009
4073
|
|
|
4010
4074
|
/**
|
|
@@ -4032,6 +4096,24 @@ type FeedbackParams = {
|
|
|
4032
4096
|
param: string;
|
|
4033
4097
|
};
|
|
4034
4098
|
|
|
4099
|
+
/**
|
|
4100
|
+
* 反馈请求参数
|
|
4101
|
+
* @property fbType - 反馈类型
|
|
4102
|
+
* @property fbContent - 反馈详情
|
|
4103
|
+
*/
|
|
4104
|
+
type SendFeedbackReq = {
|
|
4105
|
+
fbType: string;
|
|
4106
|
+
fbContent: string;
|
|
4107
|
+
};
|
|
4108
|
+
|
|
4109
|
+
/**
|
|
4110
|
+
* 反馈结果
|
|
4111
|
+
* @property feedbackId - 反馈日志id
|
|
4112
|
+
*/
|
|
4113
|
+
type SendFeedbackRsp = {
|
|
4114
|
+
feedbackId: string;
|
|
4115
|
+
};
|
|
4116
|
+
|
|
4035
4117
|
/**
|
|
4036
4118
|
* 文件系统
|
|
4037
4119
|
*/
|
|
@@ -4118,281 +4200,6 @@ namespace fs {
|
|
|
4118
4200
|
* @returns 调用结果
|
|
4119
4201
|
*/
|
|
4120
4202
|
function chooseMedia(params: ChooseMediaReq): Promise<void>;
|
|
4121
|
-
/**
|
|
4122
|
-
* 下载文件
|
|
4123
|
-
* @param params - 传入参数
|
|
4124
|
-
* @returns 调用结果
|
|
4125
|
-
*/
|
|
4126
|
-
function downloadFile(params: DownloadFileReq): Promise<void>;
|
|
4127
|
-
/**
|
|
4128
|
-
* 判断文件/目录是否存在
|
|
4129
|
-
* @param params - 传入参数
|
|
4130
|
-
* @returns 调用结果
|
|
4131
|
-
*/
|
|
4132
|
-
function access(params: AccessReq): Promise<void>;
|
|
4133
|
-
/**
|
|
4134
|
-
* 同步判断文件/目录是否存在
|
|
4135
|
-
* @param params - 传入参数
|
|
4136
|
-
* @returns 调用结果
|
|
4137
|
-
*/
|
|
4138
|
-
function accessSync(params: AccessReq): void;
|
|
4139
|
-
/**
|
|
4140
|
-
* 在文件结尾追加内容
|
|
4141
|
-
* @param params - 传入参数
|
|
4142
|
-
* @returns 调用结果
|
|
4143
|
-
*/
|
|
4144
|
-
function appendFile(params: AppendFileReq): Promise<void>;
|
|
4145
|
-
/**
|
|
4146
|
-
* 同步在文件结尾追加内容
|
|
4147
|
-
* @param params - 传入参数
|
|
4148
|
-
* @returns 调用结果
|
|
4149
|
-
*/
|
|
4150
|
-
function appendFileSync(params: AppendFileReq): void;
|
|
4151
|
-
/**
|
|
4152
|
-
* 关闭文件
|
|
4153
|
-
* @param params - 传入参数
|
|
4154
|
-
* @returns 调用结果
|
|
4155
|
-
*/
|
|
4156
|
-
function close(params: CloseReq): Promise<void>;
|
|
4157
|
-
/**
|
|
4158
|
-
* 同步关闭文件
|
|
4159
|
-
* @param params - 传入参数
|
|
4160
|
-
* @returns 调用结果
|
|
4161
|
-
*/
|
|
4162
|
-
function closeSync(params: CloseReq): void;
|
|
4163
|
-
/**
|
|
4164
|
-
* 复制文件
|
|
4165
|
-
* @param params - 传入参数
|
|
4166
|
-
* @returns 调用结果
|
|
4167
|
-
*/
|
|
4168
|
-
function copyFile(params: CopyFileReq): Promise<void>;
|
|
4169
|
-
/**
|
|
4170
|
-
* 同步复制文件
|
|
4171
|
-
* @param params - 传入参数
|
|
4172
|
-
* @returns 调用结果
|
|
4173
|
-
*/
|
|
4174
|
-
function copyFileSync(params: CopyFileReq): void;
|
|
4175
|
-
/**
|
|
4176
|
-
* 获取文件信息
|
|
4177
|
-
* @param params - 传入参数
|
|
4178
|
-
* @returns 调用结果
|
|
4179
|
-
*/
|
|
4180
|
-
function getFileInfo(params: GetFileInfoReq): Promise<GetFileInfoRsp>;
|
|
4181
|
-
/**
|
|
4182
|
-
* 获取该小程序下已保存的本地缓存文件列表
|
|
4183
|
-
* @returns 调用结果
|
|
4184
|
-
*/
|
|
4185
|
-
function getSavedFileList(): Promise<GetSavedFileListRsp>;
|
|
4186
|
-
/**
|
|
4187
|
-
* 创建文件夹
|
|
4188
|
-
* @param params - 传入参数
|
|
4189
|
-
* @returns 调用结果
|
|
4190
|
-
*/
|
|
4191
|
-
function mkdir(params: MkdirReq): Promise<void>;
|
|
4192
|
-
/**
|
|
4193
|
-
* 创建文件夹
|
|
4194
|
-
* @param params - 传入参数
|
|
4195
|
-
* @returns 调用结果
|
|
4196
|
-
*/
|
|
4197
|
-
function mkdirSync(params: MkdirReq): void;
|
|
4198
|
-
/**
|
|
4199
|
-
* 打开文件,返回文件描述符
|
|
4200
|
-
* @param params - 传入参数
|
|
4201
|
-
* @returns 调用结果
|
|
4202
|
-
*/
|
|
4203
|
-
function open(params: OpenReq): Promise<OpenRsp>;
|
|
4204
|
-
/**
|
|
4205
|
-
* 打开文件,返回文件描述符
|
|
4206
|
-
* @param params - 传入参数
|
|
4207
|
-
* @returns 调用结果
|
|
4208
|
-
*/
|
|
4209
|
-
function openSync(params: OpenReq): OpenRsp;
|
|
4210
|
-
/**
|
|
4211
|
-
* 读文件
|
|
4212
|
-
* @param params - 传入参数
|
|
4213
|
-
* @returns 调用结果
|
|
4214
|
-
*/
|
|
4215
|
-
function read(params: ReadReq): Promise<ReadRsp>;
|
|
4216
|
-
/**
|
|
4217
|
-
* 同步读文件
|
|
4218
|
-
* @param params - 传入参数
|
|
4219
|
-
* @returns 调用结果
|
|
4220
|
-
*/
|
|
4221
|
-
function readSync(params: ReadReq): ReadRsp;
|
|
4222
|
-
/**
|
|
4223
|
-
* 读取指定压缩类型的本地文件内容
|
|
4224
|
-
* @param params - 传入参数
|
|
4225
|
-
* @returns 调用结果
|
|
4226
|
-
*/
|
|
4227
|
-
function readCompressedFile(params: ReadCompressedFileReq): Promise<ReadCompressedFileRsp>;
|
|
4228
|
-
/**
|
|
4229
|
-
* 同步读取指定压缩类型的本地文件内容
|
|
4230
|
-
* @param params - 传入参数
|
|
4231
|
-
* @returns 调用结果
|
|
4232
|
-
*/
|
|
4233
|
-
function readCompressedFileSync(params: ReadCompressedFileReq): ReadCompressedFileRsp;
|
|
4234
|
-
/**
|
|
4235
|
-
* 读取目录内文件列表
|
|
4236
|
-
* @param params - 传入参数
|
|
4237
|
-
* @returns 调用结果
|
|
4238
|
-
*/
|
|
4239
|
-
function readdir(params: ReaddirReq): Promise<ReaddirRsp>;
|
|
4240
|
-
/**
|
|
4241
|
-
* 同步读取目录内文件列表
|
|
4242
|
-
* @param params - 传入参数
|
|
4243
|
-
* @returns 调用结果
|
|
4244
|
-
*/
|
|
4245
|
-
function readdirSync(params: ReaddirReq): ReaddirRsp;
|
|
4246
|
-
/**
|
|
4247
|
-
* 读取文件
|
|
4248
|
-
* @param params - 传入参数
|
|
4249
|
-
* @returns 调用结果
|
|
4250
|
-
*/
|
|
4251
|
-
function readFile(params: ReadFileReq): Promise<ReadFileRsp>;
|
|
4252
|
-
/**
|
|
4253
|
-
* 同步读取文件
|
|
4254
|
-
* @param params - 传入参数
|
|
4255
|
-
* @returns 调用结果
|
|
4256
|
-
*/
|
|
4257
|
-
function readFileSync(params: ReadFileReq): ReadFileRsp;
|
|
4258
|
-
/**
|
|
4259
|
-
* 读取压缩包内的文件
|
|
4260
|
-
* @param params - 传入参数
|
|
4261
|
-
* @returns 调用结果
|
|
4262
|
-
*/
|
|
4263
|
-
function readZipEntry(params: ReadZipEntryReq): Promise<ReadZipEntryRsp>;
|
|
4264
|
-
/**
|
|
4265
|
-
* 解压文件
|
|
4266
|
-
* @param params - 传入参数
|
|
4267
|
-
* @returns 调用结果
|
|
4268
|
-
*/
|
|
4269
|
-
function unzip(params: UnzipReq): Promise<void>;
|
|
4270
|
-
/**
|
|
4271
|
-
* 删除该小程序下已保存的本地缓存文件
|
|
4272
|
-
* @param params - 传入参数
|
|
4273
|
-
* @returns 调用结果
|
|
4274
|
-
*/
|
|
4275
|
-
function removeSavedFile(params: RemoveSavedFileReq): Promise<void>;
|
|
4276
|
-
/**
|
|
4277
|
-
* 重命名文件
|
|
4278
|
-
* @param params - 传入参数
|
|
4279
|
-
* @returns 调用结果
|
|
4280
|
-
*/
|
|
4281
|
-
function rename(params: RenameReq): Promise<void>;
|
|
4282
|
-
/**
|
|
4283
|
-
* 同步重命名文件
|
|
4284
|
-
* @param params - 传入参数
|
|
4285
|
-
* @returns 调用结果
|
|
4286
|
-
*/
|
|
4287
|
-
function renameSync(params: RenameReq): void;
|
|
4288
|
-
/**
|
|
4289
|
-
* 删除目录
|
|
4290
|
-
* @param params - 传入参数
|
|
4291
|
-
* @returns 调用结果
|
|
4292
|
-
*/
|
|
4293
|
-
function rmdir(params: RmdirReq): Promise<void>;
|
|
4294
|
-
/**
|
|
4295
|
-
* 同步删除目录
|
|
4296
|
-
* @param params - 传入参数
|
|
4297
|
-
* @returns 调用结果
|
|
4298
|
-
*/
|
|
4299
|
-
function rmdirSync(params: RmdirReq): void;
|
|
4300
|
-
/**
|
|
4301
|
-
* 保存临时文件到本地
|
|
4302
|
-
* @param params - 传入参数
|
|
4303
|
-
* @returns 调用结果
|
|
4304
|
-
*/
|
|
4305
|
-
function saveFile(params: SaveFileReq): Promise<SaveFileRsp>;
|
|
4306
|
-
/**
|
|
4307
|
-
* 同步保存临时文件到本地
|
|
4308
|
-
* @param params - 传入参数
|
|
4309
|
-
* @returns 调用结果
|
|
4310
|
-
*/
|
|
4311
|
-
function saveFileSync(params: SaveFileReq): SaveFileRsp;
|
|
4312
|
-
/**
|
|
4313
|
-
* 获取文件Stats对象
|
|
4314
|
-
* @param params - 传入参数
|
|
4315
|
-
* @returns 调用结果
|
|
4316
|
-
*/
|
|
4317
|
-
function stat(params: StatReq): Promise<StatRsp>;
|
|
4318
|
-
/**
|
|
4319
|
-
* 同步获取文件Stats对象
|
|
4320
|
-
* @param params - 传入参数
|
|
4321
|
-
* @returns 调用结果
|
|
4322
|
-
*/
|
|
4323
|
-
function statSync(params: StatReq): StatRsp;
|
|
4324
|
-
/**
|
|
4325
|
-
* 对文件内容进行截断操作
|
|
4326
|
-
* @param params - 传入参数
|
|
4327
|
-
* @returns 调用结果
|
|
4328
|
-
*/
|
|
4329
|
-
function truncate(params: TruncateReq): Promise<void>;
|
|
4330
|
-
/**
|
|
4331
|
-
* 同步对文件内容进行截断操作
|
|
4332
|
-
* @param params - 传入参数
|
|
4333
|
-
* @returns 调用结果
|
|
4334
|
-
*/
|
|
4335
|
-
function truncateSync(params: TruncateReq): void;
|
|
4336
|
-
/**
|
|
4337
|
-
* 删除文件
|
|
4338
|
-
* @param params - 传入参数
|
|
4339
|
-
* @returns 调用结果
|
|
4340
|
-
*/
|
|
4341
|
-
function unlink(params: UnlinkReq): Promise<void>;
|
|
4342
|
-
/**
|
|
4343
|
-
* 同步删除文件
|
|
4344
|
-
* @param params - 传入参数
|
|
4345
|
-
* @returns 调用结果
|
|
4346
|
-
*/
|
|
4347
|
-
function unlinkSync(params: UnlinkReq): void;
|
|
4348
|
-
/**
|
|
4349
|
-
* 写入文件
|
|
4350
|
-
* @param params - 传入参数
|
|
4351
|
-
* @returns 调用结果
|
|
4352
|
-
*/
|
|
4353
|
-
function write(params: WriteReq): Promise<void>;
|
|
4354
|
-
/**
|
|
4355
|
-
* 同步写入文件
|
|
4356
|
-
* @param params - 传入参数
|
|
4357
|
-
* @returns 调用结果
|
|
4358
|
-
*/
|
|
4359
|
-
function writeSync(params: WriteReq): void;
|
|
4360
|
-
/**
|
|
4361
|
-
* 写文件
|
|
4362
|
-
* @param params - 传入参数
|
|
4363
|
-
* @returns 调用结果
|
|
4364
|
-
*/
|
|
4365
|
-
function writeFile(params: WriteFileReq): Promise<void>;
|
|
4366
|
-
/**
|
|
4367
|
-
* 同步写文件
|
|
4368
|
-
* @param params - 传入参数
|
|
4369
|
-
* @returns 调用结果
|
|
4370
|
-
*/
|
|
4371
|
-
function writeFileSync(params: WriteFileReq): void;
|
|
4372
|
-
/**
|
|
4373
|
-
* 获取文件的状态信息
|
|
4374
|
-
* @param params - 传入参数
|
|
4375
|
-
* @returns 调用结果
|
|
4376
|
-
*/
|
|
4377
|
-
function fstat(params: FstatReq): Promise<FstatRsp>;
|
|
4378
|
-
/**
|
|
4379
|
-
* 同步获取文件的状态信息
|
|
4380
|
-
* @param params - 传入参数
|
|
4381
|
-
* @returns 调用结果
|
|
4382
|
-
*/
|
|
4383
|
-
function fstatSync(params: FstatReq): FstatRsp;
|
|
4384
|
-
/**
|
|
4385
|
-
* 对文件内容进行截断操作
|
|
4386
|
-
* @param params - 传入参数
|
|
4387
|
-
* @returns 调用结果
|
|
4388
|
-
*/
|
|
4389
|
-
function ftruncate(params: FtruncateReq): Promise<void>;
|
|
4390
|
-
/**
|
|
4391
|
-
* 同步对文件内容进行截断操作
|
|
4392
|
-
* @param params - 传入参数
|
|
4393
|
-
* @returns 调用结果
|
|
4394
|
-
*/
|
|
4395
|
-
function ftruncateSync(params: FtruncateReq): void;
|
|
4396
4203
|
}
|
|
4397
4204
|
|
|
4398
4205
|
/**
|
|
@@ -4521,6 +4328,23 @@ type CleanResParams = {
|
|
|
4521
4328
|
reserveMD5List: string[];
|
|
4522
4329
|
};
|
|
4523
4330
|
|
|
4331
|
+
/**
|
|
4332
|
+
* 保存进度信息
|
|
4333
|
+
* @property url - 文件url
|
|
4334
|
+
* @property bytesTotal - 文件总大小,单位是字
|
|
4335
|
+
* @property bytesLoaded - 已加载的大小,单位是字节
|
|
4336
|
+
*/
|
|
4337
|
+
type FileProgressInfo = {
|
|
4338
|
+
url: string;
|
|
4339
|
+
bytesTotal: number;
|
|
4340
|
+
bytesLoaded: number;
|
|
4341
|
+
};
|
|
4342
|
+
|
|
4343
|
+
/**
|
|
4344
|
+
* @param info - 保存进度信息
|
|
4345
|
+
*/
|
|
4346
|
+
type SaveFileProgressCallback = (info: FileProgressInfo) => void;
|
|
4347
|
+
|
|
4524
4348
|
/**
|
|
4525
4349
|
* 本地文件信息
|
|
4526
4350
|
* @property status - 状态码,0是成功,非0失败
|
|
@@ -4562,12 +4386,14 @@ type SaveFileInfo = {
|
|
|
4562
4386
|
* @property fileList - 要保留的资源md5列表,至少传入一个
|
|
4563
4387
|
* @property [authKeys] - 需要授权的场景值
|
|
4564
4388
|
* @property callback - 单个文件保存结果回调
|
|
4389
|
+
* @property [progressCallback] - 单个文件保存进度回调
|
|
4565
4390
|
*/
|
|
4566
4391
|
type SaveFilesReq = {
|
|
4567
4392
|
type: string;
|
|
4568
4393
|
fileList: SaveFileInfo[];
|
|
4569
4394
|
authKeys?: string[];
|
|
4570
4395
|
callback: SaveFileCallback;
|
|
4396
|
+
progressCallback?: SaveFileProgressCallback;
|
|
4571
4397
|
};
|
|
4572
4398
|
|
|
4573
4399
|
/**
|
|
@@ -4686,392 +4512,6 @@ type ChooseMediaReq = {
|
|
|
4686
4512
|
callback: ChooseCallback;
|
|
4687
4513
|
};
|
|
4688
4514
|
|
|
4689
|
-
/**
|
|
4690
|
-
* 下载文件参数
|
|
4691
|
-
* @property url - 下载资源的 url
|
|
4692
|
-
* @property [header] - HTTP 请求的 Header
|
|
4693
|
-
* @property [timeout] - 超时时间,单位为毫秒,默认值为 60000 即一分钟
|
|
4694
|
-
* @property [filePath] - 指定文件下载后存储的路径 (本地路径)
|
|
4695
|
-
*/
|
|
4696
|
-
type DownloadFileReq = {
|
|
4697
|
-
url: string;
|
|
4698
|
-
header?: any;
|
|
4699
|
-
timeout?: number;
|
|
4700
|
-
filePath?: string;
|
|
4701
|
-
};
|
|
4702
|
-
|
|
4703
|
-
/**
|
|
4704
|
-
* 判断文件/目录是否存在参数
|
|
4705
|
-
* @property path - 要判断是否存在的文件/目录路径 (本地路径)
|
|
4706
|
-
*/
|
|
4707
|
-
type AccessReq = {
|
|
4708
|
-
path: string;
|
|
4709
|
-
};
|
|
4710
|
-
|
|
4711
|
-
/**
|
|
4712
|
-
* 在文件结尾追加内容参数
|
|
4713
|
-
* @property filePath - 要追加内容的文件路径 (本地路径)
|
|
4714
|
-
* @property data - 要追加的文本或二进制数据
|
|
4715
|
-
* @property [encoding] - 指定读取文件的字符编码, base64-base64, utf8-utf8
|
|
4716
|
-
*/
|
|
4717
|
-
type AppendFileReq = {
|
|
4718
|
-
filePath: string;
|
|
4719
|
-
data: string;
|
|
4720
|
-
encoding?: string;
|
|
4721
|
-
};
|
|
4722
|
-
|
|
4723
|
-
/**
|
|
4724
|
-
* 关闭文件参数
|
|
4725
|
-
* @property fd - 需要被关闭的文件描述符
|
|
4726
|
-
*/
|
|
4727
|
-
type CloseReq = {
|
|
4728
|
-
fd: string;
|
|
4729
|
-
};
|
|
4730
|
-
|
|
4731
|
-
/**
|
|
4732
|
-
* 复制文件参数
|
|
4733
|
-
* @property srcPath - 源文件路径,支持本地路径
|
|
4734
|
-
* @property destPath - 目标文件路径,支持本地路径
|
|
4735
|
-
*/
|
|
4736
|
-
type CopyFileReq = {
|
|
4737
|
-
srcPath: string;
|
|
4738
|
-
destPath: string;
|
|
4739
|
-
};
|
|
4740
|
-
|
|
4741
|
-
/**
|
|
4742
|
-
* 文件信息
|
|
4743
|
-
* @property size - 文件大小,以字节为单位
|
|
4744
|
-
* @property digest - 按照传入的 digestAlgorithm 计算得出的的文件摘要
|
|
4745
|
-
*/
|
|
4746
|
-
type GetFileInfoRsp = {
|
|
4747
|
-
size: number;
|
|
4748
|
-
digest: string;
|
|
4749
|
-
};
|
|
4750
|
-
|
|
4751
|
-
/**
|
|
4752
|
-
* 获取文件信息参数
|
|
4753
|
-
* @property filePath - 要读取的文件路径 (本地路径)
|
|
4754
|
-
* @property [digestAlgorithm] - 计算文件摘要的算法, md5-md5算法, sha1-sha1算法
|
|
4755
|
-
*/
|
|
4756
|
-
type GetFileInfoReq = {
|
|
4757
|
-
filePath: string;
|
|
4758
|
-
digestAlgorithm?: string;
|
|
4759
|
-
};
|
|
4760
|
-
|
|
4761
|
-
/**
|
|
4762
|
-
* 文件信息
|
|
4763
|
-
* @property filePath - 文件路径 (本地路径)
|
|
4764
|
-
* @property size - 本地文件大小,以字节为单位
|
|
4765
|
-
* @property createTime - 文件保存时的时间戳
|
|
4766
|
-
*/
|
|
4767
|
-
type SavedFileInfo = {
|
|
4768
|
-
filePath: string;
|
|
4769
|
-
size: number;
|
|
4770
|
-
createTime: number;
|
|
4771
|
-
};
|
|
4772
|
-
|
|
4773
|
-
/**
|
|
4774
|
-
* 获取该小程序下已保存的本地缓存文件列表
|
|
4775
|
-
* @property fileList - 文件列表
|
|
4776
|
-
*/
|
|
4777
|
-
type GetSavedFileListRsp = {
|
|
4778
|
-
fileList: SavedFileInfo[];
|
|
4779
|
-
};
|
|
4780
|
-
|
|
4781
|
-
/**
|
|
4782
|
-
* 创建文件夹参数
|
|
4783
|
-
* @property dirPath - 创建的目录路径 (本地路径)
|
|
4784
|
-
* @property [recursive] - 是否在递归创建该目录的上级目录后再创建该目录
|
|
4785
|
-
*/
|
|
4786
|
-
type MkdirReq = {
|
|
4787
|
-
dirPath: string;
|
|
4788
|
-
recursive?: boolean;
|
|
4789
|
-
};
|
|
4790
|
-
|
|
4791
|
-
/**
|
|
4792
|
-
* 文件信息
|
|
4793
|
-
* @property fd - 文件描述符
|
|
4794
|
-
*/
|
|
4795
|
-
type OpenRsp = {
|
|
4796
|
-
fd: string;
|
|
4797
|
-
};
|
|
4798
|
-
|
|
4799
|
-
/**
|
|
4800
|
-
* 打开文件参数
|
|
4801
|
-
* @property filePath - 文件路径 (本地路径)
|
|
4802
|
-
* @property [flag] - 文件系统标志,默认值: 'r'
|
|
4803
|
-
*/
|
|
4804
|
-
type OpenReq = {
|
|
4805
|
-
filePath: string;
|
|
4806
|
-
flag?: string;
|
|
4807
|
-
};
|
|
4808
|
-
|
|
4809
|
-
/**
|
|
4810
|
-
* 文件信息
|
|
4811
|
-
* @property bytesRead - 实际读取的字节数
|
|
4812
|
-
* @property ArrayBuffer - 被写入的缓存区的对象
|
|
4813
|
-
*/
|
|
4814
|
-
type ReadRsp = {
|
|
4815
|
-
bytesRead: number;
|
|
4816
|
-
ArrayBuffer: any;
|
|
4817
|
-
};
|
|
4818
|
-
|
|
4819
|
-
/**
|
|
4820
|
-
* 读文件参数
|
|
4821
|
-
* @property fd - 文件描述符
|
|
4822
|
-
* @property arrayBuffer - 数据写入的缓冲区,必须是 ArrayBuffer 实例
|
|
4823
|
-
* @property [offset] - 缓冲区中的写入偏移量,默认0
|
|
4824
|
-
* @property [length] - 要从文件中读取的字节数,默认0
|
|
4825
|
-
* @property [position] - 文件读取的起始位置
|
|
4826
|
-
*/
|
|
4827
|
-
type ReadReq = {
|
|
4828
|
-
fd: string;
|
|
4829
|
-
arrayBuffer: any;
|
|
4830
|
-
offset?: number;
|
|
4831
|
-
length?: number;
|
|
4832
|
-
position?: number;
|
|
4833
|
-
};
|
|
4834
|
-
|
|
4835
|
-
/**
|
|
4836
|
-
* 压缩类型的本地文件内容
|
|
4837
|
-
* @property data - 文件内容
|
|
4838
|
-
*/
|
|
4839
|
-
type ReadCompressedFileRsp = {
|
|
4840
|
-
data: any;
|
|
4841
|
-
};
|
|
4842
|
-
|
|
4843
|
-
/**
|
|
4844
|
-
* 读取指定压缩类型的本地文件内容参数
|
|
4845
|
-
* @property filePath - 要读取的文件的路径 (本地用户文件或代码包文件)
|
|
4846
|
-
*/
|
|
4847
|
-
type ReadCompressedFileReq = {
|
|
4848
|
-
filePath: string;
|
|
4849
|
-
};
|
|
4850
|
-
|
|
4851
|
-
/**
|
|
4852
|
-
* 读取目录内文件列表
|
|
4853
|
-
* @property files - 指定目录下的文件名数组
|
|
4854
|
-
*/
|
|
4855
|
-
type ReaddirRsp = {
|
|
4856
|
-
files: string[];
|
|
4857
|
-
};
|
|
4858
|
-
|
|
4859
|
-
/**
|
|
4860
|
-
* 读取目录内文件列表参数
|
|
4861
|
-
* @property dirPath - 要读取的目录路径 (本地路径)
|
|
4862
|
-
*/
|
|
4863
|
-
type ReaddirReq = {
|
|
4864
|
-
dirPath: string;
|
|
4865
|
-
};
|
|
4866
|
-
|
|
4867
|
-
/**
|
|
4868
|
-
* 读取文件结果
|
|
4869
|
-
* @property data - 文件数据
|
|
4870
|
-
*/
|
|
4871
|
-
type ReadFileRsp = {
|
|
4872
|
-
data: any;
|
|
4873
|
-
};
|
|
4874
|
-
|
|
4875
|
-
/**
|
|
4876
|
-
* 读取文件参数
|
|
4877
|
-
* @property filePath - 要读取的文件的路径 (本地路径)
|
|
4878
|
-
* @property [encoding] - 指定读取文件的字符编码, base64-base64, utf8-utf8
|
|
4879
|
-
* @property [position] - 从文件指定位置开始读,如果不指定,则从文件头开始读
|
|
4880
|
-
* @property [length] - 指定文件的长度,如果不指定,则读到文件末尾。
|
|
4881
|
-
*/
|
|
4882
|
-
type ReadFileReq = {
|
|
4883
|
-
filePath: string;
|
|
4884
|
-
encoding?: string;
|
|
4885
|
-
position?: number;
|
|
4886
|
-
length?: number;
|
|
4887
|
-
};
|
|
4888
|
-
|
|
4889
|
-
/**
|
|
4890
|
-
* 读取压缩包内的文件
|
|
4891
|
-
* @property entries - 文件读取结果,key是文件路径,value是一个对象 FileItem ,表示该文件的读取结果。每个 FileItem 包含 data (文件内容) 和 errMsg (错误信息) 属性。
|
|
4892
|
-
*/
|
|
4893
|
-
type ReadZipEntryRsp = {
|
|
4894
|
-
entries: any;
|
|
4895
|
-
};
|
|
4896
|
-
|
|
4897
|
-
/**
|
|
4898
|
-
* 读取压缩包内的文件参数
|
|
4899
|
-
* @property filePath - 要读取的文件的路径 (本地路径)
|
|
4900
|
-
* @property [encoding] - 指定读取文件的字符编码, base64-base64, utf8-utf8
|
|
4901
|
-
* @property entries - 要读取的压缩包内的文件列表(当传入"all" 时表示读取压缩包内所有文件)
|
|
4902
|
-
*/
|
|
4903
|
-
type ReadZipEntryReq = {
|
|
4904
|
-
filePath: string;
|
|
4905
|
-
encoding?: string;
|
|
4906
|
-
entries: any;
|
|
4907
|
-
};
|
|
4908
|
-
|
|
4909
|
-
/**
|
|
4910
|
-
* 解压文件参数
|
|
4911
|
-
* @property zipFilePath - 源文件路径,支持本地路径,只可以是 zip 压缩文件
|
|
4912
|
-
* @property targetPath - 目标目录路径,支持本地路径
|
|
4913
|
-
*/
|
|
4914
|
-
type UnzipReq = {
|
|
4915
|
-
zipFilePath: string;
|
|
4916
|
-
targetPath: string;
|
|
4917
|
-
};
|
|
4918
|
-
|
|
4919
|
-
/**
|
|
4920
|
-
* 删除该小程序下已保存的本地缓存文件参数
|
|
4921
|
-
* @property filePath - 需要删除的文件路径 (本地路径)
|
|
4922
|
-
*/
|
|
4923
|
-
type RemoveSavedFileReq = {
|
|
4924
|
-
filePath: string;
|
|
4925
|
-
};
|
|
4926
|
-
|
|
4927
|
-
/**
|
|
4928
|
-
* 重命名文件参数
|
|
4929
|
-
* @property oldPath - 源文件路径,支持本地路径
|
|
4930
|
-
* @property newPath - 新文件路径,支持本地路径
|
|
4931
|
-
*/
|
|
4932
|
-
type RenameReq = {
|
|
4933
|
-
oldPath: string;
|
|
4934
|
-
newPath: string;
|
|
4935
|
-
};
|
|
4936
|
-
|
|
4937
|
-
/**
|
|
4938
|
-
* 删除目录参数
|
|
4939
|
-
* @property dirPath - 要删除的目录路径 (本地路径)
|
|
4940
|
-
* @property [recursive] - 是否递归删除目录。如果为 true,则删除该目录和该目录下的所有子目录以及文件。
|
|
4941
|
-
*/
|
|
4942
|
-
type RmdirReq = {
|
|
4943
|
-
dirPath: string;
|
|
4944
|
-
recursive?: boolean;
|
|
4945
|
-
};
|
|
4946
|
-
|
|
4947
|
-
/**
|
|
4948
|
-
* 保存临时文件到本地结果
|
|
4949
|
-
* @property savedFilePath - 存储后的文件路径 (本地路径)
|
|
4950
|
-
*/
|
|
4951
|
-
type SaveFileRsp = {
|
|
4952
|
-
savedFilePath: string;
|
|
4953
|
-
};
|
|
4954
|
-
|
|
4955
|
-
/**
|
|
4956
|
-
* 保存临时文件到本地参数
|
|
4957
|
-
* @property tempFilePath - 临时存储文件路径 (本地路径)
|
|
4958
|
-
* @property [filePath] - 要存储的文件路径 (本地路径)
|
|
4959
|
-
*/
|
|
4960
|
-
type SaveFileReq = {
|
|
4961
|
-
tempFilePath: string;
|
|
4962
|
-
filePath?: string;
|
|
4963
|
-
};
|
|
4964
|
-
|
|
4965
|
-
/**
|
|
4966
|
-
* 文件Stats对象结果
|
|
4967
|
-
* @property stats - 当recursive为false时,res.stats是一个Stats对象。当recursive为true且path是一个目录的路径时,res.stats是一个Array,数组的每一项是一个对象,每个对象包含path和stats
|
|
4968
|
-
*/
|
|
4969
|
-
type StatRsp = {
|
|
4970
|
-
stats: any;
|
|
4971
|
-
};
|
|
4972
|
-
|
|
4973
|
-
/**
|
|
4974
|
-
* 获取文件Stats对象参数
|
|
4975
|
-
* @property path - 文件/目录路径 (本地路径)
|
|
4976
|
-
* @property [recursive] - 是否递归获取目录下的每个文件的 Stats 信息
|
|
4977
|
-
*/
|
|
4978
|
-
type StatReq = {
|
|
4979
|
-
path: string;
|
|
4980
|
-
recursive?: boolean;
|
|
4981
|
-
};
|
|
4982
|
-
|
|
4983
|
-
/**
|
|
4984
|
-
* 对文件内容进行截断操作参数
|
|
4985
|
-
* @property filePath - 要截断的文件路径 (本地路径)
|
|
4986
|
-
* @property [length] - 截断位置,默认0。如果 length 小于文件长度(字节),则只有前面 length 个字节会保留在文件中,其余内容会被删除;如果 length 大于文件长度,则会对其进行扩展,并且扩展部分将填充空字节('\0')
|
|
4987
|
-
*/
|
|
4988
|
-
type TruncateReq = {
|
|
4989
|
-
filePath: string;
|
|
4990
|
-
length?: number;
|
|
4991
|
-
};
|
|
4992
|
-
|
|
4993
|
-
/**
|
|
4994
|
-
* 删除文件参数
|
|
4995
|
-
* @property filePath - 要删除的文件路径 (本地路径)
|
|
4996
|
-
*/
|
|
4997
|
-
type UnlinkReq = {
|
|
4998
|
-
filePath: string;
|
|
4999
|
-
};
|
|
5000
|
-
|
|
5001
|
-
/**
|
|
5002
|
-
* 写文件参数
|
|
5003
|
-
* @property fd - 文件描述符
|
|
5004
|
-
* @property data - 要写入的文本或二进制数据
|
|
5005
|
-
* @property [offset] - 在 data 是 ArrayBuffer 时要写入的 arrayBuffer 中的索引,默认0
|
|
5006
|
-
* @property [length] - 在 data 是 ArrayBuffer 时指定要写入的字节数
|
|
5007
|
-
* @property [encoding] - 指定写入文件的字符编码, base64-base64, utf8-utf8
|
|
5008
|
-
* @property [position] - 指定文件开头的偏移量,即数据要被写入的位置
|
|
5009
|
-
*/
|
|
5010
|
-
type WriteReq = {
|
|
5011
|
-
fd: string;
|
|
5012
|
-
data: string;
|
|
5013
|
-
offset?: number;
|
|
5014
|
-
length?: number;
|
|
5015
|
-
encoding?: string;
|
|
5016
|
-
position?: number;
|
|
5017
|
-
};
|
|
5018
|
-
|
|
5019
|
-
/**
|
|
5020
|
-
* 写文件参数
|
|
5021
|
-
* @property filePath - 要写入的文件路径 (本地路径)
|
|
5022
|
-
* @property data - 要写入的文本或二进制数据
|
|
5023
|
-
* @property [encoding] - 指定写入文件的字符编码, base64-base64, utf8-utf8
|
|
5024
|
-
*/
|
|
5025
|
-
type WriteFileReq = {
|
|
5026
|
-
filePath: string;
|
|
5027
|
-
data: string;
|
|
5028
|
-
encoding?: string;
|
|
5029
|
-
};
|
|
5030
|
-
|
|
5031
|
-
/**
|
|
5032
|
-
* 文件状态
|
|
5033
|
-
* @property mode - 文件的类型和存取的权限
|
|
5034
|
-
* @property size - 文件大小,单位:B
|
|
5035
|
-
* @property lastAccessedTime - 文件最近一次被存取或被执行的时间戳
|
|
5036
|
-
* @property lastModifiedTime - 文件最后一次被修改的时间戳
|
|
5037
|
-
* @property isDirectory - 判断当前文件是否一个目录
|
|
5038
|
-
* @property isFile - 判断当前文件是否一个普通文件
|
|
5039
|
-
*/
|
|
5040
|
-
type FileStats = {
|
|
5041
|
-
mode: number;
|
|
5042
|
-
size: number;
|
|
5043
|
-
lastAccessedTime: number;
|
|
5044
|
-
lastModifiedTime: number;
|
|
5045
|
-
isDirectory: boolean;
|
|
5046
|
-
isFile: boolean;
|
|
5047
|
-
};
|
|
5048
|
-
|
|
5049
|
-
/**
|
|
5050
|
-
* 获取文件的状态信息参数
|
|
5051
|
-
* @property stats - 文件状态
|
|
5052
|
-
*/
|
|
5053
|
-
type FstatRsp = {
|
|
5054
|
-
stats: FileStats;
|
|
5055
|
-
};
|
|
5056
|
-
|
|
5057
|
-
/**
|
|
5058
|
-
* 获取文件的状态信息参数
|
|
5059
|
-
* @property fd - 文件描述符
|
|
5060
|
-
*/
|
|
5061
|
-
type FstatReq = {
|
|
5062
|
-
fd: string;
|
|
5063
|
-
};
|
|
5064
|
-
|
|
5065
|
-
/**
|
|
5066
|
-
* 对文件内容进行截断操作参数
|
|
5067
|
-
* @property fd - 文件描述符
|
|
5068
|
-
* @property length - 截断位置,默认0,如果 length 小于文件长度(单位:字节),则只有前面 length 个字节会保留在文件中,其余内容会被删除;如果 length 大于文件长度,则会对其进行扩展,并且扩展部分将填充空字节('\0')
|
|
5069
|
-
*/
|
|
5070
|
-
type FtruncateReq = {
|
|
5071
|
-
fd: string;
|
|
5072
|
-
length: number;
|
|
5073
|
-
};
|
|
5074
|
-
|
|
5075
4515
|
/**
|
|
5076
4516
|
* 游戏相关
|
|
5077
4517
|
*/
|
|
@@ -9550,6 +8990,11 @@ namespace yyb {
|
|
|
9550
8990
|
* @returns 调用结果
|
|
9551
8991
|
*/
|
|
9552
8992
|
function offCloudGameMsgFromYYB(): Promise<void>;
|
|
8993
|
+
/**
|
|
8994
|
+
* 获取云游分配的服务器节点信息
|
|
8995
|
+
* @returns 节点数据
|
|
8996
|
+
*/
|
|
8997
|
+
function getYYBCloudGameServerSource(): Promise<CloudGameServerSourceInfo>;
|
|
9553
8998
|
}
|
|
9554
8999
|
|
|
9555
9000
|
/**
|
|
@@ -9571,8 +9016,13 @@ type LaunchYYBCloudGameReq = {
|
|
|
9571
9016
|
* @property cloudGameSource - 游戏来源
|
|
9572
9017
|
* @property cloudGamePackageName - 游戏包名
|
|
9573
9018
|
* @property entranceId - 游戏ID
|
|
9574
|
-
* @property needShowFloatingWindow -
|
|
9019
|
+
* @property needShowFloatingWindow - 是否需要显示悬浮球, 1-显示, 0-不显示
|
|
9575
9020
|
* @property gameIconUrl - 游戏图标链接
|
|
9021
|
+
* @property [needUseCustomLoadingUI] - 是否使用自定义加载页面, 1-是, 0-否
|
|
9022
|
+
* @property [loadBgUrl] - 加载过程的背景url
|
|
9023
|
+
* @property [loadMsg] - 加载过程的文案
|
|
9024
|
+
* @property [needObserPerformance] - 是否需要监听性能数据, 1-是, 0-否
|
|
9025
|
+
* @property [performanceFrequency] - 性能数据回调频控,单位秒
|
|
9576
9026
|
*/
|
|
9577
9027
|
type StartYYBCloudGameReq = {
|
|
9578
9028
|
bizIdDev: string;
|
|
@@ -9580,8 +9030,13 @@ type StartYYBCloudGameReq = {
|
|
|
9580
9030
|
cloudGameSource: string;
|
|
9581
9031
|
cloudGamePackageName: string;
|
|
9582
9032
|
entranceId: string;
|
|
9583
|
-
needShowFloatingWindow:
|
|
9033
|
+
needShowFloatingWindow: number;
|
|
9584
9034
|
gameIconUrl: string;
|
|
9035
|
+
needUseCustomLoadingUI?: number;
|
|
9036
|
+
loadBgUrl?: string;
|
|
9037
|
+
loadMsg?: string;
|
|
9038
|
+
needObserPerformance?: number;
|
|
9039
|
+
performanceFrequency?: number;
|
|
9585
9040
|
};
|
|
9586
9041
|
|
|
9587
9042
|
/**
|
|
@@ -9607,5 +9062,15 @@ type OnYYBCloudGameMsgReq = {
|
|
|
9607
9062
|
callback: YYBCloudGameMsgCallback;
|
|
9608
9063
|
};
|
|
9609
9064
|
|
|
9065
|
+
/**
|
|
9066
|
+
* 节点数据
|
|
9067
|
+
* @property deviceArea - 节点信息,如guangzhou、shenzhen等
|
|
9068
|
+
* @property deviceId - 节点id
|
|
9069
|
+
*/
|
|
9070
|
+
type CloudGameServerSourceInfo = {
|
|
9071
|
+
deviceArea: string;
|
|
9072
|
+
deviceId: string;
|
|
9073
|
+
};
|
|
9074
|
+
|
|
9610
9075
|
|
|
9611
9076
|
}
|