me.chanjar.weixin.cp.api.impl

类 WxCpTagServiceImpl

java.lang.Object

me.chanjar.weixin.cp.api.impl.WxCpTagServiceImpl

所有已实现的接口:

WxCpTagService

public class WxCpTagServiceImpl
extends Object
implements WxCpTagService

  标签管理接口.
 Created by Binary Wang on 2017-6-25.
 

作者:

Binary Wang

构造器概要

构造器

构造器和说明
WxCpTagServiceImpl()

方法概要

限定符和类型	方法和说明
WxCpTagAddOrRemoveUsersResult	addUsers2Tag(String tagId, List<String> userIds, List<String> partyIds) 增加标签成员.
String	create(String tagName) 创建标签.
String	create(String name, Integer id) 创建标签.
void	delete(String tagId) 删除标签.
WxCpTagGetResult	get(String tagId) 获取标签成员.
List<WxCpTag>	listAll() 获得标签列表.
List<WxCpUser>	listUsersByTagId(String tagId) 获取标签成员.
WxCpTagAddOrRemoveUsersResult	removeUsersFromTag(String tagId, List<String> userIds, List<String> partyIds) 移除标签成员.
void	update(String tagId, String tagName) 更新标签.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

WxCpTagServiceImpl

public WxCpTagServiceImpl()

方法详细资料

create

public String create(String name,
                     Integer id)
              throws WxErrorException

从接口复制的说明: WxCpTagService

创建标签.

 请求地址：https://qyapi.weixin.qq.com/cgi-bin/tag/create?access_token=ACCESS_TOKEN
 文档地址：https://work.weixin.qq.com/api/doc#90000/90135/90210
 

指定者:

create 在接口中 WxCpTagService

参数:

name - 标签名称，长度限制为32个字以内（汉字或英文字母），标签名不可与其他标签重名。

id - 标签id，非负整型，指定此参数时新增的标签会生成对应的标签id，不指定时则以目前最大的id自增。

返回:

标签id

抛出:

WxErrorException - .

create

public String create(String tagName)
              throws WxErrorException

从接口复制的说明: WxCpTagService

创建标签.

指定者:

create 在接口中 WxCpTagService

参数:

tagName - 标签名

返回:

标签id

抛出:

WxErrorException - .

update

public void update(String tagId,
                   String tagName)
            throws WxErrorException

从接口复制的说明: WxCpTagService

更新标签.

指定者:

update 在接口中 WxCpTagService

参数:

tagId - 标签id

tagName - 标签名

抛出:

WxErrorException - .

delete

public void delete(String tagId)
            throws WxErrorException

从接口复制的说明: WxCpTagService

删除标签.

指定者:

delete 在接口中 WxCpTagService

参数:

tagId - 标签id

抛出:

WxErrorException - .

listAll

public List<WxCpTag> listAll()
                      throws WxErrorException

从接口复制的说明: WxCpTagService

获得标签列表.

指定者:

listAll 在接口中 WxCpTagService

返回:

标签列表

抛出:

WxErrorException - .

listUsersByTagId

public List<WxCpUser> listUsersByTagId(String tagId)
                                throws WxErrorException

从接口复制的说明: WxCpTagService

获取标签成员.

指定者:

listUsersByTagId 在接口中 WxCpTagService

参数:

tagId - 标签ID

返回:

成员列表

抛出:

WxErrorException - .

addUsers2Tag

public WxCpTagAddOrRemoveUsersResult addUsers2Tag(String tagId,
                                                  List<String> userIds,
                                                  List<String> partyIds)
                                           throws WxErrorException

从接口复制的说明: WxCpTagService

增加标签成员.

指定者:

addUsers2Tag 在接口中 WxCpTagService

参数:

tagId - 标签id

userIds - 用户ID 列表

partyIds - 企业部门ID列表

返回:

.

抛出:

WxErrorException - .

removeUsersFromTag

public WxCpTagAddOrRemoveUsersResult removeUsersFromTag(String tagId,
                                                        List<String> userIds,
                                                        List<String> partyIds)
                                                 throws WxErrorException

从接口复制的说明: WxCpTagService

移除标签成员.

指定者:

removeUsersFromTag 在接口中 WxCpTagService

参数:

tagId - 标签id

userIds - 用户id列表

partyIds - 企业部门ID列表

返回:

.

抛出:

WxErrorException - .

get

public WxCpTagGetResult get(String tagId)
                     throws WxErrorException

从接口复制的说明: WxCpTagService

获取标签成员. 对应: http://qydev.weixin.qq.com/wiki/index.php?title=管理标签 中的get接口

指定者:

get 在接口中 WxCpTagService

参数:

tagId - 标签id

返回:

.

抛出:

WxErrorException - .