interface.uts 11.6 KB
Newer Older
DCloud-yyl's avatar
DCloud-yyl 已提交
1 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
export interface Uni {
  /**
    * getAppAuthorizeSetting()
    * @description 
    * 获取 APP 授权设置。
    * @param {void}  
    * @return {GetAppAuthorizeSettingResult}
    * @tutorial http://uniapp.dcloud.io/api/system/getappauthorizesetting
    * @uniPlatform
	* {
	* 	"app": {
	* 		"android": {
	* 			"osVer": "5.0",
	* 			"uniVer": "√",
	* 			"unixVer": "3.9+"
	* 		},
	* 		"ios": {
	* 			"osVer": "12.0",
	* 			"uniVer": "√",
	* 			"unixVer": "4.11"
	* 		}
	* 	},
    *   "web": {
    *     "uniVer": "x",
    *     "unixVer": "x"
    *   }
	* }
    * @example
     ```typescript
      uni.getAppAuthorizeSetting()
     ```
    */
  getAppAuthorizeSetting(): GetAppAuthorizeSettingResult;
}


export type GetAppAuthorizeSetting = () => GetAppAuthorizeSettingResult;
export type GetAppAuthorizeSettingResult = {
  /**
   * 允许 App 使用相册的开关(仅 iOS 支持)
   * - authorized: 已经获得授权,无需再次请求授权
   * - denied: 请求授权被拒绝,无法再次请求授权;(此情况需要引导用户打开系统设置,在设置页中打开权限)
   * - not determined: 尚未请求授权,会在App下一次调用系统相应权限时请求;(仅 iOS 会出现。此种情况下引导用户打开系统设置,不展示开关)
DCloud-yyl's avatar
DCloud-yyl 已提交
44 45
   * - config error: 当前应用没有配置相册权限描述
   * @type 'authorized' | 'denied' | 'not determined' |  'config error'
DCloud-yyl's avatar
DCloud-yyl 已提交
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
   * @uniPlatform 
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "x",
   * 			"uniVer": "x",
   * 			"unixVer": "x"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
   * 		}
   * 	}
   * }
   */
DCloud-yyl's avatar
DCloud-yyl 已提交
62
  albumAuthorized?: 'authorized' | 'denied' | 'not determined' | 'config error' | null,
DCloud-yyl's avatar
DCloud-yyl 已提交
63 64 65 66 67
  /**
   * 允许 App 使用蓝牙的开关(仅 iOS 支持)
   * - authorized: 已经获得授权,无需再次请求授权
   * - denied: 请求授权被拒绝,无法再次请求授权;(此情况需要引导用户打开系统设置,在设置页中打开权限)
   * - not determined: 尚未请求授权,会在App下一次调用系统相应权限时请求;(仅 iOS 会出现。此种情况下引导用户打开系统设置,不展示开关)
DCloud-yyl's avatar
DCloud-yyl 已提交
68
   * - config error: Android平台没有该值;iOS平台:当前应用没有配置蓝牙权限描述
DCloud-yyl's avatar
DCloud-yyl 已提交
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
   * @type 'authorized' | 'denied' | 'not determined' | 'config error'
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "x",
   * 			"uniVer": "x",
   * 			"unixVer": "x"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
   * 		}
   * 	}
   * }
   */
  bluetoothAuthorized?: 'authorized' | 'denied' | 'not determined' | 'config error' | null,
  /**
   * 允许 App 使用摄像头的开关
   * - authorized: 已经获得授权,无需再次请求授权
   * - denied: 请求授权被拒绝,无法再次请求授权;(此情况需要引导用户打开系统设置,在设置页中打开权限)
   * - not determined: 尚未请求授权,会在App下一次调用系统相应权限时请求;(仅 iOS 会出现。此种情况下引导用户打开系统设置,不展示开关)
DCloud-yyl's avatar
DCloud-yyl 已提交
92
   * - config error: Android平台:表示没有配置 `android.permission.CAMERA` 权限,[权限配置详情](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android.html#permissions);iOS平台:当前应用没有配置相机权限描述
DCloud-yyl's avatar
DCloud-yyl 已提交
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
   * @type 'authorized' | 'denied' | 'not determined' | 'config error'
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "4.4",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
   * 		}
   * 	}
   * }
   */
  cameraAuthorized: 'authorized' | 'denied' | 'not determined' | 'config error',
  /**
   * 允许 App 使用定位的开关
   * - authorized: 已经获得授权,无需再次请求授权
   * - denied: 请求授权被拒绝,无法再次请求授权;(此情况需要引导用户打开系统设置,在设置页中打开权限)
   * - not determined: 尚未请求授权,会在App下一次调用系统相应权限时请求;(仅 iOS 会出现。此种情况下引导用户打开系统设置,不展示开关)
DCloud-yyl's avatar
DCloud-yyl 已提交
116
   * - config error: Android平台:表示没有配置 `android.permission.ACCESS_COARSE_LOCATION` 权限,[权限配置详情](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android.html#permissions);iOS平台:当前应用没有配置定位权限描述
DCloud-yyl's avatar
DCloud-yyl 已提交
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
   * @type 'authorized' | 'denied' | 'not determined' | 'config error'
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "4.4",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
   * 		}
   * 	}
   * }
   */
  locationAuthorized: 'authorized' | 'denied' | 'not determined' | 'config error',
  /**
   * 定位准确度。
   * - reduced: 模糊定位
   * - full: 精准定位
DCloud-yyl's avatar
DCloud-yyl 已提交
139
   * - unsupported: 不支持(包括用户拒绝定位权限和没有包含定位权限描述)
DCloud-yyl's avatar
DCloud-yyl 已提交
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
   * @type 'reduced' | 'full' | 'unsupported'
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "4.4",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
   * 		}
   * 	}
   * }
   */
  locationAccuracy?: 'reduced' | 'full' | 'unsupported' | null,
  /**
   * 定位准确度(推荐使用 locationAccuracy 属性)。true 表示模糊定位,false 表示精确定位(仅 iOS 支持)
   * @type boolean
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "x",
   * 			"uniVer": "x",
   * 			"unixVer": "x"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
   * 		}
   * 	}
   * }
   */
  locationReducedAccuracy?: boolean | null,
  /**
   * 允许 App 使用麦克风的开关
   * - authorized: 已经获得授权,无需再次请求授权
   * - denied: 请求授权被拒绝,无法再次请求授权;(此情况需要引导用户打开系统设置,在设置页中打开权限)
   * - not determined: 尚未请求授权,会在App下一次调用系统相应权限时请求;(仅 iOS 会出现。此种情况下引导用户打开系统设置,不展示开关)
DCloud-yyl's avatar
DCloud-yyl 已提交
183
   * - config error: Android平台:表示没有配置 `android.permission.RECORD_AUDIO` 权限,[权限配置详情](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android.html#permissions);iOS平台:当前应用没有配置麦克风权限描述
DCloud-yyl's avatar
DCloud-yyl 已提交
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
   * @type 'authorized' | 'denied' | 'not determined' | 'config error'
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "4.4",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
   * 		}
   * 	}
   * }
   */
  microphoneAuthorized: 'authorized' | 'denied' | 'not determined' | 'config error',
  /**
   * 允许 App 通知的开关
   * - authorized: 已经获得授权,无需再次请求授权
   * - denied: 请求授权被拒绝,无法再次请求授权;(此情况需要引导用户打开系统设置,在设置页中打开权限)
   * - not determined: 尚未请求授权,会在App下一次调用系统相应权限时请求;(仅 iOS 会出现。此种情况下引导用户打开系统设置,不展示开关)
DCloud-yyl's avatar
DCloud-yyl 已提交
207
   * - config error: Android平台没有该值;iOS平台:没有包含推送权限描述
DCloud-yyl's avatar
DCloud-yyl 已提交
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
   * @type 'authorized' | 'denied' | 'not determined' | 'config error'
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "4.4",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
   * 		}
   * 	}
   * }
   */
  notificationAuthorized: 'authorized' | 'denied' | 'not determined' | 'config error',
  /**
   * 允许 App 通知带有提醒的开关(仅 iOS 支持)
   * - authorized: 已经获得授权,无需再次请求授权
   * - denied: 请求授权被拒绝,无法再次请求授权;(此情况需要引导用户打开系统设置,在设置页中打开权限)
   * - not determined: 尚未请求授权,会在App下一次调用系统相应权限时请求;(仅 iOS 会出现。此种情况下引导用户打开系统设置,不展示开关)
DCloud-yyl's avatar
DCloud-yyl 已提交
231
   * - config error: 当前应用没有配置推送权限描述
DCloud-yyl's avatar
DCloud-yyl 已提交
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
   * @type 'authorized' | 'denied' | 'not determined' | 'config error'
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "x",
   * 			"uniVer": "x",
   * 			"unixVer": "x"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
   * 		}
   * 	}
   * }
   */
  notificationAlertAuthorized?: 'authorized' | 'denied' | 'not determined' | 'config error' | null,
  /**
   * 允许 App 通知带有标记的开关(仅 iOS 支持)
   * - authorized: 已经获得授权,无需再次请求授权
   * - denied: 请求授权被拒绝,无法再次请求授权;(此情况需要引导用户打开系统设置,在设置页中打开权限)
   * - not determined: 尚未请求授权,会在App下一次调用系统相应权限时请求;(仅 iOS 会出现。此种情况下引导用户打开系统设置,不展示开关)
DCloud-yyl's avatar
DCloud-yyl 已提交
255
   * - config error: 当前应用没有配置推送权限描述
DCloud-yyl's avatar
DCloud-yyl 已提交
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
   * @type 'authorized' | 'denied' | 'not determined' | 'config error'
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "x",
   * 			"uniVer": "x",
   * 			"unixVer": "x"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
   * 		}
   * 	}
   * }
   */
  notificationBadgeAuthorized?: 'authorized' | 'denied' | 'not determined' | 'config error' | null,
  /**
   * 允许 App 通知带有声音的开关(仅 iOS 支持)
   * - authorized: 已经获得授权,无需再次请求授权
   * - denied: 请求授权被拒绝,无法再次请求授权;(此情况需要引导用户打开系统设置,在设置页中打开权限)
   * - not determined: 尚未请求授权,会在App下一次调用系统相应权限时请求;(仅 iOS 会出现。此种情况下引导用户打开系统设置,不展示开关)
DCloud-yyl's avatar
DCloud-yyl 已提交
279
   * - config error: 当前应用没有配置推送权限描述
DCloud-yyl's avatar
DCloud-yyl 已提交
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 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
   * @type 'authorized' | 'denied' | 'not determined' | 'config error'
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "x",
   * 			"uniVer": "x",
   * 			"unixVer": "x"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
   * 		}
   * 	}
   * }
   */
  notificationSoundAuthorized?: 'authorized' | 'denied' | 'not determined' | 'config error' | null,
  /**
   * 允许读写日历的开关(仅微信小程序支持)
   * - authorized: 已经获得授权,无需再次请求授权
   * - denied: 请求授权被拒绝,无法再次请求授权;(此情况需要引导用户打开系统设置,在设置页中打开权限)
   * - not determined: 尚未请求授权,会在App下一次调用系统相应权限时请求;(仅 iOS 会出现。此种情况下引导用户打开系统设置,不展示开关)
   * @type 'authorized' | 'denied' | 'not determined'
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "x",
   * 			"uniVer": "x",
   * 			"unixVer": "x"
   * 		},
   * 		"ios": {
   * 			"osVer": "x",
   * 			"uniVer": "x",
   * 			"unixVer": "x"
   * 		}
   * 	}
   * }
   */
  phoneCalendarAuthorized?: 'authorized' | 'denied' | 'not determined' | null
};