Package com.foxinmy.weixin4j.qy.api

Class TagApi

  • public class TagApi
extends QyApi
    标签API
    Since:
    JDK 1.6
    Author:
    jinyu(foxinmy@gmail.com)
    See Also:
    管理标签

    • Field Summary

      • Fields inherited from class com.foxinmy.weixin4j.api.BaseApi

        weixinExecutor

    • Constructor Summary

      Constructors 
      Constructor Description
      TagApi​(com.foxinmy.weixin4j.token.TokenManager tokenManager)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      IdParameter addTagUsers​(int tagId, List<String> userIds, List<Integer> partyIds)
      新增标签成员(标签对管理组可见且未加锁，成员属于管理组管辖范围。)
      int createTag​(Tag tag)
      创建标签(创建的标签属于管理组；默认为加锁状态。加锁状态下只有本管理组才可以增删成员，解锁状态下其它管理组也可以增删成员)
      com.foxinmy.weixin4j.http.weixin.ApiResult deleteTag​(int tagId)
      删除标签(管理组必须是指定标签的创建者，并且标签的成员列表为空。)
      IdParameter deleteTagUsers​(int tagId, List<String> userIds, List<Integer> partyIds)
      删除标签成员(标签对管理组未加锁，成员属于管理组管辖范围)
      Contacts getTagUsers​(int tagId)
      获取标签成员(管理组须拥有“获取标签成员”的接口权限，返回列表仅包含管理组管辖范围的成员。)
      List<Tag> listTag()
      获取标签列表
      com.foxinmy.weixin4j.http.weixin.ApiResult updateTag​(Tag tag)
      更新标签(管理组必须是指定标签的创建者)

      • Methods inherited from class com.foxinmy.weixin4j.api.BaseApi

        getRequestUri

    • Constructor Detail

      • TagApi

        public TagApi​(com.foxinmy.weixin4j.token.TokenManager tokenManager)

    • Method Detail

      • createTag

        public int createTag​(Tag tag)
              throws com.foxinmy.weixin4j.exception.WeixinException
        创建标签(创建的标签属于管理组；默认为加锁状态。加锁状态下只有本管理组才可以增删成员，解锁状态下其它管理组也可以增删成员)
        Parameters:
        tag - 标签对象；
        标签名称，长度限制为32个字（汉字或英文字母），标签名不可与其他标签重名。
        标签id，整型， 指定此参数时新增的标签会生成对应的标签id，不指定时则以目前最大的id自增。
        Returns:
        标签ID
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        创建标签说明

      • updateTag

        public com.foxinmy.weixin4j.http.weixin.ApiResult updateTag​(Tag tag)
                                                     throws com.foxinmy.weixin4j.exception.WeixinException
        更新标签(管理组必须是指定标签的创建者)
        Parameters:
        tag - 标签信息
        Returns:
        处理结果
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        更新标签说明, Tag

      • deleteTag

        public com.foxinmy.weixin4j.http.weixin.ApiResult deleteTag​(int tagId)
                                                     throws com.foxinmy.weixin4j.exception.WeixinException
        删除标签(管理组必须是指定标签的创建者，并且标签的成员列表为空。)
        Parameters:
        tagId - 标签ID
        Returns:
        处理结果
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        删除标签说明

      • listTag

        public List<Tag> listTag()
                  throws com.foxinmy.weixin4j.exception.WeixinException
        获取标签列表
        Returns:
        标签列表
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        获取标签列表说明, Tag

      • getTagUsers

        public Contacts getTagUsers​(int tagId)
                     throws com.foxinmy.weixin4j.exception.WeixinException
        获取标签成员(管理组须拥有“获取标签成员”的接口权限，返回列表仅包含管理组管辖范围的成员。)
        Parameters:
        tagId - 标签ID
        Returns:
        成员列表Contacts#getUsers和部门列表Contacts#getPartyIds
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        Contacts, User, 获取标签成员说明

      • addTagUsers

        public IdParameter addTagUsers​(int tagId,
                               List<String> userIds,
                               List<Integer> partyIds)
                        throws com.foxinmy.weixin4j.exception.WeixinException
        新增标签成员(标签对管理组可见且未加锁，成员属于管理组管辖范围。)
        Parameters:
        tagId - 标签ID
        userIds - 企业成员ID列表，注意：userlist、partylist不能同时为空，单次请求长度不超过1000
        partyIds - 企业部门ID列表，注意：userlist、partylist不能同时为空，单次请求长度不超过100
        Returns:
        非法的userIds和partyIds
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        新增标签成员说明, IdParameter

      • deleteTagUsers

        public IdParameter deleteTagUsers​(int tagId,
                                  List<String> userIds,
                                  List<Integer> partyIds)
                           throws com.foxinmy.weixin4j.exception.WeixinException
        删除标签成员(标签对管理组未加锁，成员属于管理组管辖范围)
        Parameters:
        tagId - 标签ID
        userIds - 企业成员ID列表，注意：userlist、partylist不能同时为空
        partyIds - 企业部门ID列表，注意：userlist、partylist不能同时为空
        Returns:
        非法的userIds和partyIds
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        删除标签成员说明, IdParameter