Class FilebaseService

Hierarchy

FilebaseService

Implements

ShareServiceInterface

Constructors

constructor

new FilebaseService(): FilebaseService
Returns FilebaseService
- Defined in src/backend/shares/FilebaseService.ts:30

Properties

`Private` s3

s3: S3

`Private` settingsBucketName

settingsBucketName: string

`Private` sharesBucketName

sharesBucketName: string

Methods

addSettings

addSettings(settings): Promise<boolean>
Add settings to object
Parameters
- settings: NewSettings
Returns Promise<boolean>
Implementation of ShareServiceInterface.addSettings
- Defined in src/backend/shares/FilebaseService.ts:384

addShares

addShares(newShares): Promise<boolean>
Save shares for new wallet, or update social login for existing wallet given different loginId
Parameters
- newShares: NewShares
Returns Promise<boolean>
Implementation of ShareServiceInterface.addShares
- Defined in src/backend/shares/FilebaseService.ts:79

`Private` deleteMultipleObject

deleteMultipleObject(shares): Promise<void>
Delete multiple object in filebase
Parameters
- shares: ShareResponse[]
  shares to delete
Returns Promise<void>
- Defined in src/backend/shares/FilebaseService.ts:358

`Private` deleteObjectFromS3

deleteObjectFromS3(bucketName, objectName): Promise<void>
Delete object from S3
Parameters
- bucketName: string
  Bucket name
- objectName: string
  Object name
Returns Promise<void>
- Defined in src/backend/shares/FilebaseService.ts:600

deleteSettings

deleteSettings(wallet): Promise<boolean>
Delete settings data
Parameters
- wallet: string
Returns Promise<boolean>
Implementation of ShareServiceInterface.deleteSettings
- Defined in src/backend/shares/FilebaseService.ts:412

deleteShares

deleteShares(sharesId): Promise<boolean>
Delete saved shares of a wallet
Parameters
- sharesId: SharesId
  SharesId
Returns Promise<boolean>
Implementation of ShareServiceInterface.deleteShares
- Defined in src/backend/shares/FilebaseService.ts:159

`Private` getFilebaseByMetadata

getFilebaseByMetadata(filter, metadataOnly?): Promise<ShareResponse[]>
Get ojbect from filebase by its metadata
Parameters
- filter: FilebaseFilter
- metadataOnly: boolean = false
Returns Promise<ShareResponse[]>
- Defined in src/backend/shares/FilebaseService.ts:293

`Private` getFilebaseByObjectName

getFilebaseByObjectName(objectName, metadataOnly?): Promise<ShareResponse>
Get object from filebase by its name
Parameters
- objectName: string
- metadataOnly: boolean = false
Returns Promise<ShareResponse>
- Defined in src/backend/shares/FilebaseService.ts:265

`Private` getMetadata

getMetadata(objectName): Promise<CustomFilebaseMeta>
Get metadata (loginId and deviceId) of object through wallet and deviceId
Parameters
- objectName: string
Returns Promise<CustomFilebaseMeta>
- Defined in src/backend/shares/FilebaseService.ts:335

`Private` getObjectFromS3

getObjectFromS3(bucketName, objectName): Promise<PromiseResult<GetObjectOutput, AWSError>>
Get object from S3
Parameters
- bucketName: string
  Bucket name to get object from
- objectName: string
  Object name to get
Returns Promise<PromiseResult<GetObjectOutput, AWSError>>
- Defined in src/backend/shares/FilebaseService.ts:537

getSettingByWallet

getSettingByWallet(hashedWallet, metadataOnly?): Promise<null | SettingResponse>
Get settings by wallet
Parameters
- hashedWallet: string
- metadataOnly: boolean = false
Returns Promise<null | SettingResponse>
- Defined in src/backend/shares/FilebaseService.ts:465

getSettings

getSettings(wallet): Promise<SettingResponse>
Parameters
- wallet: string
Returns Promise<SettingResponse>
Implementation of ShareServiceInterface.getSettings
- Defined in src/backend/shares/FilebaseService.ts:370

getShares

getShares(sharesId): Promise<undefined | string[]>
Get share by wallet & loginId
Parameters
- sharesId: SharesId
Returns Promise<undefined | string[]>
Implementation of ShareServiceInterface.getShares
- Defined in src/backend/shares/FilebaseService.ts:51

getSharesByDeviceId

getSharesByDeviceId(hashedDeviceId, metadataOnly?): Promise<ShareResponse>
Get all shares by device id
Parameters
- hashedDeviceId: string
  Device ID
- metadataOnly: boolean = false
  Metadata only
Returns Promise<ShareResponse>
- Defined in src/backend/shares/FilebaseService.ts:199

getSharesByLoginId

getSharesByLoginId(loginId, metadataOnly?): Promise<ShareResponse[]>
Get all shares by loginId
Parameters
- loginId: string
  Social
- metadataOnly: boolean = false
  Metadata only
Returns Promise<ShareResponse[]>
- Defined in src/backend/shares/FilebaseService.ts:180

getSharesByWallet

getSharesByWallet(hashedWallet, metadataOnly?): Promise<ShareResponse[]>
Get shares by wallet
Parameters
- hashedWallet: string
  Wallet
- metadataOnly: boolean = false
  Metadata only
Returns Promise<ShareResponse[]>
- Defined in src/backend/shares/FilebaseService.ts:218

getSharesRelogin

getSharesRelogin(hashedWallet, hashedLoginId, hashedDeviceId): Promise<null | ShareResponse>
Get shares by wallet, deviceId, and loginId on relogin
Parameters
- hashedWallet: string
  Hashed wallet
- hashedLoginId: string
  Hashed login id
- hashedDeviceId: string
  Hashed device id
Returns Promise<null | ShareResponse>
- Defined in src/backend/shares/FilebaseService.ts:238

isDeviceIdExist

isDeviceIdExist(deviceId): Promise<boolean>
Is wallet with device id exist
Parameters
- deviceId: string
Returns Promise<boolean>
- Defined in src/backend/shares/FilebaseService.ts:742

isWalletExist

isWalletExist(wallet): Promise<boolean>
Is given wallet address exist
Parameters
- wallet: string
  Wallet
Returns Promise<boolean>
- Defined in src/backend/shares/FilebaseService.ts:728

`Private` listObjectsFromS3

listObjectsFromS3(bucketName): Promise<PromiseResult<ListObjectsV2Output, AWSError>>
List object from S3
Parameters
- bucketName: string
  Bucket name to list objects from
Returns Promise<PromiseResult<ListObjectsV2Output, AWSError>>
- Defined in src/backend/shares/FilebaseService.ts:514

`Private` putObjectToS3

putObjectToS3(bucketName, objectName, body, metadata?): Promise<void>
Put object to S3
Parameters
- bucketName: string
  Bucket name
- objectName: string
  Object name
- body: any
  Body of added object
- Optional metadata: any = {}
  Metadata for added object
Returns Promise<void>
- Defined in src/backend/shares/FilebaseService.ts:566

readIPFS

readIPFS(cid): Promise<any>
Read data from IPFS Gateway
Parameters
- cid: string
Returns Promise<any>
Implementation of ShareServiceInterface.readIPFS
- Defined in src/backend/shares/FilebaseService.ts:494

updateSettings

updateSettings(settings): Promise<boolean>
Update existing settings
Parameters
- settings: NewSettings
Returns Promise<boolean>
Implementation of ShareServiceInterface.updateSettings
- Defined in src/backend/shares/FilebaseService.ts:435

updateShares

updateShares(newShares): Promise<boolean>
Update shares for an existing wallet
Parameters
- newShares: NewShares
Returns Promise<boolean>
Implementation of ShareServiceInterface.updateShares
- Defined in src/backend/shares/FilebaseService.ts:121

`Private` validateDuplicateLoginId

validateDuplicateLoginId(hashedLoginId): Promise<any>
Validate duplicate social
Parameters
- hashedLoginId: string
  Social
Returns Promise<any>
- Defined in src/backend/shares/FilebaseService.ts:699

`Private` validateExistSettings

validateExistSettings(setting): void
Validate settings exists
Parameters
- setting: null | SettingResponse
Returns void
- Defined in src/backend/shares/FilebaseService.ts:624

`Private` validateGetShare

validateGetShare(shareByWallet): void
Validate get share
Parameters
- shareByWallet: null | ShareResponse
  Shareresponse by wallet
Returns void
- Defined in src/backend/shares/FilebaseService.ts:715

`Private` validateSameMetadata

validateSameMetadata(metadata, metadataFilter): boolean
Validate if the metadata of an object is the same as the metadata filter
Parameters
- metadata: CustomFilebaseMeta
- metadataFilter: FilebaseFilter
Returns boolean
- Defined in src/backend/shares/FilebaseService.ts:661

`Private` validateSameWallet

validateSameWallet(hashedLoginId, hashedWallet): Promise<any>
Validate same wallet
Parameters
- hashedLoginId: string
  Hashed login id
- hashedWallet: string
  Hashed wallet
Returns Promise<any>
- Defined in src/backend/shares/FilebaseService.ts:638

`Private` validateWalletExist

validateWalletExist(hashedWalletId): Promise<any>
Validate wallet exist
Parameters
- hashedWalletId: string
  Hashed wallet
Returns Promise<any>
- Defined in src/backend/shares/FilebaseService.ts:685

Generated using TypeDoc