Group

Group

群组类。包含了多个联系人的集合。

Constructor

new Group(service, owner, idopt, nameopt, domainopt)

Parameters:
Name Type Attributes Description
service ContactService

联系人服务。
owner Contact

群组的所有人。
id number <optional>

群组的 ID 。
name string <optional>

群组的名称。
domain string <optional>

群组的所在的域。

Extends

Classes

Group

Members

(protected) appendix :GroupAppendix

群组的附录。

Type:

CacheDuration

Overrides:

缓存持续时长。

context :JSON

Overrides:

关联的上下文信息。

Type:
  • JSON

(protected) creationTime :number

创建时间。

Type:
  • number

expiry :number

Overrides:

有效期。

Type:
  • number

(protected) id :number

Overrides:

实体 ID 。

Type:
  • number

last :number

Overrides:

上一次更新数据的时间戳。

Type:
  • number

(protected) lastActiveTime :number

活跃时间。

Type:
  • number

Lifespan

Overrides:

数据生命周期。

(protected) memberIdList :Array.<number>

群成员 ID 列表。

Type:
  • Array.<number>

(protected) moduleName :string

Overrides:

模块名称。

Type:
  • string

(protected) owner :Contact

群组的所有人。

Type:

(protected) ownerId :number

群主的 ID 。

Type:
  • number

(protected) service :ContactService

联系人服务对象。

Type:

(protected) state :number

群组状态。

Type:
  • number

(protected) tag :string

群组的标签。

Type:
  • string

timestamp :number

Overrides:

数据时间戳。

Type:
  • number

Methods

addMembers(members, handleSuccessopt, handleFailureopt) → {boolean}

添加群组成员。

Parameters:
Name Type Attributes Description
members Array.<(Contact|number)>

指定群组成员或者群组成员 ID 。
handleSuccess function <optional>

操作成功回调该方法，参数：(group:Group, members:Array<Contact>, operator:Contact) 。
handleFailure function <optional>

操作失败回调该方法，参数：(error:ModuleError) 。
Returns:

返回是否能执行该操作。

Type
boolean

changeOwner(newOwner, handleSuccessopt, handleFailureopt) → {boolean}

修改群主。

Parameters:
Name Type Attributes Description
newOwner Contact

指定新群组。
handleSuccess function <optional>

操作成功回调该方法，参数：(group:Group) 。
handleFailure function <optional>

操作失败回调该方法，参数：(error:ModuleError) 。
Returns:

返回是否能执行该操作。

Type
boolean

getAppendix() → {GroupAppendix}

获取群组的附录。

Returns:

返回群组的附录。

Type
GroupAppendix

getContext() → {JSON}

Overrides:

获取关联的上下文。

Returns:

返回关联的上下文数据。

Type
JSON

getCreationTime() → {number}

获取群组的创建时间。

Returns:

返回群组的创建时间。

Type
number

getDomain() → {string}

Overrides:

获取联系人所在域。

Returns:

返回联系人所在域。

Type
string

getExpiry() → {number}

Overrides:

获取数据的有效期。

Returns:

返回数据的有效期。

Type
number

getId() → {number}

Overrides:

获取联系人 ID 。

Returns:

返回联系人 ID 。

Type
number

getLast() → {number}

Overrides:

获取最近一次更新数据的时间戳。

Returns:

返回最近一次更新数据的时间戳。

Type
number

getLastActiveTime() → {number}

获取群组的活跃时间。

Returns:

返回群组的活跃时间。

Type
number

getMemberById(memberId, handler)

获取指定 ID 的成员。

Parameters:
Name Type Description
memberId number

指定成员 ID 。
handler function

指定数据回调句柄，参数：(contact:Contact) 。

getMemberIds() → {Array.<long>}

获取群组的成员 ID 清单。

Returns:

返回群组成员列表，该列表为群组列表的副本。

Type
Array.<long>

getMemberName(member) → {string}

获取成员名称。以优先显示方式进行显示。

Parameters:
Name Type Description
member Contact
Returns:

返回优先的成员名称。

Type
string

getMembers(handler)

获取群组的所有成员。

Parameters:
Name Type Description
handler function

回调成员数据清单，参数：(list:Array<Contact>, group:Group) 。

getName() → {string}

Overrides:

获取联系人名称。

Returns:

返回联系人名称。

Type
string

getNamePinYin() → {string}

Overrides:

获取名字的拼音格式。

Returns:

返回名字的拼音格式。

Type
string

getOwner() → {Contact}

获取群组的所有者。

Returns:

返回群组的所有者。

Type
Contact

getState() → {number}

获取群组的状态。群组状态由 GroupState 描述。

Returns:

返回状态描述码 GroupState 。

Type
number

getTimestamp() → {number}

Overrides:

获取数据时间戳。

Returns:

返回数据时间戳。

Type
number

hasMember(contact) → {boolean}

是否包含该成员。

Parameters:
Name Type Description
contact Contact | number

指定成员。
Returns:

返回 true 表示群组里包含该成员。

Type
boolean

isOverdue() → {boolean}

Overrides:

数据是否已经超期。

Returns:

如果超期返回 true ，否则返回 false 。

Type
boolean

isOwner(contactopt) → {boolean}

判断指定联系人是否是该群所有者。

Parameters:
Name Type Attributes Description
contact Contact | number <optional>

指定联系人，当不指定联系人时，判断该群是否是当前联系人所有。
Returns:

如果联系人是群主返回 true 。

Type
boolean

isValid() → {boolean}

Overrides:

数据是否在有效期内。

Returns:

如果有效返回 true ，否则返回 false 。

Type
boolean

listMembers(handler)

列出所有成员数据。

Parameters:
Name Type Description
handler function

回调成员数据清单，参数：(list:Array<Contact>, group:Group) 。

modifyContext(context, handleSuccessopt, handleFailureopt) → {boolean}

修改群组上下文数据。

Parameters:
Name Type Attributes Description
context JSON | object

指定新的上下文数据。
handleSuccess function <optional>

操作成功回调该方法，参数：(group:Group) 。
handleFailure function <optional>

操作失败回调该方法，参数：(error:ModuleError) 。
Returns:

返回是否能执行该操作。

Type
boolean

modifyMember(member)

修改群组成员数据。该方法仅改变本地数据。

Parameters:
Name Type Description
member number

成员的联系人实例。

modifyName(name, handleSuccessopt, handleFailureopt) → {boolean}

修改群组名称。

Parameters:
Name Type Attributes Description
name string

指定新的群组名称。
handleSuccess function <optional>

操作成功回调该方法，参数：(group:Group) 。
handleFailure function <optional>

操作失败回调该方法，参数：(error:ModuleError) 。
Returns:

返回是否能执行该操作。

Type
boolean

numMembers() → {number}

获取群成员数量。

Returns:

返回群成员数量。

Type
number

removeMembers(members, handleSuccessopt, handleFailureopt) → {boolean}

移除群组成员。

Parameters:
Name Type Attributes Description
members Array.<(Contact|number)>

指定群组成员或者群组成员 ID 。
handleSuccess function <optional>

操作成功回调该方法，参数：(group:Group, members:Array<Contact>, operator:Contact) 。
handleFailure function <optional>

操作失败回调该方法，参数：(error:ModuleError) 。
Returns:

返回是否能执行该操作。

Type
boolean

resetUpdateTime(time)

Overrides:

重置更新时间。

Parameters:
Name Type Description
time number

更新时间。

setContext(context)

Overrides:

设置关联的上下文。

Parameters:
Name Type Description
context JSON

指定上下文数据。

setName(name)

Overrides:

设置联系人名称。

Parameters:
Name Type Description
name string

指定联系人名称。

toCompactJSON() → {JSON}

Overrides:

将对象序列化为数据内容紧凑的 JSON 格式。

Returns:

返回紧凑结构的 JSON 数据，数据里只包含基础的联系人数据。

Type
JSON

toJSON()

Overrides: