1/* 2 * Copyright (C) 2022-2024 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16/** 17 * @file 18 * @kit CoreFileKit 19 */ 20 21import type { AsyncCallback, Callback } from './@ohos.base'; 22import type wantConstant from './@ohos.ability.wantConstant'; 23 24/** 25 * Provides fileshare APIS 26 * 27 * @namespace fileShare 28 * @syscap SystemCapability.FileManagement.AppFileService 29 * @since 9 30 */ 31declare namespace fileShare { 32 /** 33 * Enumerates the uri operate mode types. 34 * 35 * @enum { number } OperationMode 36 * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization 37 * @since 11 38 */ 39 export enum OperationMode { 40 /** 41 * Indicates read permissions. 42 * 43 * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization 44 * @since 11 45 */ 46 READ_MODE = 0b1, 47 48 /** 49 * Indicates write permissions. 50 * 51 * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization 52 * @since 11 53 */ 54 WRITE_MODE = 0b10, 55 } 56 57 /** 58 * Enumerates the error code of the permission policy for the URI operation. 59 * 60 * @enum { number } PolicyErrorCode 61 * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization 62 * @since 11 63 */ 64 export enum PolicyErrorCode { 65 /** 66 * Indicates that the policy is not allowed to be persisted. 67 * 68 * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization 69 * @since 11 70 */ 71 PERSISTENCE_FORBIDDEN = 1, 72 73 /** 74 * Indicates that the mode of this policy is invalid. 75 * 76 * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization 77 * @since 11 78 */ 79 INVALID_MODE = 2, 80 81 /** 82 * Indicates that the path of this policy is invalid. 83 * 84 * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization 85 * @since 11 86 */ 87 INVALID_PATH = 3, 88 89 /** 90 * Indicates that the permission is not persistent. 91 * 92 * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization 93 * @since 12 94 */ 95 PERMISSION_NOT_PERSISTED = 4, 96 } 97 98 /** 99 * Failed policy result on URI. 100 * 101 * @typedef { object } 102 * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization 103 * @since 11 104 */ 105 export type PolicyErrorResult = { 106 /** 107 * Indicates the failed uri of the policy information. 108 * 109 * @type { string } 110 * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization 111 * @since 11 112 */ 113 uri: string; 114 115 /** 116 * Indicates the error code of the failure in the policy information. 117 * 118 * @type { PolicyErrorCode } 119 * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization 120 * @since 11 121 */ 122 code: PolicyErrorCode; 123 124 /** 125 * Indicates the reason of the failure in the policy information. 126 * 127 * @type { string } 128 * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization 129 * @since 11 130 */ 131 message: string; 132 }; 133 134 /** 135 * Policy information to manager permissions on a URI. 136 * 137 * @interface PolicyInfo 138 * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization 139 * @since 11 140 */ 141 export interface PolicyInfo { 142 /** 143 * Indicates the uri of the policy information. 144 * 145 * @type { string } 146 * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization 147 * @since 11 148 */ 149 uri: string; 150 151 /** 152 * Indicates the mode of operation for the URI, example { OperationMode.READ_MODE } or { OperationMode.READ_MODE | OperationMode.WRITE_MODE } 153 * 154 * @type { number } 155 * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization 156 * @since 11 157 */ 158 operationMode: number; 159 } 160 161 /** 162 * Provides grant uri permission for app 163 * 164 * @permission ohos.permission.WRITE_MEDIA 165 * @param { string } uri uri 166 * @param { string } bundleName bundleName 167 * @param { wantConstant.Flags } flag wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION or wantConstant.Flags.FLAG_AUTH_WRITE_URI_PERMISSION 168 * @param { AsyncCallback<void> } callback 169 * @throws { BusinessError } 201 - Permission verification failed 170 * @throws { BusinessError } 202 - The caller is not a system application 171 * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; 172 * <br>2.Incorrect parameter types. 173 * @throws { BusinessError } 143000001 - IPC error 174 * @syscap SystemCapability.FileManagement.AppFileService 175 * @systemapi 176 * @since 9 177 */ 178 function grantUriPermission( 179 uri: string, 180 bundleName: string, 181 flag: wantConstant.Flags, 182 callback: AsyncCallback<void> 183 ): void; 184 185 /** 186 * Provides grant uri permission for app 187 * 188 * @permission ohos.permission.WRITE_MEDIA 189 * @param { string } uri uri 190 * @param { string } bundleName bundleName 191 * @param { wantConstant.Flags } flag wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION or wantConstant.Flags.FLAG_AUTH_WRITE_URI_PERMISSION 192 * @returns { Promise<void> } no callback return Promise otherwise return void 193 * @throws { BusinessError } 201 - Permission verification failed 194 * @throws { BusinessError } 202 - The caller is not a system application 195 * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified; 196 * <br>2.Incorrect parameter types. 197 * @throws { BusinessError } 143000001 - IPC error 198 * @syscap SystemCapability.FileManagement.AppFileService 199 * @systemapi 200 * @since 9 201 */ 202 function grantUriPermission(uri: string, bundleName: string, flag: wantConstant.Flags): Promise<void>; 203 204 /** 205 * Set persistence permissions for the URI 206 * 207 * @permission ohos.permission.FILE_ACCESS_PERSIST 208 * @param { Array<PolicyInfo> } policies - Policy information to grant permission on URIs. 209 * @returns { Promise<void> } the promise returned by the function. 210 * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. 211 * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; 212 * <br>2.Incorrect parameter types. 213 * @throws { BusinessError } 801 - Capability not supported. 214 * @throws { BusinessError } 13900001 - Operation not permitted. 215 * @throws { BusinessError } 13900042 - Unknown error 216 * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization 217 * @since 11 218 */ 219 function persistPermission(policies: Array<PolicyInfo>): Promise<void>; 220 221 /** 222 * Revoke persistence permissions for the URI 223 * 224 * @permission ohos.permission.FILE_ACCESS_PERSIST 225 * @param { Array<PolicyInfo> } policies - Policy information to grant permission on URIs. 226 * @returns { Promise<void> } the promise returned by the function. 227 * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. 228 * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; 229 * <br>2.Incorrect parameter types. 230 * @throws { BusinessError } 801 - Capability not supported. 231 * @throws { BusinessError } 13900001 - Operation not permitted. 232 * @throws { BusinessError } 13900042 - Unknown error 233 * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization 234 * @since 11 235 */ 236 function revokePermission(policies: Array<PolicyInfo>): Promise<void>; 237 238 /** 239 * Enable the URI that have been permanently authorized 240 * 241 * @permission ohos.permission.FILE_ACCESS_PERSIST 242 * @param { Array<PolicyInfo> } policies - Policy information to grant permission on URIs. 243 * @returns { Promise<void> } the promise returned by the function. 244 * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. 245 * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; 246 * <br>2.Incorrect parameter types. 247 * @throws { BusinessError } 801 - Capability not supported. 248 * @throws { BusinessError } 13900001 - Operation not permitted. 249 * @throws { BusinessError } 13900042 - Unknown error 250 * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization 251 * @since 11 252 */ 253 function activatePermission(policies: Array<PolicyInfo>): Promise<void>; 254 255 /** 256 * Stop the authorized URI that has been enabled 257 * 258 * @permission ohos.permission.FILE_ACCESS_PERSIST 259 * @param { Array<PolicyInfo> } policies - Policy information to grant permission on URIs. 260 * @returns { Promise<void> } the promise returned by the function. 261 * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. 262 * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; 263 * <br>2.Incorrect parameter types. 264 * @throws { BusinessError } 801 - Capability not supported. 265 * @throws { BusinessError } 13900001 - Operation not permitted. 266 * @throws { BusinessError } 13900042 - Unknown error 267 * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization 268 * @since 11 269 */ 270 function deactivatePermission(policies: Array<PolicyInfo>): Promise<void>; 271 272 /** 273 * Check persistent permissions for the URI. 274 * 275 * @permission ohos.permission.FILE_ACCESS_PERSIST 276 * @param { Array<PolicyInfo> } policies - Policy information to grant permission on URIs. 277 * @returns { Promise<Array<boolean>> } Returns the persistent state of uri permissions. 278 * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. 279 * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; 280 * <br>2.Incorrect parameter types. 281 * @throws { BusinessError } 801 - Capability not supported. 282 * @throws { BusinessError } 13900042 - Unknown error 283 * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization 284 * @since 12 285 */ 286 function checkPersistentPermission(policies: Array<PolicyInfo>): Promise<Array<boolean>>; 287} 288 289export default fileShare; 290