\Alipay\EasySDK\Marketing\PassClient

Summary

Methods

Properties

Constants

__construct()
createTemplate()
updateTemplate()
addInstance()
updateInstance()
agent()
auth()
asyncNotify()
route()
optional()
batchOptional()

No public properties found

No constants found

No protected methods found

$_kernel

N/A

No private methods found

No private properties found

N/A

File: serve/vendor/alipaysdk/easysdk/php/src/Marketing/Pass/Client.php
Package: Application
Class hierarchy: \Alipay\EasySDK\Marketing\Pass\Client
Uses

Properties

$_kernel

$_kernel

Methods

__construct()

__construct(mixed  $kernel) : mixed

Parameters

mixed

$kernel

Returns

mixed —

createTemplate()

createTemplate(string  $uniqueId, string  $tplContent) : \Alipay\EasySDK\Marketing\Pass\Models\AlipayPassTemplateAddResponse

Parameters

string	$uniqueId
string	$tplContent

Throws

\AlibabaCloud\Tea\Exception\TeaError
\Exception
\AlibabaCloud\Tea\Exception\TeaUnableRetryError

Returns

\Alipay\EasySDK\Marketing\Pass\Models\AlipayPassTemplateAddResponse —

updateTemplate()

updateTemplate(string  $tplId, string  $tplContent) : \Alipay\EasySDK\Marketing\Pass\Models\AlipayPassTemplateUpdateResponse

Parameters

string	$tplId
string	$tplContent

Throws

\AlibabaCloud\Tea\Exception\TeaError
\Exception
\AlibabaCloud\Tea\Exception\TeaUnableRetryError

Returns

\Alipay\EasySDK\Marketing\Pass\Models\AlipayPassTemplateUpdateResponse —

addInstance()

addInstance(string  $tplId, string  $tplParams, string  $recognitionType, string  $recognitionInfo) : \Alipay\EasySDK\Marketing\Pass\Models\AlipayPassInstanceAddResponse

Parameters

string	$tplId
string	$tplParams
string	$recognitionType
string	$recognitionInfo

Throws

\AlibabaCloud\Tea\Exception\TeaError
\Exception
\AlibabaCloud\Tea\Exception\TeaUnableRetryError

Returns

\Alipay\EasySDK\Marketing\Pass\Models\AlipayPassInstanceAddResponse —

updateInstance()

updateInstance(string  $serialNumber, string  $channelId, string  $tplParams, string  $status, string  $verifyCode, string  $verifyType) : \Alipay\EasySDK\Marketing\Pass\Models\AlipayPassInstanceUpdateResponse

Parameters

string	$serialNumber
string	$channelId
string	$tplParams
string	$status
string	$verifyCode
string	$verifyType

Throws

\AlibabaCloud\Tea\Exception\TeaError
\Exception
\AlibabaCloud\Tea\Exception\TeaUnableRetryError

Returns

\Alipay\EasySDK\Marketing\Pass\Models\AlipayPassInstanceUpdateResponse —

agent()

agent( $appAuthToken) : $this

ISV代商户代用，指定appAuthToken

Parameters

$appAuthToken

String 代调用token

Returns

$this —

本客户端，便于链式调用

auth()

auth( $authToken) : $this

用户授权调用，指定authToken

Parameters

$authToken

String 用户授权token

Returns

$this —

asyncNotify()

asyncNotify( $url) : $this

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

Parameters

$url

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

Returns

$this —

route()

route( $testUrl) : $this

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

Parameters

$testUrl

String 后端系统测试地址

Returns

$this —

optional()

optional( $key,  $value) : $this

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

Parameters

	$key	String 业务请求参数名称（biz_content下的字段名，比如timeout_express）
	$value	object 业务请求参数的值，一个可以序列化成JSON的对象如果该字段是一个字符串类型（String、Price、Date在SDK中都是字符串），请使用String储存如果该字段是一个数值型类型（比如：Number），请使用Long储存如果该字段是一个复杂类型，请使用嵌套的array指定各下级字段的值如果该字段是一个数组，请使用array储存各个值

Returns

$this —

batchOptional()

batchOptional( $optionalArgs) : $this

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

Parameters

$optionalArgs

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

Returns

$this —