Skip to main content

Interface: CloudServiceContract

Defined in: src/services/CloudService.ts:39

Contract describing the renderer-facing cloud service surface.

Propertiesโ€‹

clearEncryptionKey()โ€‹

clearEncryptionKey: () => Promise<CloudStatusSummary>

Defined in: src/services/CloudService.ts:40

Returnsโ€‹

Promise<CloudStatusSummary>


configureFilesystemProvider()โ€‹

configureFilesystemProvider: (config: CloudFilesystemProviderConfig) => Promise<CloudStatusSummary>

Defined in: src/services/CloudService.ts:41

Parametersโ€‹

configโ€‹

CloudFilesystemProviderConfig

Returnsโ€‹

Promise<CloudStatusSummary>


connectDropbox()โ€‹

connectDropbox: () => Promise<CloudStatusSummary>

Defined in: src/services/CloudService.ts:44

Returnsโ€‹

Promise<CloudStatusSummary>


deleteBackup()โ€‹

deleteBackup: (key: string) => Promise<CloudBackupEntry[]>

Defined in: src/services/CloudService.ts:45

Parametersโ€‹

keyโ€‹

string

Returnsโ€‹

Promise<CloudBackupEntry[]>


disconnect()โ€‹

disconnect: () => Promise<CloudStatusSummary>

Defined in: src/services/CloudService.ts:46

Returnsโ€‹

Promise<CloudStatusSummary>


enableSync()โ€‹

enableSync: (config: CloudEnableSyncConfig) => Promise<CloudStatusSummary>

Defined in: src/services/CloudService.ts:47

Parametersโ€‹

configโ€‹

CloudEnableSyncConfig

Returnsโ€‹

Promise<CloudStatusSummary>


getStatus()โ€‹

getStatus: () => Promise<CloudStatusSummary>

Defined in: src/services/CloudService.ts:48

Returnsโ€‹

Promise<CloudStatusSummary>


initialize()โ€‹

initialize: () => Promise<void>

Defined in: src/services/CloudService.ts:49

Returnsโ€‹

Promise<void>


listBackups()โ€‹

listBackups: () => Promise<CloudBackupEntry[]>

Defined in: src/services/CloudService.ts:50

Returnsโ€‹

Promise<CloudBackupEntry[]>


migrateBackups()โ€‹

migrateBackups: (config: CloudBackupMigrationRequest) => Promise<CloudBackupMigrationResult>

Defined in: src/services/CloudService.ts:51

Parametersโ€‹

configโ€‹

CloudBackupMigrationRequest

Returnsโ€‹

Promise<CloudBackupMigrationResult>


previewResetRemoteSyncState()โ€‹

previewResetRemoteSyncState: () => Promise<CloudSyncResetPreview>

Defined in: src/services/CloudService.ts:54

Returnsโ€‹

Promise<CloudSyncResetPreview>


requestSyncNow()โ€‹

requestSyncNow: () => Promise<void>

Defined in: src/services/CloudService.ts:55

Returnsโ€‹

Promise<void>


resetRemoteSyncState()โ€‹

resetRemoteSyncState: () => Promise<CloudSyncResetResult>

Defined in: src/services/CloudService.ts:56

Returnsโ€‹

Promise<CloudSyncResetResult>


restoreBackup()โ€‹

restoreBackup: (key: string) => Promise<SerializedDatabaseRestoreResult>

Defined in: src/services/CloudService.ts:57

Parametersโ€‹

keyโ€‹

string

Returnsโ€‹

Promise<SerializedDatabaseRestoreResult>


setEncryptionPassphrase()โ€‹

setEncryptionPassphrase: (passphrase: string) => Promise<CloudStatusSummary>

Defined in: src/services/CloudService.ts:58

Parametersโ€‹

passphraseโ€‹

string

Returnsโ€‹

Promise<CloudStatusSummary>


uploadLatestBackup()โ€‹

uploadLatestBackup: () => Promise<CloudBackupEntry>

Defined in: src/services/CloudService.ts:61

Returnsโ€‹

Promise<CloudBackupEntry>