AbleCloud PHP SDK
1.8.x
PHP SDK of AbleCloud API
|
Public 成员函数 | |
__construct ($name, $version, $context) | |
listDevices ($user) | |
listUsers ($deviceId) | |
isDeviceOnline ($deviceId) | |
isDeviceOnlineByPhysicalId ($subDomain, $physicalId) | |
isDeviceBound ($subDomain, $physicalId) | |
isDeviceBoundByUser ($userId, $deviceId) | |
isDeviceBoundByUserWithPhysicalId ($userId, $subDomain, $physicalId) | |
getDeviceId ($subDomain, $physicalId) | |
getDeviceCount ($subDomain='') | |
getAllDevices ($subDomain, $offset, $limit) | |
getDeviceCountOfUser ($userId, $subDomain='') | |
getDevicesOfUser ($userId, $subDomain, $offset, $limit) | |
getDevicesOfUserExt ($userId, $subDomain, $offset, $limit) | |
sendToDevice ($user, $deviceId, $subDomain, $messageCode, $message, $handset='', $handsetVersion='') | |
sendToDeviceByPhysicalId ($user, $physicalId, $subDomain, $messageCode, $message, $handset='', $handsetVersion='') | |
changeName ($user, $deviceId, $name) | |
独立设备 | |
bindDevice ($subDomain, $physicalId, $name, $user) | |
unbindDevice ($subDomain, $deviceId, $user) | |
getDeviceShareCode ($deviceId, $user, $timeout) | |
fetchDeviceShareCode ($deviceId, $user, $timeout) | |
refreshDeviceShareCode ($deviceId, $user, $timeout) | |
bindDeviceWithShareCode ($user, $shareCode) | |
bindDeviceWithUser ($adminUser, $deviceId, $account) | |
bindDeviceWithUserByID ($adminUser, $deviceId, $userId) | |
unbindDeviceWithUser ($adminUser, $deviceId, $userId) | |
设备的扩展属性 | |
setDeviceProfile ($user, $deviceId, $profile) | |
getDeviceProfile ($deviceId, $user=NULL) | |
![]() | |
__construct ($name, $version, $context) | |
getName () | |
getVersion () | |
getContext () | |
getLastError () | |
额外继承的成员函数 | |
![]() | |
resetLastError ($errCode=0, $errMessage='') | |
AbleCloud设备绑定管理服务。
ACBindMgr::__construct | ( | $name, | |
$version, | |||
$context | |||
) |
构造函数。
$name | string AbleCloud设备绑定管理服务的名字。 |
$version | int AbleCloud设备绑定管理服务的版本。 |
$context | ACContext ACContext对象,表示访问该远程服务所依赖的环境信息。 |
ACBindMgr::bindDevice | ( | $subDomain, | |
$physicalId, | |||
$name, | |||
$user | |||
) |
ACBindMgr::bindDeviceWithShareCode | ( | $user, | |
$shareCode | |||
) |
ACBindMgr::bindDeviceWithUser | ( | $adminUser, | |
$deviceId, | |||
$account | |||
) |
将设备绑定至指定用户。
$adminUser | ACUser ACUser对象,是要被绑定的设备的管理员用户。 |
$deviceId | int 要被绑定的设备的逻辑ID。 |
$account | string 要绑定设备的用户的帐号:email或手机号。 |
ACBindMgr::bindDeviceWithUserByID | ( | $adminUser, | |
$deviceId, | |||
$userId | |||
) |
将设备绑定至指定用户。
$adminUser | ACUser ACUser对象,是要被绑定的设备的管理员用户。 |
$deviceId | int 要被绑定的设备的逻辑ID。 |
$userId | int 要绑定设备的用户的ID。 |
ACBindMgr::changeName | ( | $user, | |
$deviceId, | |||
$name | |||
) |
修改设备名称。
$user | ACUser ACUser对象,表示要修改设备名字的用户。 |
$deviceId | int 是目标设备的逻辑ID。 |
$name | string 是设备的新名字。 |
ACBindMgr::fetchDeviceShareCode | ( | $deviceId, | |
$user, | |||
$timeout | |||
) |
取设备当前的分享码。
$deviceId | int 设备的逻辑ID。 |
$user | ACUser ACUser对象,表示该设备的管理员用户。 |
$timeout | int 分享码的有效时长(以秒为单位)。此参数取值为0时表示仅取当前有效即未过期的分享码,若不存在有效的分享码则抛出分享码不存在的异常。 此参数值大于0时,若存在有效的分享码,则将其有效时长重置为此值后返回该分享码;若不存在有效的分享码则生成一个新的有效时长为timeout的分享码并返回之。 此参数的值不能超过3153600000秒(约100年),否则将被截取为此最大值。此参数小于0时也表示取此最大值。 |
ACBindMgr::getAllDevices | ( | $subDomain, | |
$offset, | |||
$limit | |||
) |
查询所有被绑定的设备。
$subDomain | string 拟查询的设备所属的子域的名字。空字符串或NULL表示忽略该参数。 |
$offset | int offset与limit限制查询的范围。offset是非负整数,表示返回的记录在原始集合中的偏移量。 |
$limit | int limit与offset参数指定查询的范围。limit是正整数,表示最多返回的记录的数目,并且其最大值不能超过100。 |
ACBindMgr::getDeviceCount | ( | $subDomain = '' | ) |
查询已被绑定的设备的总数,并提供其中在线的设备数。
$subDomain | string 拟查询的设备所属的子域的名字。空字符串或者NULL表示忽略该参数。 |
ACBindMgr::getDeviceCountOfUser | ( | $userId, | |
$subDomain = '' |
|||
) |
查询用户绑定的设备数目。
int | $userId | 拟查询的用户的ID。 |
string | $subDomain | 拟查询的设备所属的子域的名字。空字符串或NULL表示忽略该参数。 |
ACBindMgr::getDeviceId | ( | $subDomain, | |
$physicalId | |||
) |
取设备的逻辑ID。
$subDomain | string 是设备所属的子域的名字。 |
$physicalId | string 表示设备的物理ID。 |
ACBindMgr::getDeviceProfile | ( | $deviceId, | |
$user = NULL |
|||
) |
取设备的扩展属性。
$deviceId | int 是要查询其扩展属性的设备的逻辑ID。 |
$user | ACUser ACUser对象,是发起该操作的用户。如果不为NULL则要求该用户已经绑定了参数$deviceId表示的设备。为NULL时,直接查询设备的扩展属性。 |
ACBindMgr::getDeviceShareCode | ( | $deviceId, | |
$user, | |||
$timeout | |||
) |
设备的管理员用户获取设备的分享码。
$deviceId | int 要操作的对象的逻辑ID。 |
$user | ACUser ACUser对象,表示该设备的管理员用户。 |
$timeout | int 生成的分享码的有效时长。以秒为单位。 |
ACBindMgr::getDevicesOfUser | ( | $userId, | |
$subDomain, | |||
$offset, | |||
$limit | |||
) |
查询用户已绑定的设备。
int | $userId | 拟查询的用户的ID。 |
string | $subDomain | 拟查询的设备所属的子域的名字。空字符串或NULL表示忽略该参数。 |
int | $offset | offset与limit限制查询的范围。offset是非负整数,表示返回的记录在原始集合中的偏移量。 |
int | $limit | limit与offset参数指定查询的范围。limit是正整数,表示最多返回的记录的数目,并且其最大值不能超过100。 |
ACBindMgr::getDevicesOfUserExt | ( | $userId, | |
$subDomain, | |||
$offset, | |||
$limit | |||
) |
查询用户已绑定的设备及其扩展属性。
$userId | int 拟查询的用户的ID。 |
$subDomain | string 拟查询的设备所属的子域的名字。空字符串或NULL表示忽略该参数。 |
$offset | int $offset与$limit限制查询的范围。$offset是非负整数,表示返回的记录在原始集合中的偏移量。 |
$limit | int $limit与$offset参数指定查询的范围。$limit是正整数,表示最多返回的记录的数目,并且其最大值不能超过100。 |
ACBindMgr::isDeviceBound | ( | $subDomain, | |
$physicalId | |||
) |
检查设备是否已经被用户绑定了。
$subDomain | string 是设备所属的子域的名字。 |
$physicalId | string 要被检查的设备的物理ID。 |
ACBindMgr::isDeviceBoundByUser | ( | $userId, | |
$deviceId | |||
) |
检查指定用户是否绑定了指定设备。
$userId | int 用户ID。 |
$deviceId | int 设备的逻辑ID。 |
ACBindMgr::isDeviceBoundByUserWithPhysicalId | ( | $userId, | |
$subDomain, | |||
$physicalId | |||
) |
检查指定用户是否绑定了指定设备。
$userId | int 用户ID。 |
$subDomain | string 设备所属的子域的名字。 |
$physicalId | string 设备的物理ID。 |
ACBindMgr::isDeviceOnline | ( | $deviceId | ) |
通过设备逻辑ID查询设备的在线状态。
$deviceId | int 设备的逻辑ID。 |
ACBindMgr::isDeviceOnlineByPhysicalId | ( | $subDomain, | |
$physicalId | |||
) |
通过设备物理ID查询设备的在线状态。
$subDomain | string 是设备所属的子域的名字。 |
$physicalId | string 设备的物理ID。 |
ACBindMgr::listDevices | ( | $user | ) |
查询用户绑定的所有设备(包括网关及其子设备)。
$user | ACUser ACUser对象,表示被查询的用户。 |
ACBindMgr::listUsers | ( | $deviceId | ) |
查询某设备的所有用户。
$deviceId | int 是拟查询的设备的逻辑ID。 |
ACBindMgr::refreshDeviceShareCode | ( | $deviceId, | |
$user, | |||
$timeout | |||
) |
更新设备的分享分享码。此更新操作将删除已经存在的有效分享码。
$deviceId | int 设备的逻辑ID。 |
$user | ACUser ACUser对象,表示该设备的管理员用户。 |
$timeout | int 分享码的有效时长(以秒为单位)。此参数的值为0时表示取值3600秒(1小时)。此参数的值大于0时不能超过3153600000秒(约100年),否则将被截取为此最大值。 此参数的值小于0时也表示取此最大值。 |
ACBindMgr::sendToDevice | ( | $user, | |
$deviceId, | |||
$subDomain, | |||
$messageCode, | |||
$message, | |||
$handset = '' , |
|||
$handsetVersion = '' |
|||
) |
向设备发送消息。
$user | ACUser ACUser对象,表示向设备发送消息的用户。 |
$deviceId | int 是目标设备的逻辑ID。 |
$subDomain | string 是拟操作的设备所属的子域的名字。 |
$messageCode | int 发送给设备的消息的码。 |
$message | string 以string对象存储的拟发送给设备的二进制数据。 |
$handset | string 表示调用本方法时用户所使用的终端工具的名字,如'weixin'表示微信终端。 开发者也可以通过ACContext对象设置终端工具信息。如果指定了本参数,则以本参数指定的值为准。 |
$handsetVersion | string 表示调用本方法时用户所使用的终端工具的版本信息。 |
ACBindMgr::sendToDeviceByPhysicalId | ( | $user, | |
$physicalId, | |||
$subDomain, | |||
$messageCode, | |||
$message, | |||
$handset = '' , |
|||
$handsetVersion = '' |
|||
) |
向设备发送消息。
$user | ACUser ACUser对象,表示向设备发送消息的用户。 |
$physicalId | string 是目标设备的物理ID。 |
$subDomain | string 是拟操作的设备所属的子域的名字。 |
$messageCode | int 发送给设备的消息的码。 |
$message | string 以string对象存储的拟发送给设备的二进制数据。 |
$handset | string 表示调用本方法时用户所使用的终端工具的名字,如'weixin'表示微信终端。 开发者也可以通过ACContext对象设置终端工具信息。如果指定了本参数,则以本参数指定的值为准。 |
$handsetVersion | string 表示调用本方法时用户所使用的终端工具的版本信息。 |
ACBindMgr::setDeviceProfile | ( | $user, | |
$deviceId, | |||
$profile | |||
) |
设置用户所绑定设备的扩展属性。
$user | ACUser ACUser对象,是发起该操作的用户。 |
$deviceId | int 是要设置其扩展属性的设备的逻辑ID。 |
$profile | array 是由键值对组成的关联数组,表示设备的扩展属性值。 |
ACBindMgr::unbindDevice | ( | $subDomain, | |
$deviceId, | |||
$user | |||
) |
解除设备与用户的绑定关系。
$subDomain | string 是要被解绑的设备所属的子域的名字。 |
$deviceId | int 要被解除绑定关系的设备的逻辑ID。 |
$user | ACUser ACUser对象,表示要被解除绑定关系的用户。如果该用户是该设备的管理员,则解除这两者之间的绑定关系时,将解除设备与其它所有用户的绑定。 |
ACBindMgr::unbindDeviceWithUser | ( | $adminUser, | |
$deviceId, | |||
$userId | |||
) |
解邦设备与指定用户。
$adminUser | ACUser ACUser对象,是设备的管理员用户。 |
$deviceId | int 要被解绑的设备的逻辑ID。 |
$userId | int 要解绑设备的用户的ID。 |