AbleCloud PHP SDK
1.8.x
PHP SDK of AbleCloud API
|
Public 成员函数 | |
__construct ($serviceName, $methodName, $serviceVersion, $subDomain='') | |
setUser ($user) | |
getUser () | |
getServiceName () | |
getServiceVersion () | |
getMethodName () | |
getSubDomain () | |
addParameter ($key, $value) | |
getParameterKeys () | |
getParameterValue ($key) | |
setPayloadAsJSON ($payload, $contentType='application/x-zc-object') | |
setPayloadAsStream ($payload) | |
getPayloadFormat () | |
getPayloadSize () | |
getPayload () | |
getTraceId () | |
setTraceId ($traceId) | |
静态 Public 成员函数 | |
static | newTraceId () |
访问AbleCloud远程服务的请求消息。
ACRequest::__construct | ( | $serviceName, | |
$methodName, | |||
$serviceVersion, | |||
$subDomain = '' |
|||
) |
构造函数。
$serviceName | string 是拟访问的远程服务的名字。 |
$methodName | string 是拟访问的远程服务的方法的名字。 |
$serviceVersion | int 是拟访问的远程服务的主版本号。 |
$subDomain | string 是拟访问的远程服务所属的子域的名字。缺省值为空字符串,表示访问主域级别的服务。不为空字符串时,表示访问该子域所对应的服务。 |
ACRequest::addParameter | ( | $key, | |
$value | |||
) |
添加请求的参数。这些参数是键值对,将会以查询字符串的方式置于访问远程服务的URL中传递给远程服务。
$key | string 参数的名字。 |
$value | mixed 参数的值。对同名的参数多次赋值时,取最后一次设置的值。 |
ACRequest::getMethodName | ( | ) |
取拟访问的远程服务的方法名。
ACRequest::getParameterKeys | ( | ) |
取设置的所有参数的名字。
ACRequest::getParameterValue | ( | $key | ) |
取参数的值。
$key | string 参数的名字。 |
ACRequest::getPayload | ( | ) |
取设置的请求所包含的数据。
ACRequest::getPayloadFormat | ( | ) |
取请求所包含的数据的格式:application/x-zc-object或application/octet-stream,分别表示JSON格式和二进制数据格式。
ACRequest::getPayloadSize | ( | ) |
取请求所包含数据的大小。
ACRequest::getServiceName | ( | ) |
取拟访问的远程服务的名字。
ACRequest::getServiceVersion | ( | ) |
取拟访问的远程服务的主版本号。
ACRequest::getSubDomain | ( | ) |
取拟访问的远程服务所属的子域的名字。
ACRequest::getTraceId | ( | ) |
取当前的Trace-Id。
ACRequest::getUser | ( | ) |
取当前设置的用户信息。
|
static |
生成一个Trace-ID。
ACRequest::setPayloadAsJSON | ( | $payload, | |
$contentType = 'application/x-zc-object' |
|||
) |
消息内容要么是JSON格式的要么是二进制格式的。取最后一次设置的内容为最终内容。本方法用于设置JSON格式的消息内容。
$payload | string JSON格式的内容。 |
$contentType | string HTTP请求的Content-Type的值,缺省为'application/x-zc-object'。 |
ACRequest::setPayloadAsStream | ( | $payload | ) |
消息内容要么是JSON格式的要么是二进制格式的。取最后一次设置的内容为最终内容。本方法用于设置二进制格式的消息内容。
$payload | string string类型的数据,表示二进制格式的内容。 |
ACRequest::setTraceId | ( | $traceId | ) |
设置Trace-Id。
$traceId | string 是符合RFC 4122 - Section 4.4规范的UUID的十六进制表示形式,用来作为请求的Trace-Id。 |
ACRequest::setUser | ( | $user | ) |
设置本次请求所关联的用户。该用户是AbleCloud平台中开发者所提供服务的用户。
$user | ACUser|NULL AbleCloud平台中开发者所提供服务的用户。NULL表示清除设置的用户信息。 |