Skip to main content
Function Signature
Parameters
  • clientId: The client ID for the Google Drive integration. Obtained from Google Cloud Console.
  • backupOption: An option from the GDriveBackupOption enum that specifies the backup/recover storage type:
    • .appDataFolder: Stores backups in the hidden, app-specific “App Data Folder” in Google Drive. This folder is not visible to the user.
    • .appDataFolderWithFallback: Attempts to store backups and recover using the “App Data Folder”. If recovery fails, it automatically falls back to a user-visible Google Drive folder.
    • .gdriveFolder(folderName: String): Stores backups in a user-visible folder in Google Drive with the specified folderName.
Important Notes
  • The appDataFolder and appDataFolderWithFallback options are supported starting from SDK version 4.2.0
  • Those options cannot be used with an earlier SDK version, backups stored in the App Data Folder will be lost
  • Choose the appropriate backup option based on your application’s requirements:
    • Use appDataFolder to keep wallet backups hidden from users (recommended)
    • Use gdriveFolder to allow wallet backups to be seen and modified by the user
  • Each option requests only the Drive OAuth scopes it needs (SDK version 7.4.0 and later):
    • .appDataFolder requests https://www.googleapis.com/auth/drive.appdata
    • .appDataFolderWithFallback requests https://www.googleapis.com/auth/drive.appdata and https://www.googleapis.com/auth/drive.file
    • .gdriveFolder(folderName:) requests https://www.googleapis.com/auth/drive.file
  • Switching a signed-in user to an option that needs a scope they have not granted triggers a one-time incremental consent prompt on the next backup or recovery.
  • To clear the stored Google session and force a fresh sign-in (for example to let the user switch Google accounts), call gDriveSignOut.
Example Usage
Related Documentation For more information about Google Drive integration, see: