Skip to Content
SdkReactInternalInterfacesUseICloudBackupResult

UseICloudBackupResult

Defined in: src/react/useICloudBackup.ts:43 

Result returned by useICloudBackup hook

Properties

backup()

backup: (options?: object) => Promise<ICloudExportResult | { error: string; }>

Defined in: src/react/useICloudBackup.ts:45 

Backup all conversations to iCloud

Parameters

ParameterType

options?

object

options.onProgress?

(current: number, total: number) => void

Returns

Promise<ICloudExportResult | { error: string; }>


isAuthenticated

isAuthenticated: boolean

Defined in: src/react/useICloudBackup.ts:55 

Whether user has signed in to iCloud


isAvailable

isAvailable: boolean

Defined in: src/react/useICloudBackup.ts:57 

Whether CloudKit JS is available


isConfigured

isConfigured: boolean

Defined in: src/react/useICloudBackup.ts:53 

Whether iCloud is configured


restore()

restore: (options?: object) => Promise<ICloudImportResult | { error: string; }>

Defined in: src/react/useICloudBackup.ts:49 

Restore conversations from iCloud

Parameters

ParameterType

options?

object

options.onProgress?

(current: number, total: number) => void

Returns

Promise<ICloudImportResult | { error: string; }>

Last updated on