interface.uts 9.9 KB
Newer Older
M
mehaotian 已提交
1
export type ReportSuccess = {
M
mehaotian 已提交
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
  /**
	* 成功的详细信息
	*/
	errMsg : string,
}

export type ReportFail = {
	/**
	* 错误的详细信息
	*/
	errMsg : string,
}

export type ReportOptions = {
	/**
	 * 自定义事件名称,内置名称(不允许覆盖):
	 * uni-app-launch : 应用启动
	 * uni-app-show		: 应用进入前台
	 * uni-app-hide		: 应用进入后台
	 * uni-app-error	: 应用发生错误
	 */
	name : string
	/**
	 * 额外参数
	 */
	options ?: any
	/**
		* 接口调用结束的回调函数(调用成功、失败都会执行)
		*/
	success ?: (res : ReportSuccess) => void
	/**
		* 接口调用失败的回调函数
		*/
	fail ?: (res : ReportFail) => void
	/**
		* 接口调用成功的回调函数
		*/
	complete ?: (res : any) => void
}

export type ReportResult = {}

/**
* 自定义事件信息
* @param {ReportOptions} options
*
* @platforms APP-IOS = ^9.0,APP-ANDROID = ^22
* @since 4.25
*/

export type Report = (options : ReportOptions) => void

export interface Uni {
	/**
	 * 统计自定义事件
	 * @description 统计自定义事件上报
	 * @param {ReportOptions} options
	 * @example
	 * ```typescript
	 * uni.report({
	 *		name:'uni-app-launch',
	 *		success(res) {
	 *			console.log(res);
	 *		}
	 * })
	 * ```
	 * @remark
	 * - 该接口需要同步调用
	 */
	report(options : ReportOptions) : void,
}

// 统计插件参数类型
export type UniStatOptions = {
M
mehaotian 已提交
76 77 78 79
	/**
   * 是否开启debug模式
   * @defaultValue false
   */
M
mehaotian 已提交
80
	debug ?: boolean
M
mehaotian 已提交
81 82 83 84
	/**
   * 前端数据上报周期 ,单位s
   * @defaultValue 10
   */
M
mehaotian 已提交
85 86 87 88 89 90 91 92
	reportInterval ?: number
	/* 多服务空间配置 */
	uniCloud ?: UniCloudInitOptions
	/* 采集项配置 */
	collectItems ?: UniStatCollectItemsOptions
}

export type UniStatCollectItemsOptions = {
M
mehaotian 已提交
93 94 95 96
	/**
   * 是否开启推送PushClientID的采集
   * @defaultValue false
   */
M
mehaotian 已提交
97
	uniPushClientID ?: boolean
M
mehaotian 已提交
98 99 100 101
	/**
   * 是否开启页面数据采集
   * @defaultValue true
   */
M
mehaotian 已提交
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
	uniStatPageLog ?: boolean
}

/**
 * 应用参数扩展
 */
export type OnLaunchOptionsWithCst = {
	/** 页面路径 */
	path ?: string
	/** 上报时机,参看 ReprotCstType */
	cst ?: number
	/** 场景值 */
	scene ?: number
	/** 参数 */
	query ?: string
};

/**
 * 停留时长
 */
export type ResidenceTimeReturn = {
	/** 停留时长 */
	residenceTime : number
	/** 是否超时 */
	overtime : boolean
}

/**
 * 路由
 */
export type RouteParams = {
	path : string
	fullpath : string
}

/**
 * 页面标题
 */
export type TitleConfigParams = {
	/** pages.json 中的标题 */
	config : string
	/** setNavigationBarTitle 获取的标题*/
	page : string
	/** 自定义上报的标题 */
	report : string
	/** 统计数据类型 */
	lt : string

}

/**
 * 页面参数
 */
export type PageParams = {
	/** 当前页面的完整 url,包含参数在内。最多255字符 */
	url ?: string
	/** pages.json 中定义的页面的 title,获取不到时,可以不传 */
	ttpj ?: string
	/** 通过接口 uni.setnavigationbartitle 设置的 title,获取不到时,可以不传 */
	ttn ?: string
	/** 通过 uni.report 上报的页面的 title,获取不到时,可以不传 */
	ttc ?: string
	/** title 组件中设置的 title,获取不到时,可以不传 */
	ttct ?: string
	/** 上个页面的完整 url */
	urlref : string
	/** 上个页面停留时间,单位为秒,不足1秒按1秒计。 url */
	urlref_ts : number
	/** 上个页面的标题 */
	urlref_tt ?: string
}

/**
 * 上传 unicloud 参数
 */
export type RequestData = {
	/** 统计 SDK 版本号 */
	usv : string
	/** 发送请求时的时间戮 */
	t : number
	/** 组合数据 */
	requests : string
}

/**
 * 用户自定义服务空间配置信息
 */
export type CustomUnicloudConfig = {
	/** 服务空间id */
	spaceId : string,
	/** 云厂商 */
	provider : string,
	/** clientSecret */
	clientSecret ?: string
	/** secretKey */
	secretKey ?: string
	/** secretId */
	secretId ?: string
}

M
mehaotian 已提交
202 203 204
/**
 * 事件类型
 */
M
mehaotian 已提交
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
export type EventParams = {
	/** 事件名字*/
	key : string
	/** 事件内容 */
	value ?: string
}

/**
 * 统计默认值
 */
export type StatDefault = {
	/** 设备标识 */
	uuid : string
	/** uni-app 应用 Appid */
	ak : string
	/** 手机系统 */
	p : string
	/** 平台类型 */
	ut : string
	/** 原生平台包名、小程序 appid */
	mpn ?: string
	/** 统计 sdk 版本 */
	usv ?: string
	/**  应用版本,仅app */
	v ?: string
	/** 渠道信息 */
	ch ?: string
	/** 国家 */
	cn ?: string
	/** 省份 */
	pn ?: string
	/** 城市 */
	ct ?: string
	/** 上报数据时的时间戳 */
	t : number
	/** 页面标题 */
	tt ?: string
	/** 手机品牌 */
	brand ?: string
	/** 手机型号 */
	md ?: string
	/** 手机系统版本 */
	sv ?: string
	/** x程序 sdk version */
	mpsdk ?: string
	/** 小程序平台版本 ,如微信、支付宝 */
	mpv ?: string
	/** 语言 */
	lang ?: string
	/** pixelRatio 设备像素比 */
	pr ?: number
	/** windowWidth 可使用窗口宽度 */
	ww ?: number
	/** windowHeight 可使用窗口高度 */
	wh ?: number
	/** screenWidth 屏幕宽度 */
	sw ?: number
	/** screenHeight 屏幕高度 */
	sh ?: number

	/** 场景值 */
	sc ?: number
	/** 统计数据类型 */
	lt ?: string
	/** 老用户错误的的设备id */
	odid ?: string
	url ?: string
	/** 首次访问时间戳。需要保存在 storage 中。用户首次访问时,取当前时间。*/
	fvts ?: number
	/** 上次访问时间戳。需要保存在 storage 中。用户首次访问时,设置为0。*/
	lvts ?: number
	/** total visit count 用户到本次访问为止总共的访问次数。*/
	tvc ?: number
	/** 上报时机,参看 ReprotCstType */
	cst ?: number
	urlref_ts ?: number
	urlref ?: string

	// 标题相关
	/** pages.json 中定义的页面的 title,获取不到时,可以不传 */
	ttpj ?: string
	/** 通过接口 uni.setnavigationbartitle 设置的 title,获取不到时,可以不传 */
	ttn ?: string
	/** 通过 uni.report 上报的页面的 title,获取不到时,可以不传 */
	ttc ?: string
	/** title 组件中设置的 title,获取不到时,可以不传 */
	ttct ?: string

	/** push id */
	cid ?: string

	/** 自定义事件key  */
	e_n ?: string
	/** 自定义事件value  */
	e_v ?: string

	/** 纬度 */
	lat ?: string
	/** 经度 */
	lng ?: string
	/** 网络 */
M
mehaotian 已提交
306 307
	net ?: string
	/** 错误信息 */
M
mehaotian 已提交
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
	em ?:string
}

/**
 * 应用首次启动上报参数
 */
export type AppShowReportParams = {
	/** uni-app 应用 Appid */
	uuid : string
	/** 设备标识 */
	ak : string
	/** 统计数据类型 */
	lt : string
	/** 平台类型 */
	ut : string
	/** x程序 sdk version */
	mpsdk : string
	/** 小程序平台版本 ,如微信、支付宝 */
	mpv : string
	/** 原生平台包名、小程序 appid */
	mpn : string
	/**  应用版本,仅app */
	v : string
	/** 手机系统 */
	p : string
	/** 手机系统版本 */
	sv : string
	/** 设备网络 */
	net : string
	/** 手机品牌 */
	brand : string
	/** 手机型号 */
	md : string
	/** 语言 */
	lang : string
	/** 纬度 */
	lat : string
	/** 经度 */
	lng : string
	/** pixelRatio 设备像素比 */
	pr : number
	/** windowWidth 可使用窗口宽度 */
	ww : number
	/** windowHeight 可使用窗口高度 */
	wh : number
	/** screenWidth 屏幕宽度 */
	sw : number
	/** screenHeight 屏幕高度 */
	sh : number
	/** 页面启动的url */
	url : string
	/** 页面标题 */
	tt : string
	/** 渠道信息 */
	ch : string
	/** 首次访问时间戳。需要保存在 storage 中。用户首次访问时,取当前时间。*/
	fvts : number
	/** 上次访问时间戳。需要保存在 storage 中。用户首次访问时,设置为0。*/
	lvts : number
	/** 国家 */
	cn : string
	/** 省份 */
	pn : string
	/** 城市 */
	ct : string
	/** 场景值 */
	sc : number
	/** total visit count 用户到本次访问为止总共的访问次数。*/
	tvc : number
	/** 统计 sdk 版本 */
	usv : string
	/** 上报数据时的时间戳 */
	t : number
	/** 老用户错误的的设备id */
	odid : string
	/** 上报时机,参看 ReprotCstType */
	cst : number
}

/**
 * 应用进入后台上报参数
 */
export type AppHideReportParams = {
	/** uni-app 应用 Appid */
	ak : string
	/** 设备标识 */
	uuid : string
	/** 统计数据类型 */
	lt : string
	/** 平台类型 */
	ut : string
	/** 手机系统 */
	p : string
	/** 上个页面的完整 url */
	urlref : string
	/** 上个页面停留时间,单位为秒,不足1秒按1秒计。 */
	urlref_ts : number
	/** 渠道信息 */
	ch : string
	/** 统计 sdk 版本 */
	usv : string
	/** 上报数据时的时间戳。 */
	t : number
}

/**
 * 页面切换上报参数
 */
export type PageReportParams = {
	/** uni-app 应用 Appid */
	ak : string
	/** 设备标识 */
	uuid : string
	/** 统计数据类型 */
	lt : string
	/** 平台类型 */
	ut : string
	/** 手机系统 */
	p : string
	/** 当前页面 url */
	url : string
	// 标题相关
	/** pages.json 中定义的页面的 title,获取不到时,可以不传 */
	ttpj : string
	/** 通过接口 uni.setnavigationbartitle 设置的 title,获取不到时,可以不传 */
	ttn : string
	/** 通过 uni.report 上报的页面的 title,获取不到时,可以不传 */
	ttc : string
	/** title 组件中设置的 title,获取不到时,可以不传 */
	ttct : string
	/** 上个页面的完整 url */
	urlref : string
	/** 上个页面停留时间,单位为秒,不足1秒按1秒计。 */
	urlref_ts : number
	/** 渠道信息 */
	ch : string
	/** 统计 sdk 版本 */
	usv : string
	/** 上报数据时的时间戳。 */
	t : number
	/** 上报时机,参看 ReprotCstType */
	cst ?: number
}

M
mehaotian 已提交
452
export type ErrorCallback = (is_err : boolean, errMsg : string) => void