Interface IFiletreeReader
interface IFiletreeReader { encodeExistingPostFile(ulid,
location,
viewers): Promise<MsgPostFile>; encodeExistingRef(options): Promise<MsgPostFile>; encodePostFile(location,
meta,
options?): Promise<MsgPostFile>; encodeProvisionFileTree(): Promise<MsgProvisionFileTree>; findRefIndex(path): number; getConversionQueueLength(): number; getConversions(): Promise<TConversionPair[]>; livenessCheck(ulid,
ownerAddress): Promise<boolean>; loadFolderMetaByPath(path): Promise<IFolderMetaData>; loadFolderMetaByUlid(ulid): Promise<IFolderMetaData>; loadFolderMetaHandler(path): Promise<IFolderMetaHandler>; loadFromLegacyMerkles(path,
location,
fileMeta): Promise<IFileMetaHandler>; loadKeysByPath(path,
ownerAddress): Promise<IAesBundle>; loadKeysByUlid(ulid,
ownerAddress,
linkKey?): Promise<IAesBundle>; loadLegacyMeta(legacyMerkles,
legacyPath): Promise<IFileMetaData>; loadMetaByExternalPath(path,
ownerAddress): Promise<TMetaDataSets>; loadMetaByExternalUlid(ulid,
ownerAddress,
linkKey?): Promise<TMetaDataSets>; loadMetaByPath(path): Promise<TMetaDataSets>; loadMetaByUlid(options): Promise<TMetaDataSets>; loadRefMeta(options): Promise<IRefMetaData | INullRefMetaData>; loadShareMeta(path): Promise<IShareMetaData>; loadSharerRefMeta(ulid,
ref): Promise<ISharerRefMetaData | INullSharerRefMetaData>; protectNotification(receiverAddress,
aes): Promise<string>; readFolderContents(path,
options?): Promise<IChildMetaDataMap>; readShareNotification(notificationData): Promise<INotificationRecord>; readSharingRefCount(sharer?): Promise<[number, number]>; readViewerShares(ulid,
index?): string[]; refCountIncrement(path): void; refCountRead(path): Promise<number>; refCountSet(path,
value): void; setContents(ulid,
meta): Promise<IReconstructedFileTree>; setMetaViewers(options): Promise<IReconstructedFileTree>; sharerCountIncrement(ulid): void; sharerCountRead(ulid): Promise<number>; sharerCountSet(ulid,
value): void; sharerRefRead(path,
sharer): Promise<number>; sharersRead(path): Promise<string[]>; sharingLookup(options?): Promise<IFolderMetaData[] | IShareMetaData[]>; ulidLookup(path,
owner?): string; updateExistingPostFile(ulid,
location,
meta): Promise<MsgPostFile>; viewerLookup(ulid,
index?): Promise<Record<string, string>>; viewerSave(ulid,
access,
index?): void; } Methods
encodeExistingPostFile
- encodeExistingPostFile(ulid, location, viewers): Promise<MsgPostFile>
Returns Promise<MsgPostFile>
encodeExistingRef
- encodeExistingRef(options): Promise<MsgPostFile>
Returns Promise<MsgPostFile>
encodePostFile
- encodePostFile(location, meta, options?): Promise<MsgPostFile>
Returns Promise<MsgPostFile>
encodeProvisionFileTree
- encodeProvisionFileTree(): Promise<MsgProvisionFileTree>
Returns Promise<MsgProvisionFileTree>
findRefIndex
- findRefIndex(path): number
Returns number
getConversionQueueLength
- getConversionQueueLength(): number
Returns number
livenessCheck
- livenessCheck(ulid, ownerAddress): Promise<boolean>
Parameters
- ulid: string
- ownerAddress: string
Returns Promise<boolean>
loadFromLegacyMerkles
- loadFromLegacyMerkles(path, location, fileMeta): Promise<IFileMetaHandler>
Parameters
- path: string
- location: string
- fileMeta: IFileMeta
loadKeysByPath
- loadKeysByPath(path, ownerAddress): Promise<IAesBundle>
Parameters
- path: string
- ownerAddress: string
loadKeysByUlid
- loadKeysByUlid(ulid, ownerAddress, linkKey?): Promise<IAesBundle>
Parameters
- ulid: string
- ownerAddress: string
Optional
linkKey: string
loadLegacyMeta
- loadLegacyMeta(legacyMerkles, legacyPath): Promise<IFileMetaData>
Parameters
- legacyMerkles: Uint8Array[]
- legacyPath: [string, string]
loadMetaByExternalPath
- loadMetaByExternalPath(path, ownerAddress): Promise<TMetaDataSets>
Parameters
- path: string
- ownerAddress: string
loadMetaByExternalUlid
- loadMetaByExternalUlid(ulid, ownerAddress, linkKey?): Promise<TMetaDataSets>
Parameters
- ulid: string
- ownerAddress: string
Optional
linkKey: string
protectNotification
- protectNotification(receiverAddress, aes): Promise<string>
Returns Promise<string>
readShareNotification
- readShareNotification(notificationData): Promise<INotificationRecord>
Parameters
- notificationData: Notification_2
readSharingRefCount
- readSharingRefCount(sharer?): Promise<[number, number]>
Returns Promise<[number, number]>
readViewerShares
- readViewerShares(ulid, index?): string[]
Parameters
- ulid: string
Optional
index: number
Returns string[]
refCountIncrement
- refCountIncrement(path): void
Returns void
refCountRead
- refCountRead(path): Promise<number>
Returns Promise<number>
refCountSet
- refCountSet(path, value): void
Parameters
- path: string
- value: number
Returns void
sharerCountIncrement
- sharerCountIncrement(ulid): void
Returns void
sharerCountRead
- sharerCountRead(ulid): Promise<number>
Returns Promise<number>
sharerCountSet
- sharerCountSet(ulid, value): void
Parameters
- ulid: string
- value: number
Returns void
sharerRefRead
- sharerRefRead(path, sharer): Promise<number>
Parameters
- path: string
- sharer: string
Returns Promise<number>
sharersRead
- sharersRead(path): Promise<string[]>
Returns Promise<string[]>
ulidLookup
- ulidLookup(path, owner?): string
Parameters
- path: string
Optional
owner: string
Returns string
updateExistingPostFile
- updateExistingPostFile(ulid, location, meta): Promise<MsgPostFile>
Returns Promise<MsgPostFile>
viewerLookup
- viewerLookup(ulid, index?): Promise<Record<string, string>>
Parameters
- ulid: string
Optional
index: number
Returns Promise<Record<string, string>>
viewerSave
- viewerSave(ulid, access, index?): void
Parameters
- ulid: string
- access: Record<string, string>
Optional
index: number
Returns void