Class FileAPI

Hierarchy

FileAPI

Constructors

constructor

new FileAPI(appAddress: string, appId: number, provider: any, api: AxiosInstance, lock: Mutex, debug: boolean): FileAPI

- Defined in fileAPI.ts:23
Parameters
- appAddress: string
- appId: number
- provider: any
- api: AxiosInstance
- lock: Mutex
- debug: boolean
Returns FileAPI

Methods

all

all(pageNumber?: number, pageSize?: number): Promise<string[]>

- Defined in fileAPI.ts:306
Parameters
- pageNumber: number = 1
- pageSize: number = 20
Returns Promise<string[]>

changeFileOwner

changeFileOwner(did: any, newOwnerAddress: string): Promise<string>

- Defined in fileAPI.ts:239
Parameters
- did: any
- newOwnerAddress: string
Returns Promise<string>

changeOwner

changeOwner(did: string, newOwnerAddress: string): Promise<string>

- Defined in fileAPI.ts:232
Parameters
- did: string
- newOwnerAddress: string
Returns Promise<string>

delete

delete(did: string): Promise<string>

- Defined in fileAPI.ts:244
Parameters
- did: string
Returns Promise<string>

deleteAccount

deleteAccount(): Promise<any>

- Defined in fileAPI.ts:267
Returns Promise<any>

deleteFile

deleteFile(did: string): Promise<string>

- Defined in fileAPI.ts:262
Parameters
- did: string
Returns Promise<string>

getAccountStatus

getAccountStatus(): Promise<any>

- Defined in fileAPI.ts:271
Returns Promise<any>

getDownloadLimit

getDownloadLimit(): Promise<[number, number]>

- Defined in fileAPI.ts:284
Returns Promise<[number, number]>

getPublicFileURL

getPublicFileURL(did: string): Promise<string>

- Defined in fileAPI.ts:108
Parameters
- did: string
Returns Promise<string>

getSharedUsers

getSharedUsers(did: string): Promise<string[]>

- Defined in fileAPI.ts:292
Parameters
- did: string
Returns Promise<string[]>

getUploadLimit

getUploadLimit(): Promise<[number, number]>

- Defined in fileAPI.ts:276
Returns Promise<[number, number]>

list

list(type: AccessTypeEnum, pageNumber?: number, pageSize?: number): Promise<any[]>

- Defined in fileAPI.ts:124
Parameters
- type: AccessTypeEnum
- pageNumber: number = 1
- pageSize: number = 20
Returns Promise<any[]>

myFiles

myFiles(pageNumber?: number, pageSize?: number): Promise<any[]>

- Defined in fileAPI.ts:68
Parameters
- pageNumber: number = 1
- pageSize: number = 20
Returns Promise<any[]>

numOfAllFiles

numOfAllFiles(): Promise<any>

- Defined in fileAPI.ts:50
Returns Promise<any>

numOfAllPages

numOfAllPages(pageSize?: number): Promise<number>

- Defined in fileAPI.ts:63
Parameters
- pageSize: number = 20
Returns Promise<number>

numOfMyFiles

numOfMyFiles(): Promise<any>

- Defined in fileAPI.ts:42
Returns Promise<any>

numOfMyFilesPages

numOfMyFilesPages(pageSize?: number): Promise<number>

- Defined in fileAPI.ts:58
Parameters
- pageSize: number = 20
Returns Promise<number>

numOfSharedFiles

numOfSharedFiles(): Promise<any>

- Defined in fileAPI.ts:85
Returns Promise<any>

numOfSharedFilesPages

numOfSharedFilesPages(pageSize?: number): Promise<number>

- Defined in fileAPI.ts:89
Parameters
- pageSize: number = 20
Returns Promise<number>

removeFile

removeFile(did: string): Promise<string>

- Defined in fileAPI.ts:252
Parameters
- did: string
Returns Promise<string>

removeFileFromApp

removeFileFromApp(did: string): Promise<string>

- Defined in fileAPI.ts:258
Parameters
- did: string
Returns Promise<string>

revoke

revoke(did: string, address: string | string[]): Promise<string>

- Defined in fileAPI.ts:225
Parameters
- did: string
- address: string | string[]
Returns Promise<string>

setAppAddress

setAppAddress(did: string): Promise<void>

- Defined in fileAPI.ts:35
Parameters
- did: string
Returns Promise<void>

share

share(did: string, _address: string | string[], validity: number | number[]): Promise<string>

- Defined in fileAPI.ts:199
Parameters
- did: string
- _address: string | string[]
- validity: number | number[]
Returns Promise<string>

sharedFiles

sharedFiles(pageNumber?: number, pageSize?: number): Promise<any[]>

- Defined in fileAPI.ts:93
Parameters
- pageNumber: number = 1
- pageSize: number = 20
Returns Promise<any[]>

Generated using TypeDoc, the 11/9/2022 at 3:32:28 PM