Package com.foxinmy.weixin4j.qy.api

Class AgentApi

java.lang.Object

com.foxinmy.weixin4j.api.BaseApi

com.foxinmy.weixin4j.qy.api.QyApi

com.foxinmy.weixin4j.qy.api.AgentApi

public class AgentApi
extends QyApi

管理应用接口

Since:

JDK 1.6

Author:

jinyu(foxinmy@gmail.com)

See Also:

管理应用接口说明

Field Summary

Fields

Modifier and Type	Field	Description
static com.alibaba.fastjson.serializer.ValueFilter	typeFilter

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

weixinExecutor

Constructor Summary

Constructors

Constructor	Description
AgentApi(TokenManager tokenManager)

Method Summary

Modifier and Type	Method	Description
AgentInfo	getAgent(int agentid)	获取企业号某个应用的基本信息，包括头像、昵称、帐号类型、认证类型、可见范围等信息
List<AgentOverview>	listAgentOverview()	获取应用概况列表
ApiResult	setAgent(AgentSetter agentSet)	设置企业应用的选项设置信息，如：地理位置上报等

Methods inherited from class com.foxinmy.weixin4j.qy.api.QyApi

weixinBundle

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

getRequestUri

Methods inherited from class java.lang.Object

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

Field Detail

typeFilter

public static final com.alibaba.fastjson.serializer.ValueFilter typeFilter

Constructor Detail

AgentApi

public AgentApi(TokenManager tokenManager)

Method Detail

getAgent

public AgentInfo getAgent(int agentid)
                   throws WeixinException

获取企业号某个应用的基本信息，包括头像、昵称、帐号类型、认证类型、可见范围等信息

Parameters:

agentid - 授权方应用id

Returns:

应用信息

Throws:

WeixinException

See Also:

AgentInfo, 企业号应用的信息

setAgent

public ApiResult setAgent(AgentSetter agentSet)
                   throws WeixinException

设置企业应用的选项设置信息，如：地理位置上报等

Parameters:

agentSet - 设置信息

Returns:

处理结果

Throws:

WeixinException

See Also:

AgentSetter, 设置企业号信息

listAgentOverview

public List<AgentOverview> listAgentOverview()
                                      throws WeixinException

获取应用概况列表

Returns:

应用概况列表

Throws:

WeixinException

See Also:

AgentOverview, 获取应用概况