Interface iCloudServiceSetupOptions

These are the options that can be passed to the iCloud service constructor.

Hierarchy

  • iCloudServiceSetupOptions

Properties

authMethod? dataDirectory? logger? password? saveCredentials? trustDevice? username?

Properties

Optional authMethod

authMethod?: "legacy" | "srp"

The authentication method to use. Currently defaults to 'legacy', however this may change in the future.

Default

"legacy"

Optional dataDirectory

dataDirectory?: string

The directory to store the trust-token in. Defaults to the ~/.icloud directory.

Optional logger

logger?: "Debug" | "Info" | "Warning" | "Error" | "Silent" | ((level: number, ...args: any[]) => void)

Log level to use. Alternatively pass in a function that will recieve all log messages instead of being forwarded to console

Default

LogLevel.Debug

Optional password

password?: string

The password of the iCloud account to log in to. Can be provided now (at construction time) or later (on iCloudService#authenticate).

Optional saveCredentials

saveCredentials?: boolean

Whether to save the credentials to the system's secret store. (i.e. Keychain on macOS)

Optional trustDevice

trustDevice?: boolean

Whether to store the trust-token to disk. This allows future logins to be done without MFA.

Optional username

username?: string

The username of the iCloud account to log in to. Can be provided now (at construction time) or later (on iCloudService#authenticate).

Settings

Member Visibility

Theme

Generated using TypeDoc