iCloud.docEvict()

概述

向系统发出信号，表示文件不会立即需要（用于访问）。该文件不会从 iCloud 存储中删除 — 仍可以通过 iCloud.docRead() 在 iCloud 中访问，但访问速度会慢得多。

将文件标记为要驱逐时，此方法会通过 iCloudDocEvent 调用 onComplete 侦听器函数，而不是在实际删除本地文件时调用。

语法

iCloud.docEvict( params )

参数参考

params 表的有效键包括

• filename — 必需；要驱逐的文件。

• onComplete — 必需 侦听器 函数，将通过 iCloudDocEvent 调用。

• containerId — 可选 字符串 值，用于指示要用于存储文档的特定 iCloud 容器。如果您的应用程序仅与一个 iCloud 容器关联，不要传递此参数。

示例

local function docListener( event )

    if event.isError then
        print( event.error )
        print( event.errorCode )
    end
end

iCloud.docEvict(
    {
        filename = "test.txt",
        onComplete = docListener
    }
)