Interface RequestType

Hierarchy

  • RequestType

Properties

checkCapability createActionFile createBareFile createCapability createFolder createIndexFile deleteDataUnion deleteFolder encryptContent executeLitAction generateFileKey getAppCacao getAppSessionKey getModelBaseInfo getPKP getUserStorageSpace getValidAppCaps isFileUnlocked loadActionFilesByDataUnionId loadActionFilesByFileId loadBareFileContent loadDataUnionById loadFile loadFilesBy loadFolderTrees loadFoldersBy monetizeFile monetizeFolder moveFiles removeFiles signWithSessionKey unlockFile updateActionFile updateBareFile updateDataUnionBaseInfo updateFolderBaseInfo updateIndexFile

Properties

checkCapability

checkCapability: {
    appId: string;
    resource?: CERAMIC;
}

Type declaration

  • appId: string
  • Optional resource?: CERAMIC

createActionFile

createActionFile: {
    action: Action;
    fileName?: string;
    folderId?: string;
    relationId: string;
}

Type declaration

  • action: Action
  • Optional fileName?: string
  • Optional folderId?: string
  • relationId: string

createBareFile

createBareFile: {
    encrypted?: boolean;
    fileBase64: string;
    fileName: string;
    folderId?: string;
    storageProvider: StorageProvider;
}

Type declaration

  • Optional encrypted?: boolean
  • fileBase64: string
  • fileName: string
  • Optional folderId?: string
  • storageProvider: StorageProvider

createCapability

createCapability: {
    appId: string;
    resource?: CERAMIC;
}

Type declaration

  • appId: string
  • Optional resource?: CERAMIC

createFolder

createFolder: {
    folderDescription?: string;
    folderName: string;
    folderType?: FolderType;
    signals?: Signal[];
}

Type declaration

  • Optional folderDescription?: string
  • folderName: string
  • Optional folderType?: FolderType
  • Optional signals?: Signal[]

createIndexFile

createIndexFile: {
    encryptedContent?: object;
    fileContent: FileContent;
    fileName?: string;
    folderId?: string;
    keyHandler?: string;
    modelId: string;
}

Type declaration

  • Optional encryptedContent?: object
  • fileContent: FileContent
  • Optional fileName?: string
  • Optional folderId?: string
  • Optional keyHandler?: string
  • modelId: string

deleteDataUnion

deleteDataUnion: {
    dataUnionId: string;
    syncImmediately?: boolean;
}

Type declaration

  • dataUnionId: string
  • Optional syncImmediately?: boolean

deleteFolder

deleteFolder: {
    folderId: string;
    syncImmediately?: boolean;
}

Type declaration

  • folderId: string
  • Optional syncImmediately?: boolean

encryptContent

encryptContent: {
    content: object;
    keyHandler: string;
}

Type declaration

  • content: object
  • keyHandler: string

executeLitAction

executeLitAction: {
    code: string;
    jsParams: object;
}

Type declaration

  • code: string
  • jsParams: object

generateFileKey

generateFileKey: void

getAppCacao

getAppCacao: void

getAppSessionKey

getAppSessionKey: void

getModelBaseInfo

getModelBaseInfo: string

getPKP

getPKP: void

getUserStorageSpace

getUserStorageSpace: void

getValidAppCaps

getValidAppCaps: void

isFileUnlocked

isFileUnlocked: string

loadActionFilesByDataUnionId

loadActionFilesByDataUnionId: string

loadActionFilesByFileId

loadActionFilesByFileId: string

loadBareFileContent

loadBareFileContent: string

loadDataUnionById

loadDataUnionById: string

loadFile

loadFile: string

loadFilesBy

loadFilesBy: {
    fileIds?: string[];
    modelId?: string;
    pkh?: string;
}

Type declaration

  • Optional fileIds?: string[]
  • Optional modelId?: string
  • Optional pkh?: string

loadFolderTrees

loadFolderTrees: void

loadFoldersBy

loadFoldersBy: {
    folderIds?: string[];
    signal?: Signal;
}

Type declaration

  • Optional folderIds?: string[]
  • Optional signal?: Signal

monetizeFile

monetizeFile: {
    encryptionProvider?: EncryptionProvider;
    fileId: string;
    monetizationProvider: MonetizationProvider;
}

Type declaration

monetizeFolder

monetizeFolder: {
    folderId: string;
    monetizationProvider: MonetizationProvider;
}

Type declaration

moveFiles

moveFiles: {
    fileIds: string[];
    syncImmediately?: boolean;
    targetFolderId: string;
}

Type declaration

  • fileIds: string[]
  • Optional syncImmediately?: boolean
  • targetFolderId: string

removeFiles

removeFiles: {
    fileIds: string[];
    syncImmediately?: boolean;
}

Type declaration

  • fileIds: string[]
  • Optional syncImmediately?: boolean

signWithSessionKey

signWithSessionKey: string | object

unlockFile

unlockFile: string

updateActionFile

updateActionFile: {
    fileId: string;
    fileName?: string;
    isCommentEncrypted?: boolean;
    isRelationIdEncrypted?: boolean;
    syncImmediately?: boolean;
}

Type declaration

  • fileId: string
  • Optional fileName?: string
  • Optional isCommentEncrypted?: boolean
  • Optional isRelationIdEncrypted?: boolean
  • Optional syncImmediately?: boolean

updateBareFile

updateBareFile: {
    encrypted?: boolean;
    fileBase64?: string;
    fileId: string;
    fileName?: string;
    storageProvider?: StorageProvider;
    syncImmediately?: boolean;
}

Type declaration

  • Optional encrypted?: boolean
  • Optional fileBase64?: string
  • fileId: string
  • Optional fileName?: string
  • Optional storageProvider?: StorageProvider
  • Optional syncImmediately?: boolean

updateDataUnionBaseInfo

updateDataUnionBaseInfo: {
    dataUnionDescription?: string;
    dataUnionId: string;
    dataUnionName: string;
    syncImmediately?: boolean;
}

Type declaration

  • Optional dataUnionDescription?: string
  • dataUnionId: string
  • dataUnionName: string
  • Optional syncImmediately?: boolean

updateFolderBaseInfo

updateFolderBaseInfo: {
    folderDescription?: string;
    folderId: string;
    folderName?: string;
    syncImmediately?: boolean;
}

Type declaration

  • Optional folderDescription?: string
  • folderId: string
  • Optional folderName?: string
  • Optional syncImmediately?: boolean

updateIndexFile

updateIndexFile: {
    encryptedContent?: object;
    fileContent?: FileContent;
    fileId: string;
    fileName?: string;
    keyHandler?: string;
    syncImmediately?: boolean;
}

Type declaration

  • Optional encryptedContent?: object
  • Optional fileContent?: FileContent
  • fileId: string
  • Optional fileName?: string
  • Optional keyHandler?: string
  • Optional syncImmediately?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc