AbleCloud PHP SDK  1.8.x
PHP SDK of AbleCloud API
Public 成员函数 | 所有成员列表
ACBindMgr类 参考
类 ACBindMgr 继承关系图:
Inheritance graph
[图例]
ACBindMgr 的协作图:
Collaboration graph
[图例]

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)
 
- Public 成员函数 继承自 ACService
 __construct ($name, $version, $context)
 
 getName ()
 
 getVersion ()
 
 getContext ()
 
 getLastError ()
 

额外继承的成员函数

- Protected 成员函数 继承自 ACService
 resetLastError ($errCode=0, $errMessage='')
 

详细描述

AbleCloud设备绑定管理服务。

构造及析构函数说明

◆ __construct()

ACBindMgr::__construct (   $name,
  $version,
  $context 
)

构造函数。

参数
$namestring AbleCloud设备绑定管理服务的名字。
$versionint AbleCloud设备绑定管理服务的版本。
$contextACContext ACContext对象,表示访问该远程服务所依赖的环境信息。

成员函数说明

◆ bindDevice()

ACBindMgr::bindDevice (   $subDomain,
  $physicalId,
  $name,
  $user 
)

将设备绑定至指定的用户。

参数
$subDomainstring 是要被绑定的设备所属的子域的名字。
$physicalIdstring 要被绑定的设备的物理ID。
$namestring 设备的名字。
$userACUser 表示要被绑定的用户。
返回
ACDevice 操作成功返回ACDevice对象,表示被绑定的设备的信息。操作失败时返回NULL,并且可调用getLastError()方法获取错误消息。

◆ bindDeviceWithShareCode()

ACBindMgr::bindDeviceWithShareCode (   $user,
  $shareCode 
)

将设备绑定至获取了分享码的用户。

参数
$userACUser ACUser对象,表示获取了分享码的用户。设备将被绑定至该用户。
$shareCodestring 绑定设备使用的分享码。
返回
ACDevice 操作成功将返回ACDevice对象,表示被绑定的设备的信息。失败时返回NULL,并且可调用getLastError()方法获取错误消息。

◆ bindDeviceWithUser()

ACBindMgr::bindDeviceWithUser (   $adminUser,
  $deviceId,
  $account 
)

将设备绑定至指定用户。

参数
$adminUserACUser ACUser对象,是要被绑定的设备的管理员用户。
$deviceIdint 要被绑定的设备的逻辑ID。
$accountstring 要绑定设备的用户的帐号:email或手机号。
返回
bool 绑定成功返回TURE,否则返回FALSE。绑定失败时可调用getLastError()方法获取错误信息。

◆ bindDeviceWithUserByID()

ACBindMgr::bindDeviceWithUserByID (   $adminUser,
  $deviceId,
  $userId 
)

将设备绑定至指定用户。

参数
$adminUserACUser ACUser对象,是要被绑定的设备的管理员用户。
$deviceIdint 要被绑定的设备的逻辑ID。
$userIdint 要绑定设备的用户的ID。
返回
bool 绑定成功返回TURE,否则返回FALSE。绑定失败时可调用getLastError()方法获取错误信息。

◆ changeName()

ACBindMgr::changeName (   $user,
  $deviceId,
  $name 
)

修改设备名称。

参数
$userACUser ACUser对象,表示要修改设备名字的用户。
$deviceIdint 是目标设备的逻辑ID。
$namestring 是设备的新名字。
返回
bool 返回TRUE表示操作成功;返回FALSE表示操作失败,此时可调用getLastError()获取错误信息。

◆ fetchDeviceShareCode()

ACBindMgr::fetchDeviceShareCode (   $deviceId,
  $user,
  $timeout 
)

取设备当前的分享码。

参数
$deviceIdint 设备的逻辑ID。
$userACUser ACUser对象,表示该设备的管理员用户。
$timeoutint 分享码的有效时长(以秒为单位)。此参数取值为0时表示仅取当前有效即未过期的分享码,若不存在有效的分享码则抛出分享码不存在的异常。 此参数值大于0时,若存在有效的分享码,则将其有效时长重置为此值后返回该分享码;若不存在有效的分享码则生成一个新的有效时长为timeout的分享码并返回之。 此参数的值不能超过3153600000秒(约100年),否则将被截取为此最大值。此参数小于0时也表示取此最大值。
返回
ACDeviceShareCode 设备的分享码。操作失败时返回NULL,并且可调用getLastError()方法获取错误消息。

◆ getAllDevices()

ACBindMgr::getAllDevices (   $subDomain,
  $offset,
  $limit 
)

查询所有被绑定的设备。

参数
$subDomainstring 拟查询的设备所属的子域的名字。空字符串或NULL表示忽略该参数。
$offsetint offset与limit限制查询的范围。offset是非负整数,表示返回的记录在原始集合中的偏移量。
$limitint limit与offset参数指定查询的范围。limit是正整数,表示最多返回的记录的数目,并且其最大值不能超过100。
返回
array|FALSE 操作成功时返回ACDevice对象的数组。操作失败时返回FALSE,并且可调用getLastError()方法获取错误消息。

◆ getDeviceCount()

ACBindMgr::getDeviceCount (   $subDomain = '')

查询已被绑定的设备的总数,并提供其中在线的设备数。

参数
$subDomainstring 拟查询的设备所属的子域的名字。空字符串或者NULL表示忽略该参数。
返回
array|FALSE 操作成功时返回一个包含两个键"count"和"online"的关联数组,分别表示设备总数和其中在线的设备数。操作失败时返回FALSE,并且可调用getLastError()方法获取错误消息。

◆ getDeviceCountOfUser()

ACBindMgr::getDeviceCountOfUser (   $userId,
  $subDomain = '' 
)

查询用户绑定的设备数目。

参数
int$userId拟查询的用户的ID。
string$subDomain拟查询的设备所属的子域的名字。空字符串或NULL表示忽略该参数。
返回
int 用户绑定的设备的数目。返回值小于0时表示操作失败,此时可调用getLastError()方法获取错误信息。

◆ getDeviceId()

ACBindMgr::getDeviceId (   $subDomain,
  $physicalId 
)

取设备的逻辑ID。

参数
$subDomainstring 是设备所属的子域的名字。
$physicalIdstring 表示设备的物理ID。
返回
int 返回设备的逻辑ID。有效的逻辑ID是正整数。返回0表示操作失败。可调用getLastError()方法获取错误消息。

◆ getDeviceProfile()

ACBindMgr::getDeviceProfile (   $deviceId,
  $user = NULL 
)

取设备的扩展属性。

参数
$deviceIdint 是要查询其扩展属性的设备的逻辑ID。
$userACUser ACUser对象,是发起该操作的用户。如果不为NULL则要求该用户已经绑定了参数$deviceId表示的设备。为NULL时,直接查询设备的扩展属性。
返回
array 操作成功时返回一个由键值对组成的关联数组,表示设备的扩展属性。操作失败时返回NULL,并且可调用getLastError()方法获取错误信息。

◆ getDeviceShareCode()

ACBindMgr::getDeviceShareCode (   $deviceId,
  $user,
  $timeout 
)
弃用:
请使用方法 fetchDeviceShareCoderefreshDeviceShareCode 获取/更新设备的分享码。

设备的管理员用户获取设备的分享码。

参数
$deviceIdint 要操作的对象的逻辑ID。
$userACUser ACUser对象,表示该设备的管理员用户。
$timeoutint 生成的分享码的有效时长。以秒为单位。
返回
string 操作成功后返回分享码字符串。操作失败,则返回空字符串,并且可调用getLastError()方法获取错误消息。

◆ getDevicesOfUser()

ACBindMgr::getDevicesOfUser (   $userId,
  $subDomain,
  $offset,
  $limit 
)

查询用户已绑定的设备。

参数
int$userId拟查询的用户的ID。
string$subDomain拟查询的设备所属的子域的名字。空字符串或NULL表示忽略该参数。
int$offsetoffset与limit限制查询的范围。offset是非负整数,表示返回的记录在原始集合中的偏移量。
int$limitlimit与offset参数指定查询的范围。limit是正整数,表示最多返回的记录的数目,并且其最大值不能超过100。
返回
array | FALSE 操作成功时返回ACDevice对象的数组。操作失败时返回FALSE,并且可调用getLastError()方法获取错误消息。

◆ getDevicesOfUserExt()

ACBindMgr::getDevicesOfUserExt (   $userId,
  $subDomain,
  $offset,
  $limit 
)

查询用户已绑定的设备及其扩展属性。

参数
$userIdint 拟查询的用户的ID。
$subDomainstring 拟查询的设备所属的子域的名字。空字符串或NULL表示忽略该参数。
$offsetint $offset与$limit限制查询的范围。$offset是非负整数,表示返回的记录在原始集合中的偏移量。
$limitint $limit与$offset参数指定查询的范围。$limit是正整数,表示最多返回的记录的数目,并且其最大值不能超过100。
返回
array | FALSE 返回设备列表,其中包含的设备属性包括设备的基础信息、绑定时间、扩展属性、故障信息等。

◆ isDeviceBound()

ACBindMgr::isDeviceBound (   $subDomain,
  $physicalId 
)

检查设备是否已经被用户绑定了。

参数
$subDomainstring 是设备所属的子域的名字。
$physicalIdstring 要被检查的设备的物理ID。
返回
bool 返回TRUE表示设备已被绑定;返回FALSE表示设备未被绑定或状态未知。返回FALSE时,需要调用getLastError()方法检查状态。如果errCode为0,则表示设备未被绑定;否则表示操作出错,设备的状态为未知。

◆ isDeviceBoundByUser()

ACBindMgr::isDeviceBoundByUser (   $userId,
  $deviceId 
)

检查指定用户是否绑定了指定设备。

参数
$userIdint 用户ID。
$deviceIdint 设备的逻辑ID。
返回
bool 返回TRUE表示用户绑定了设备,否则表示没有绑定。

◆ isDeviceBoundByUserWithPhysicalId()

ACBindMgr::isDeviceBoundByUserWithPhysicalId (   $userId,
  $subDomain,
  $physicalId 
)

检查指定用户是否绑定了指定设备。

参数
$userIdint 用户ID。
$subDomainstring 设备所属的子域的名字。
$physicalIdstring 设备的物理ID。
返回
bool 返回TRUE表示用户绑定了设备,否则表示没有绑定。

◆ isDeviceOnline()

ACBindMgr::isDeviceOnline (   $deviceId)

通过设备逻辑ID查询设备的在线状态。

参数
$deviceIdint 设备的逻辑ID。
返回
bool 返回TRUE表示设备在线;返回FALSE表示设备不在线或状态未知。返回FALSE时,需要调用getLastError()方法检查状态。如果errCode为0,则表示设备不在线;否则表示操作出错,设备的状态为未知。

◆ isDeviceOnlineByPhysicalId()

ACBindMgr::isDeviceOnlineByPhysicalId (   $subDomain,
  $physicalId 
)

通过设备物理ID查询设备的在线状态。

参数
$subDomainstring 是设备所属的子域的名字。
$physicalIdstring 设备的物理ID。
返回
bool 返回TRUE表示设备在线;返回FALSE表示设备不在线或状态未知。返回FALSE时,需要调用getLastError()方法检查状态。如果errCode为0,则表示设备不在线;否则表示操作出错,设备的状态为未知。

◆ listDevices()

ACBindMgr::listDevices (   $user)
弃用:
本方法限制了可查询的设备数目的上限。请使用方法 getDeviceCountOfUsergetDevicesOfUser 查询用户绑定的设备信息。

查询用户绑定的所有设备(包括网关及其子设备)。

参数
$userACUser ACUser对象,表示被查询的用户。
返回
array 返回由ACDevice对象组成的数组,表示该用户所绑定的全部设备。操作失败时返回NULL,并且可调用getLastError()方法获取错误消息。

◆ listUsers()

ACBindMgr::listUsers (   $deviceId)

查询某设备的所有用户。

参数
$deviceIdint 是拟查询的设备的逻辑ID。
返回
array 操作成功时返回一个由ACUser对象组成的数组,表示所有绑定了该设备的用户。操作失败时返回NULL,并且可调用getLastError()方法获取错误信息。

◆ refreshDeviceShareCode()

ACBindMgr::refreshDeviceShareCode (   $deviceId,
  $user,
  $timeout 
)

更新设备的分享分享码。此更新操作将删除已经存在的有效分享码。

参数
$deviceIdint 设备的逻辑ID。
$userACUser ACUser对象,表示该设备的管理员用户。
$timeoutint 分享码的有效时长(以秒为单位)。此参数的值为0时表示取值3600秒(1小时)。此参数的值大于0时不能超过3153600000秒(约100年),否则将被截取为此最大值。 此参数的值小于0时也表示取此最大值。
返回
ACDeviceShareCode 设备的分享码。操作失败时返回NULL,并且可调用getLastError()方法获取错误消息。

◆ sendToDevice()

ACBindMgr::sendToDevice (   $user,
  $deviceId,
  $subDomain,
  $messageCode,
  $message,
  $handset = '',
  $handsetVersion = '' 
)

向设备发送消息。

参数
$userACUser ACUser对象,表示向设备发送消息的用户。
$deviceIdint 是目标设备的逻辑ID。
$subDomainstring 是拟操作的设备所属的子域的名字。
$messageCodeint 发送给设备的消息的码。
$messagestring 以string对象存储的拟发送给设备的二进制数据。
$handsetstring 表示调用本方法时用户所使用的终端工具的名字,如'weixin'表示微信终端。 开发者也可以通过ACContext对象设置终端工具信息。如果指定了本参数,则以本参数指定的值为准。
$handsetVersionstring 表示调用本方法时用户所使用的终端工具的版本信息。
返回
ACResponse 返回ACResponse对象,表示设备或云端服务的响应。

◆ sendToDeviceByPhysicalId()

ACBindMgr::sendToDeviceByPhysicalId (   $user,
  $physicalId,
  $subDomain,
  $messageCode,
  $message,
  $handset = '',
  $handsetVersion = '' 
)

向设备发送消息。

参数
$userACUser ACUser对象,表示向设备发送消息的用户。
$physicalIdstring 是目标设备的物理ID。
$subDomainstring 是拟操作的设备所属的子域的名字。
$messageCodeint 发送给设备的消息的码。
$messagestring 以string对象存储的拟发送给设备的二进制数据。
$handsetstring 表示调用本方法时用户所使用的终端工具的名字,如'weixin'表示微信终端。 开发者也可以通过ACContext对象设置终端工具信息。如果指定了本参数,则以本参数指定的值为准。
$handsetVersionstring 表示调用本方法时用户所使用的终端工具的版本信息。
返回
ACResponse 返回ACResponse对象,表示设备或云端服务的响应。

◆ setDeviceProfile()

ACBindMgr::setDeviceProfile (   $user,
  $deviceId,
  $profile 
)

设置用户所绑定设备的扩展属性。

参数
$userACUser ACUser对象,是发起该操作的用户。
$deviceIdint 是要设置其扩展属性的设备的逻辑ID。
$profilearray 是由键值对组成的关联数组,表示设备的扩展属性值。
返回
bool 操作成功时返回TRUE,否则返回FALSE。操作失败时可调用getLastError()获取错误信息。

◆ unbindDevice()

ACBindMgr::unbindDevice (   $subDomain,
  $deviceId,
  $user 
)

解除设备与用户的绑定关系。

参数
$subDomainstring 是要被解绑的设备所属的子域的名字。
$deviceIdint 要被解除绑定关系的设备的逻辑ID。
$userACUser ACUser对象,表示要被解除绑定关系的用户。如果该用户是该设备的管理员,则解除这两者之间的绑定关系时,将解除设备与其它所有用户的绑定。
返回
bool 操作成功返回TRUE,否则返回FALSE。失败时可调用getLastError()方法获取错误消息。

◆ unbindDeviceWithUser()

ACBindMgr::unbindDeviceWithUser (   $adminUser,
  $deviceId,
  $userId 
)

解邦设备与指定用户。

参数
$adminUserACUser ACUser对象,是设备的管理员用户。
$deviceIdint 要被解绑的设备的逻辑ID。
$userIdint 要解绑设备的用户的ID。
返回
bool 解绑成功返回TURE,否则返回FALSE。解邦失败时可调用getLastError()方法获取错误信息。

该类的文档由以下文件生成: