My favorites | 中文(简体) | Sign in

opensocial.Collection (v0.7)

 概述     详述

类 opensocial.Collection

具有实用存取器的多个对象的集合。还可以代表较大集合的子集(例如,第 1 页,共 10 页)并包含有关该较大集合的信息。

方法概述

 Array.<Object> asArray()
返回该集合中所有对象的数组。
each(fn)
对该集合的每个成员都执行一次提供的函数功能(根据函数的参数对每个成员轮流执行)。
 Object? getById(id)
查找具有指定 ID 值的条目,如果找不到任何条目,则返回 Null。
 Number getOffset()
获取该集合在较大结果集中的偏移。
 Number getTotalSize()
获取该集合所属的较大结果集的总大小。
 Number size()
获取该集合的大小,该大小等于或小于结果的总大小。
 

方法详述

asArray

Array.<Object> asArray()
    返回该集合中所有对象的数组。
    返回:
      Array.<Object> 该集合中的值

每个

each(fn)
    对该集合的每个成员都执行一次提供的函数功能(根据函数的参数对每个成员轮流执行)。
    参数:
      Function fn - 要通过每个集合条目调用的函数

getById

Object? getById(id)
    查找具有指定 ID 值的条目,如果找不到任何条目,则返回 Null。
    参数:
      String id - 要查找的 ID
    返回:
      Object? 数据

getOffset

Number getOffset()
    获取该集合在较大结果集中的偏移。
    返回:
      Number 在总集合中的偏移

getTotalSize

Number getTotalSize()
    获取该集合所属的较大结果集的总大小。
    返回:
      Number 结果的总大小

大小

Number size()
    获取该集合的大小,该大小等于或小于结果的总大小。
    返回:
      Number 该集合的大小

文档由 JsDoc Toolkit 1.3.3 生成