com.alipay.easysdk.marketing.openlife

类 Client

java.lang.Object

com.alipay.easysdk.marketing.openlife.Client

public class Client
extends Object

字段概要

字段

限定符和类型	字段和说明
com.alipay.easysdk.kernel.Client	_kernel

构造器概要

构造器

构造器和说明
Client(com.alipay.easysdk.kernel.Client kernel)

方法概要

限定符和类型	方法和说明
Client	agent(String appAuthToken) ISV代商户代用，指定appAuthToken
Client	asyncNotify(String url) 设置异步通知回调地址，此处设置将在本调用中覆盖Config中的全局配置
Client	auth(String authToken) 用户授权调用，指定authToken
Client	batchOptional(Map<String,Object> optionalArgs) 批量设置API入参中没有的其他可选业务请求参数(biz_content下的字段) optional方法的批量版本
AlipayOpenPublicMessageContentCreateResponse	createImageTextContent(String title, String cover, String content, String contentComment, String ctype, String benefit, String extTags, String loginIds)
AlipayOpenPublicSettingCategoryQueryResponse	getIndustry()
AlipayOpenPublicMessageContentModifyResponse	modifyImageTextContent(String contentId, String title, String cover, String content, String couldComment, String ctype, String benefit, String extTags, String loginIds)
Client	optional(String key, Object value) 设置API入参中没有的其他可选业务请求参数(biz_content下的字段)
AlipayOpenPublicLifeMsgRecallResponse	recallMessage(String messageId)
Client	route(String testUrl) 将本次调用强制路由到后端系统的测试地址上，常用于线下环境内外联调，沙箱与线上环境设置无效
AlipayOpenPublicMessageTotalSendResponse	sendImageText(List<Article> articles)
AlipayOpenPublicMessageSingleSendResponse	sendSingleMessage(String toUserId, Template template)
AlipayOpenPublicMessageTotalSendResponse	sendText(String text)
AlipayOpenPublicTemplateMessageIndustryModifyResponse	setIndustry(String primaryIndustryCode, String primaryIndustryName, String secondaryIndustryCode, String secondaryIndustryName)

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

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

字段详细资料

_kernel

public com.alipay.easysdk.kernel.Client _kernel

构造器详细资料

Client

public Client(com.alipay.easysdk.kernel.Client kernel)
       throws Exception

抛出:

Exception

方法详细资料

createImageTextContent

public AlipayOpenPublicMessageContentCreateResponse createImageTextContent(String title,
                                                                           String cover,
                                                                           String content,
                                                                           String contentComment,
                                                                           String ctype,
                                                                           String benefit,
                                                                           String extTags,
                                                                           String loginIds)
                                                                    throws Exception

抛出:

Exception

modifyImageTextContent

public AlipayOpenPublicMessageContentModifyResponse modifyImageTextContent(String contentId,
                                                                           String title,
                                                                           String cover,
                                                                           String content,
                                                                           String couldComment,
                                                                           String ctype,
                                                                           String benefit,
                                                                           String extTags,
                                                                           String loginIds)
                                                                    throws Exception

抛出:

Exception

sendText

public AlipayOpenPublicMessageTotalSendResponse sendText(String text)
                                                  throws Exception

抛出:

Exception

sendImageText

public AlipayOpenPublicMessageTotalSendResponse sendImageText(List<Article> articles)
                                                       throws Exception

抛出:

Exception

sendSingleMessage

public AlipayOpenPublicMessageSingleSendResponse sendSingleMessage(String toUserId,
                                                                   Template template)
                                                            throws Exception

抛出:

Exception

recallMessage

public AlipayOpenPublicLifeMsgRecallResponse recallMessage(String messageId)
                                                    throws Exception

抛出:

Exception

setIndustry

public AlipayOpenPublicTemplateMessageIndustryModifyResponse setIndustry(String primaryIndustryCode,
                                                                         String primaryIndustryName,
                                                                         String secondaryIndustryCode,
                                                                         String secondaryIndustryName)
                                                                  throws Exception

抛出:

Exception

getIndustry

public AlipayOpenPublicSettingCategoryQueryResponse getIndustry()
                                                         throws Exception

抛出:

Exception

agent

public Client agent(String appAuthToken)

ISV代商户代用，指定appAuthToken

参数:

appAuthToken - 代调用token

返回:

本客户端，便于链式调用

auth

public Client auth(String authToken)

用户授权调用，指定authToken

参数:

authToken - 用户授权token

返回:

本客户端，便于链式调用

asyncNotify

public Client asyncNotify(String url)

设置异步通知回调地址，此处设置将在本调用中覆盖Config中的全局配置

参数:

url - 异步通知回调地址，例如：https://www.test.com/callback

返回:

本客户端，便于链式调用

route

public Client route(String testUrl)

将本次调用强制路由到后端系统的测试地址上，常用于线下环境内外联调，沙箱与线上环境设置无效

参数:

testUrl - 后端系统测试地址

返回:

本客户端，便于链式调用

optional

public Client optional(String key,
                       Object value)

设置API入参中没有的其他可选业务请求参数(biz_content下的字段)

参数:

key - 业务请求参数名称（biz_content下的字段名，比如timeout_express）

value - 业务请求参数的值，一个可以序列化成JSON的对象 如果该字段是一个字符串类型（String、Price、Date在SDK中都是字符串），请使用String储存 如果该字段是一个数值型类型（比如：Number），请使用Long储存 如果该字段是一个复杂类型，请使用嵌套的Map指定各下级字段的值 如果该字段是一个数组，请使用List储存各个值 对于更复杂的情况，也支持Map和List的各种组合嵌套，比如参数是值是个List，List中的每种类型是一个复杂对象

返回:

本客户端，便于链式调用

batchOptional

public Client batchOptional(Map<String,Object> optionalArgs)

批量设置API入参中没有的其他可选业务请求参数(biz_content下的字段) optional方法的批量版本

参数:

optionalArgs - 可选参数集合，每个参数由key和value组成，key和value的格式请参见optional方法的注释

返回:

本客户端，便于链式调用