Interface: IStorageClient
Properties
rootFolderId
readonlyrootFolderId:string
Defined in
packages/core/src/StorageClient.types.ts:15
Methods
createFileWithExtension()
createFileWithExtension(
name,fileExtension,parentId?):Promise<undefined|StorageEntity>
Parameters
• name: string
• fileExtension: string
• parentId?: string
Returns
Promise<undefined | StorageEntity>
Defined in
packages/core/src/StorageClient.types.ts:24
createFileWithMimeType()
createFileWithMimeType(
name,mimeType,parentId?):Promise<undefined|StorageEntity>
Parameters
• name: string
• mimeType: string
• parentId?: string
Returns
Promise<undefined | StorageEntity>
Defined in
packages/core/src/StorageClient.types.ts:19
createFolder()
createFolder(
name,parentId?):Promise<undefined|StorageEntity>
Parameters
• name: string
• parentId?: string
Returns
Promise<undefined | StorageEntity>
Defined in
packages/core/src/StorageClient.types.ts:29
createPermission()
createPermission(
fileId,role,recipient,sendNotificationEmail,emailMessage?):Promise<void|Permission>
Parameters
• fileId: string
• role: PermissionRole
• recipient: PermissionRecipient
• sendNotificationEmail: boolean
• emailMessage?: string
Returns
Promise<void | Permission>
Defined in
packages/core/src/StorageClient.types.ts:45
deleteFile()
deleteFile(
fileId):Promise<void>
Parameters
• fileId: string
Returns
Promise<void>
Defined in
packages/core/src/StorageClient.types.ts:41
deletePermission()
deletePermission(
fileId,permissionId):Promise<void>
Parameters
• fileId: string
• permissionId: string
Returns
Promise<void>
Defined in
packages/core/src/StorageClient.types.ts:52
downloadFile()
downloadFile(
file,saveDirectory):Promise<void>
Parameters
• file: StorageEntity
• saveDirectory: string
Returns
Promise<void>
Defined in
packages/core/src/StorageClient.types.ts:39
downloadFileVersion()
downloadFileVersion(
file,versionId,saveDirectory):Promise<void>
Parameters
• file: StorageEntity
• versionId: string
• saveDirectory: string
Returns
Promise<void>
Defined in
packages/core/src/StorageClient.types.ts:60
exportFile()
exportFile(
file,mimeType,fileExtension,saveDirectory):Promise<void>
Parameters
• file: StorageEntity
• mimeType: string
• fileExtension: string
• saveDirectory: string
Returns
Promise<void>
Defined in
packages/core/src/StorageClient.types.ts:33
getFileMetadata()
getFileMetadata(
fileId):Promise<StorageEntityMetadata>
Parameters
• fileId: string
Returns
Promise<StorageEntityMetadata>
Defined in
packages/core/src/StorageClient.types.ts:17
getFileVersions()
getFileVersions(
fileId):Promise<FileVersion[]>
Parameters
• fileId: string
Returns
Promise<FileVersion[]>
Defined in
packages/core/src/StorageClient.types.ts:59
getPermissions()
getPermissions(
fileId):Promise<Permission[]>
Parameters
• fileId: string
Returns
Promise<Permission[]>
Defined in
packages/core/src/StorageClient.types.ts:43
getWebUrl()
getWebUrl(
fileId):Promise<undefined|string>
Parameters
• fileId: string
Returns
Promise<undefined | string>
Defined in
packages/core/src/StorageClient.types.ts:44
listFiles()
listFiles(
folderId):Promise<StorageEntity[]>
Parameters
• folderId: string
Returns
Promise<StorageEntity[]>
Defined in
packages/core/src/StorageClient.types.ts:16
localFileUpload()
localFileUpload(
file,folderId):Promise<StorageEntity>
Parameters
• file: LocalFile
• folderId: string
Returns
Promise<StorageEntity>
Defined in
packages/core/src/StorageClient.types.ts:40
permanentlyDeleteFile()
permanentlyDeleteFile(
fileId):Promise<void>
Parameters
• fileId: string
Returns
Promise<void>
Defined in
packages/core/src/StorageClient.types.ts:42
search()
search(
query):Promise<StorageEntity[]>
Parameters
• query: string
Returns
Promise<StorageEntity[]>
Defined in
packages/core/src/StorageClient.types.ts:18
updateFile()
updateFile(
file,fileId):Promise<StorageEntity>
Parameters
• file: LocalFile
• fileId: string
Returns
Promise<StorageEntity>
Defined in
packages/core/src/StorageClient.types.ts:58
updatePermission()
updatePermission(
fileId,permissionId,role):Promise<void|Permission>
Parameters
• fileId: string
• permissionId: string
• role: PermissionRole
Returns
Promise<void | Permission>