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

Public 成员函数

 __construct ($name, $version, $context)
 
 getDeviceCount ($subDomain='')
 
 getDeviceCountExt ($subDomain='')
 
 listDevices ($subDomain, $offset, $limit)
 
 getDeviceInfo ($physicalDeviceId)
 
 getDevicesInfo ($physicalDeviceIds)
 
 getDeviceLogicalId ($subDomain, $physicalDeviceId)
 
- Public 成员函数 继承自 ACService
 __construct ($name, $version, $context)
 
 getName ()
 
 getVersion ()
 
 getContext ()
 
 getLastError ()
 

额外继承的成员函数

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

详细描述

AbleCloud设备入库服务。

构造及析构函数说明

◆ __construct()

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

构造函数。

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

成员函数说明

◆ getDeviceCount()

ACWarehouseMgr::getDeviceCount (   $subDomain = '')

查询已入库设备的数目。

参数
$subDomainstring 指定要查询的设备所属的子域的名字。如为NULL或空字符串表示不区分子域。
返回
int 返回非负整数表示设备数目。返回负整数表示查询失败,可调用getLastError()方法获取错误信息。

◆ getDeviceCountExt()

ACWarehouseMgr::getDeviceCountExt (   $subDomain = '')

统计入库设备的信息。

参数
$subDomainstring 指定要统计的设备所属的子域的名字。如为NULL或空字符串表示不区分子域。
返回
array|NULL 操作成功时返回一个包含如下三个键的关联数组:count、activeCount、onlineCount,分别表示入库的设备总数、已激活设备数,以及当前在线设备数。 操作失败时返回NULL,并且可以调用getLastError()方法获取错误信息。

◆ getDeviceInfo()

ACWarehouseMgr::getDeviceInfo (   $physicalDeviceId)

查询设备信息。

参数
$physicalDeviceIdstring 拟查询的设备的物理ID。
返回
ACDeviceInfo | NULL 操作成功时返回ACDeviceInfo对象,失败时返回NULL。失败时可调用getLastError()方法获取错误信息。

◆ getDeviceLogicalId()

ACWarehouseMgr::getDeviceLogicalId (   $subDomain,
  $physicalDeviceId 
)

取设备的逻辑ID。

参数
$subDomainstring 拟查询的设备所属的子域的名字。
$physicalDeviceIdstring 拟查询的设备的物理ID。
返回
int 返回设备的逻辑ID。有效的逻辑ID是正整数。返回值小于0时表示操作失败,并可调用getLastError()方法获取错误信息。

◆ getDevicesInfo()

ACWarehouseMgr::getDevicesInfo (   $physicalDeviceIds)

批量查询设备信息。

参数
$physicalDeviceIdsarray 拟查询的设备的物理ID组成的数组。
返回
array | NULL 操作成功时返回ACDeviceInfo对象的数组,否则返回NULL。失败时可调用getLastError()方法获取错误信息。

◆ listDevices()

ACWarehouseMgr::listDevices (   $subDomain,
  $offset,
  $limit 
)

批量查询设备信息。

参数
$subDomainstring 指定要查询的设备所属的子域的名字。如为NULL或空字符串表示不区分子域。
$offsetint $offset与$limit参数用于实现分页查询的效果。$offset是从0开始的偏移量,表示返回设备列表中从第offset位置开始的共limit个设备的信息。
$limitint $offset与$limit参数用于实现分页查询的效果。$limit是正整数,表示返回设备列表中从第offset位置开始的共limit个设备的信息。
返回
array | NULL 操作成功时返回ACDeviceInfo对象的数组,否则返回NULL。失败时可调用getLastError()方法获取错误信息。

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