云列表。

Hierarchy (view full)

Properties

添加尾项信号,当云列表添加尾项时触发此信号。

添加尾项消息类型详见 KittenCloudListPushMessageObject

添加首项信号,当云列表添加首项时触发此信号。

添加首项消息类型详见 KittenCloudListUnshiftMessageObject

添加项到指定位置信号,当云列表添加项到指定位置时触发此信号。

添加项到指定位置消息类型详见 KittenCloudListAddMessageObject

移除最后一项信号,当云列表删除最后一项时触发此信号。

移除最后一项消息类型详见 KittenCloudListPopMessageObject

移除指定项信号,当云列表删除指定项时触发此信号。

移除指定项消息类型详见 KittenCloudListRemoveMessageObject

清空信号,当云列表清空时触发此信号。

清空消息类型详见 KittenCloudListEmptyMessageObject

替换最后一项信号,当云列表替换最后一项时触发此信号。

替换最后一项消息类型详见 KittenCloudListReplaceLastMessageObject

替换指定项信号,当云列表替换指定项时触发此信号。

替换指定项消息类型详见 KittenCloudListReplaceMessageObject

替换所有项信号,当云列表替换所有项时触发此信号。

替换所有项消息类型详见 KittenCloudListReplaceAllMessageObject

autoReconnectIntervalTime: SingleConfig<KittenCloudAutoReconnectIntervalTime>

自动重连间隔时间(毫秒),填 false 表示禁用自动重连。

默认值:8000

localPreupdate: SingleConfig<boolean>

本地预更新。

在没有开启本地预更新时,每次在本地执行数据更新操作时,都会等到该操作同步到云端并收到来自服务器的反馈后再更新本地的数据,这与普通的变量在修改后立即更新其值并不相同。

开启本地预更新后,本地执行数据更新操作时,会假定该操作同步到云端之前没有其它用户对该数据进行操作,并基于此提前更新本地的数据,如果假定不成立,则会修正本地数据。具体而言,本地执行数据更新操作时,会立即更新本地的数据,如果在当前操作被同步到云端之前收到了来自服务器的反馈的其它更新数据,则会撤销本地对数据的更改,并执行来自云端的更改,最后再执行本地对数据的更改。

默认值:对于云变量开启,对于云列表关闭。

cacheTime: SingleConfig<KittenCloudCacheTime>

缓存时间(毫秒),填 false 表示绝对关闭。

默认值:0

uploadIntervalTime: SingleConfig<KittenCloudUploadIntervalTime>

上传间隔时间(毫秒),填 false 表示绝对关闭。

默认值:对于私有云变量为 1500,对于其它为 0

私有云变量的上传间隔时间必须不少于 1500 毫秒。

uploadTimeout: SingleConfig<number>

上传超时时间(毫秒),填 0 表示永不超时。

默认值:4000

stringLengthLimit: SingleConfig<number>

字符串长度限制,字符串量的长度不能超过此限制,超出部分会被丢弃。

默认值:1024

字符串长度限制必须不大于 1024.

listLengthLimit: SingleConfig<number>

列表长度限制,列表的长度不能超过此限制,超出部分会被丢弃。

默认值:1000。

列表长度限制必须不大于 1000

Accessors

  • get length(): number
  • 获取云列表的长度。

    Returns number

    云列表的长度

Methods

  • 添加新的项到云列表尾部。

    Parameters

    Returns Promise<void>

  • 添加新的项到云列表头部。

    Parameters

    Returns Promise<void>

  • 添加新的项到云列表指定位置。

    Parameters

    Returns Promise<void>

  • 移除云列表最后一项。

    Parameters

    • this: this

    Returns Promise<void>

  • 移除云列表指项。

    Parameters

    • index: number

      位置索引,从 0 开始

    Returns Promise<void>

  • 清空云列表。

    Parameters

    • this: this

    Returns Promise<void>

  • 替换云列表最后一项。

    Parameters

    Returns Promise<void>

  • 替换云列表指定项。

    Parameters

    Returns Promise<void>

  • 从源列表复制所有项到云列表。

    该操作会对比源列表和云列表,并将差异应用到云列表。

    Parameters

    Returns Promise<void>

  • 获取云列表指定位置的项。

    Parameters

    • this: this
    • index: number

      位置索引,从 0 开始

    Returns None | KittenCloudListItemValue

    指定位置的项,如果索引越界则返回 None

  • 获取指定项在云列表中第一次出现的位置。

    Parameters

    Returns number

    指定项在云列表中第一次出现的位置,如果不存在则返回 -1

  • 获取指定项在云列表中最后一次出现的位置。

    Parameters

    Returns number

    指定项在云列表中最后一次出现的位置,如果不存在则返回 -1

  • 判断指定项是否在云列表中。

    Parameters

    Returns boolean

    指定项是否在云列表中

  • 用指定字符串连接云列表中的所有项。

    Parameters

    • this: this
    • separator: string

      项之间的分隔符

    Returns string

    连接后的字符串