iCloud.docList()

Type Function

Return value none

Revision Release 2024.3703

Keywords iCloud, sync, storage, document, docList

See also iCloud.docCheck()

iCloudDocEvent

iCloud.*

Overview

Retrieves list of files in iCloud Documents storage and invokes the onComplete listener function with an iCloudDocEvent upon completion.

Syntax

iCloud.docList( params )

params _^(required)

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

Parameter Reference

Valid keys for the params table include:

onComplete — Required listener function to be invoked with an iCloudDocEvent.
containerId — Optional string value indicating a specific iCloud Container to be used for document storage. Do not pass this parameter if you have only one iCloud Container associated with your app.

Example

local function docListener( event )

    if event.files then
        for i = 1,#event.files do
            print( event.files[i] )
        end
    end
end

iCloud.docList( { onComplete=docListener } )