Skip to main content

Class: abstract BaseNativeStorageClient

Extended by​

Implements​

Constructors​

new BaseNativeStorageClient()​

new BaseNativeStorageClient(nativeStorageModule, rootFolderId): BaseNativeStorageClient

Parameters​

• nativeStorageModule: NativeStorageClient

• rootFolderId: string

Returns​

BaseNativeStorageClient

Defined in​

packages/core/src/BaseNativeStorageClient.ts:20

Properties​

nativeStorageModule​

nativeStorageModule: NativeStorageClient

Defined in​

packages/core/src/BaseNativeStorageClient.ts:17


rootFolderId​

readonly rootFolderId: string

Implementation of​

IStorageClient.rootFolderId

Defined in​

packages/core/src/BaseNativeStorageClient.ts:18

Methods​

createFileWithExtension()​

createFileWithExtension(name, fileExtension, parentId?): Promise<undefined | StorageEntity>

Parameters​

• name: string

• fileExtension: string

• parentId?: string

Returns​

Promise<undefined | StorageEntity>

Implementation of​

IStorageClient.createFileWithExtension

Defined in​

packages/core/src/BaseNativeStorageClient.ts:83


createFileWithMimeType()​

createFileWithMimeType(name, mimeType, parentId?): Promise<undefined | StorageEntity>

Parameters​

• name: string

• mimeType: string

• parentId?: string

Returns​

Promise<undefined | StorageEntity>

Implementation of​

IStorageClient.createFileWithMimeType

Defined in​

packages/core/src/BaseNativeStorageClient.ts:64


createFolder()​

createFolder(name, parentId?): Promise<undefined | StorageEntity>

Parameters​

• name: string

• parentId?: string

Returns​

Promise<undefined | StorageEntity>

Implementation of​

IStorageClient.createFolder

Defined in​

packages/core/src/BaseNativeStorageClient.ts:102


createPermission()​

createPermission(fileId, role, recipient, sendNotificationEmail, emailMessage?): Promise<undefined | Permission>

Parameters​

• fileId: string

• role: PermissionRole

• recipient: PermissionRecipient

• sendNotificationEmail: boolean

• emailMessage?: string

Returns​

Promise<undefined | Permission>

Implementation of​

IStorageClient.createPermission

Defined in​

packages/core/src/BaseNativeStorageClient.ts:163


deleteFile()​

deleteFile(fileId): Promise<undefined>

Parameters​

• fileId: string

Returns​

Promise<undefined>

Implementation of​

IStorageClient.deleteFile

Defined in​

packages/core/src/BaseNativeStorageClient.ts:128


deletePermission()​

deletePermission(fileId, permissionId): Promise<void>

Parameters​

• fileId: string

• permissionId: string

Returns​

Promise<void>

Implementation of​

IStorageClient.deletePermission

Defined in​

packages/core/src/BaseNativeStorageClient.ts:200


downloadFile()​

downloadFile(file, saveDirectory): Promise<void>

Parameters​

• file: StorageEntity

• saveDirectory: string

Returns​

Promise<void>

Implementation of​

IStorageClient.downloadFile

Defined in​

packages/core/src/BaseNativeStorageClient.ts:245


downloadFileVersion()​

downloadFileVersion(file, versionId, saveDirectory): Promise<void>

Parameters​

• file: StorageEntity

• versionId: string

• saveDirectory: string

Returns​

Promise<void>

Implementation of​

IStorageClient.downloadFileVersion

Defined in​

packages/core/src/BaseNativeStorageClient.ts:279


exportFile()​

exportFile(file, mimeType, fileExtension, saveDirectory): Promise<void>

Parameters​

• file: StorageEntity

• mimeType: string

• fileExtension: string

• saveDirectory: string

Returns​

Promise<void>

Implementation of​

IStorageClient.exportFile

Defined in​

packages/core/src/BaseNativeStorageClient.ts:229


getFileMetadata()​

getFileMetadata(fileId): Promise<StorageEntityMetadata>

Parameters​

• fileId: string

Returns​

Promise<StorageEntityMetadata>

Implementation of​

IStorageClient.getFileMetadata

Defined in​

packages/core/src/BaseNativeStorageClient.ts:37


getFileVersions()​

getFileVersions(fileId): Promise<FileVersion[]>

Parameters​

• fileId: string

Returns​

Promise<FileVersion[]>

Implementation of​

IStorageClient.getFileVersions

Defined in​

packages/core/src/BaseNativeStorageClient.ts:268


getPermissions()​

getPermissions(fileId): Promise<Permission[]>

Parameters​

• fileId: string

Returns​

Promise<Permission[]>

Implementation of​

IStorageClient.getPermissions

Defined in​

packages/core/src/BaseNativeStorageClient.ts:144


getWebUrl()​

getWebUrl(fileId): Promise<string>

Parameters​

• fileId: string

Returns​

Promise<string>

Implementation of​

IStorageClient.getWebUrl

Defined in​

packages/core/src/BaseNativeStorageClient.ts:155


listFiles()​

listFiles(folderId): Promise<StorageEntity[]>

Parameters​

• folderId: string

Returns​

Promise<StorageEntity[]>

Implementation of​

IStorageClient.listFiles

Defined in​

packages/core/src/BaseNativeStorageClient.ts:26


localFileUpload()​

localFileUpload(file, folderId): Promise<StorageEntity>

Parameters​

• file: LocalFile

• folderId: string

Returns​

Promise<StorageEntity>

Implementation of​

IStorageClient.localFileUpload

Defined in​

packages/core/src/BaseNativeStorageClient.ts:115


permanentlyDeleteFile()​

permanentlyDeleteFile(fileId): Promise<undefined>

Parameters​

• fileId: string

Returns​

Promise<undefined>

Implementation of​

IStorageClient.permanentlyDeleteFile

Defined in​

packages/core/src/BaseNativeStorageClient.ts:136


search(query): Promise<StorageEntity[]>

Parameters​

• query: string

Returns​

Promise<StorageEntity[]>

Implementation of​

IStorageClient.search

Defined in​

packages/core/src/BaseNativeStorageClient.ts:53


updateFile()​

updateFile(file, fileId): Promise<StorageEntity>

Parameters​

• file: LocalFile

• fileId: string

Returns​

Promise<StorageEntity>

Implementation of​

IStorageClient.updateFile

Defined in​

packages/core/src/BaseNativeStorageClient.ts:255


updatePermission()​

updatePermission(fileId, permissionId, role): Promise<undefined | Permission>

Parameters​

• fileId: string

• permissionId: string

• role: PermissionRole

Returns​

Promise<undefined | Permission>

Implementation of​

IStorageClient.updatePermission

Defined in​

packages/core/src/BaseNativeStorageClient.ts:211