iCloud.recordAccountStatus()

Overview

Passes the user’s CloudKit account status to the onComplete listener function as iCloudRecordEvent.status.

Syntax

iCloud.recordAccountStatus( params )

Parameter Reference

Valid keys for the params table include:

• onComplete — Required listener function to be invoked with an iCloudRecordEvent.

Event Values

The onComplete listener function will receive iCloudRecordEvent.status as one of following constants:

• "ok" — The user’s iCloud account is available and may be used by the app.

• "restricted" — The user’s iCloud account is not available. Access was denied due to Parental Controls or Mobile Device Management restrictions.

• "noAccount" — The user’s iCloud account is not available because no account information has been provided for the device.

• "error" — An error occurred during an attempt to retrieve the account status.

Example

local function checkCloudKit( event )

    if event.status == "ok" then
        -- CloudKit ready!
    end
end

iCloud.recordAccountStatus(
    {
        onComplete = checkCloudKit
    }
)