跳到主要内容
版本：3.0.3

小饼干模块

小饼干模块 - cookies​

提示
  • 此模块支持以 OpenAPI 方式独立调用。

列出所有的小饼干 (cookies.list)​

声明​

小饼干列表, 失败原因 = cookies.list([ 标识符 ])

参数及返回值​

  • 标识符
    • 文本型，可选，App 标识符，默认值为 com.apple.mobilesafari
  • 失败原因 文本型
  • 小饼干列表
    • 顺序表，其中的每个小饼干都是一个 关联表，结构如下：

小饼干结构​

{
  Name = "_UR",
  Path = "/",
  Domain = ".bing.com",
  Value = "QS=0&TQS=0",
  Expires = "2022-11-24T12:11:51Z",
  Secure = "false",
  Version = "0",
}

示例​

cookies.list
local cookies, err = cookies.list()
if err then
  nLog("错误：" .. err)
else
  for _, cookie in ipairs(cookies) do
    nLog(cookie.Name .. " = " .. cookie.Value)
  end
end

搜索小饼干 (cookies.filter)​

声明​

小饼干列表, 失败原因 = cookies.filter(路径, 域名[, 标识符])
小饼干列表, 失败原因 = cookies.filter {
  ID = 标识符,
  Path = 路径,
  Domain = 域名,
}

参数及返回值​

  • 路径 文本型
  • 域名 文本型
  • 标识符
    • 文本型，可选，App 标识符，默认值为 com.apple.mobilesafari
  • 失败原因 文本型
  • 小饼干列表
    • 顺序表，其中的每个小饼干都是一个 关联表，结构参见 小饼干结构

说明​

与 cookies.list 相同，但只返回与指定路径和域名匹配的小饼干。

  • 如果没有指定域名，则返回所有路径匹配的小饼干。
  • 如果指定的路径为空文本 ""，则返回所有域名匹配的小饼干。

示例​

cookies.filter
local cookies, err = cookies.filter('/', '.bing.com')  -- path, domain
--
local cookies, err = cookies.filter {
  Path = '/',
  Domain = '.bing.com',
}
if err then
  nLog("错误：" .. err)
else
  for _, cookie in ipairs(cookies) do
    nLog(cookie.Name .. " = " .. cookie.Value)
  end
end

获取小饼干 (cookies.get)​

声明​

小饼干, 失败原因 = cookies.get(名称[, 路径, 域名, 标识符])
小饼干, 失败原因 = cookies.get {
  ID = 标识符,
  Name = 名称,
  Path = 路径,
  Domain = 域名,
}

参数及返回值​

  • 名称 文本型
  • 路径 文本型
  • 域名 文本型
  • 标识符
    • 文本型，可选，App 标识符，默认值为 com.apple.mobilesafari
  • 失败原因 文本型
  • 小饼干
    • 关联表，结构参见 小饼干结构，如果没有找到匹配的小饼干则为 nil

说明​

返回第一个与指定名称、路径和域名匹配的小饼干。

示例​

cookies.get
local cookie, err = cookies.get('MSCC', '/', '.live.com')  -- name, path, domain
--
local cookie, err = cookies.get {
  Name = 'MSCC',
  Path = '/',
  Domain = '.live.com',
}

获取小饼干的值 (cookies.value)​

声明​

值, 失败原因 = cookies.value(名称[, 路径, 域名, 标识符])
值, 失败原因 = cookies.value {
  ID = 标识符,
  Name = 名称,
  Path = 路径,
  Domain = 域名,
}

参数及返回值​

  • 名称 文本型
  • 路径 文本型
  • 域名 文本型
  • 标识符
    • 文本型，可选，App 标识符，默认值为 com.apple.mobilesafari
  • 失败原因 文本型
  • 值
    • 文本型，小饼干 关联表 中 Value 键的值，如果没有找到则为 nil

说明​

此函数是 cookies.get 的进一步封装。
返回第一个与指定名称、路径和域名匹配的小饼干的 值。

示例​

cookies.value
local value, err = cookies.value('MUIDB', '/', 'bing.com')  -- name, path, domain
--
local value, err = cookies.value {
  Name = 'MUIDB',
  Path = '/',
  Domain = 'bing.com',
}

更新小饼干 (cookies.update)​

声明​

操作成败, 失败原因 = cookies.update(小饼干列表[, 标识符])
操作成败, 失败原因 = cookies.update(小饼干[, 标识符])

参数及返回值​

  • 小饼干列表
    • 顺序表，其中的每个小饼干都是一个 关联表，结构参见 小饼干结构
  • 小饼干
  • 标识符
    • 文本型，可选，App 标识符，默认值为 com.apple.mobilesafari
  • 失败原因 文本型
  • 操作成败 布尔型

说明​

更新指定的小饼干列表，列表中具有相同名称、路径和域名的小饼干将被替换。

示例​

cookies.update
local ok, err = cookies.update {
  {
    Name = 'MSCC',
    Path = '/',
    Domain = '.live.com',
    Value = '1234567890',
  },
  {
    Name = 'MUIDB',
    Path = '/',
    Domain = 'bing.com',
    Value = '0987654321',
  },
}
--
local ok, err = cookies.update {
  Name = 'MUIDB',
  Path = '/',
  Domain = 'bing.com',
  Value = '0987654321',
}

替换所有的小饼干 (cookies.replace)​

声明​

操作成败, 失败原因 = cookies.replace(小饼干列表[, 标识符])

参数及返回值​

  • 小饼干列表
    • 顺序表，其中的每个小饼干都是一个 关联表，结构参见 小饼干结构
  • 标识符
    • 文本型，可选，App 标识符，默认值为 com.apple.mobilesafari
  • 失败原因 文本型
  • 操作成败 布尔型

说明​

以传入的小饼干列表直接替换指定 App 的所有小饼干。

示例​

cookies.replace
local ok, err = cookies.replace {
  {
    Name = 'MSCC',
    Path = '/',
    Domain = '.live.com',
    Value = '1234567890',
  },
  {
    Name = 'MUIDB',
    Path = '/',
    Domain = 'bing.com',
    Value = '0987654321',
  },
}

删除小饼干 (cookies.remove)​

声明​

操作成败, 失败原因 = cookies.remove(名称[, 路径, 域名, 标识符])
操作成败, 失败原因 = cookies.remove {
  ID = 标识符,
  Name = 名称,
  Path = 路径,
  Domain = 域名,
}

参数及返回值​

  • 名称 文本型
  • 路径 文本型
  • 域名 文本型
  • 标识符
    • 文本型，可选，App 标识符，默认值为 com.apple.mobilesafari
  • 失败原因 文本型
  • 操作成败 布尔型

说明​

删除指定名称、路径和域名的小饼干。

  • 如果没有指定路径和域名，则删除所有名称匹配的小饼干。
  • 如果没有指定域名，则删除所有名称和路径匹配的小饼干。
  • 如果指定的名称为空文本 ""，则删除所有路径和域名匹配的小饼干。
  • 如果指定的名称和路径为空文本 ""，则删除所有域名匹配的小饼干。
  • 当且仅当指定的名称、路径或域名至少一项不为空文本 "" 且匹配时，才会删除小饼干。

示例​

cookies.remove
local ok, err = cookies.remove('MSCC', '/', '.live.com')
--
local ok, err = cookies.remove {
  Name = 'MSCC',
  Path = '/',
  Domain = '.live.com',
}

清空所有的小饼干 (cookies.clear)​

声明​

操作成败, 失败原因 = cookies.clear([ 标识符 ])

参数及返回值​

  • 标识符
    • 文本型，可选，App 标识符，默认值为 com.apple.mobilesafari
  • 失败原因 文本型
  • 操作成败 布尔型
警告

清空指定 App 的所有小饼干，谨慎使用。

最后于 更新