Cube for Javascript

GroupAppendix

群组附录。

FIXME 2021-11-17 XJW 增加了 following 属性

Constructor

new GroupAppendix(service, group)

Parameters:

Name	Type	Description
`service`	ContactService
`group`	Group

Classes

GroupAppendix

Methods

(static) create(service, group, json) → {GroupAppendix}

创建群组附录实例。

Parameters:

Name	Type	Description
`service`	ContactService
`group`	Group
`json`	JSON

Returns:

Type: GroupAppendix

getCommId(handleSuccess, handleFailure) → {number}

获取当前通讯 ID 。

Parameters:

Name	Type	Description
`handleSuccess`	function
`handleFailure`	function

Returns:

当 handleSuccess 和 handleFailure 返回当前通讯 ID 。

Type: number

getMemberRemark(member) → {string}

获取群组成员的备注。

Parameters:

Name	Type	Description
`member`	Contact \| number	指定群成员或者成员 ID 。

Returns:

返回群组成员的备注。

Type: string

getNotice() → {string}

获取群的公告。

Returns:

返回群的公告。

Type: string

getRemark() → {string}

获取群的备注信息。

Returns:

返回群的备注信息。

Type: string

hasMemberRemark(member) → {boolea}

是否备注了指定成员。

Parameters:

Name	Type	Description
`member`	Contact \| number	指定群成员或者成员 ID 。

Returns:

如果有该成员的备注，返回 true 。

Type: boolea

hasRemark() → {boolean}

是否设置了群的备注。

Returns:

如果设置了备注名返回 true 。

Type: boolean

toCompactJSON()

toJSON()

updateCommId(id, handleSuccessopt, handleFailureopt)

更新群组对应的通讯 ID 。

Parameters:

Name	Type	Attributes	Description
`id`	number		指定通讯 ID 。
`handleSuccess`	function	<optional>	成功回调。参数：(`appendix`:GroupAppendix) 。
`handleFailure`	function	<optional>	失败回调。参数：(`error`:ModuleError) 。

updateMemberRemark(member, remark, handleSuccessopt, handleFailureopt)

更新群组成员备注。

Parameters:

Name	Type	Attributes	Description
`member`	Contact \| number		指定群成员。
`remark`	string		指定群成员的备注。
`handleSuccess`	function	<optional>	成功回调。参数：(`appendix`:GroupAppendix) 。
`handleFailure`	function	<optional>	失败回调。参数：(`error`:ModuleError) 。

updateNotice(notice, handleSuccessopt, handleFailureopt)

更新公告信息。

Parameters:

Name	Type	Attributes	Description
`notice`	string		新的群组公告。
`handleSuccess`	function	<optional>	成功回调。参数：(`appendix`:GroupAppendix) 。
`handleFailure`	function	<optional>	失败回调。参数：(`error`:ModuleError) 。

updateRemark(content, handleSuccessopt, handleFailureopt)

更新备注信息。

Parameters:

Name	Type	Attributes	Description
`content`	string		新的备注信息。
`handleSuccess`	function	<optional>	成功回调。参数：(`appendix`:GroupAppendix) 。
`handleFailure`	function	<optional>	失败回调。参数：(`error`:ModuleError) 。