iCloud.recordAccountStatus()

Type Function
Return value none
Revision Release 2024.3703
Keywords iCloud, sync, storage, CloudKit, recordAccountStatus
See also iCloudRecordEvent.status
iCloudRecordEvent
iCloud.*

Overview

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

Syntax

iCloud.recordAccountStatus( params )
params (required)

Table. Table containing method-specific parameters — see the next section for details.

Parameter Reference

Valid keys for the params table include:

Event Values

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

Example

local function checkCloudKit( event )

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

iCloud.recordAccountStatus(
    {
        onComplete = checkCloudKit
    }
)