iCloud.docList()

Type Function
Return value none
Revision Current Public Release (2018.3326)
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:

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 } )