空间服务

更新时间:2024-05-17 02:32:44下载pdf

空间服务提供空间的基本操作,以及获取空间下设备信息等能力。

通过 IUser.getSpaceType(),判断当前体系是否为空间体系,1 表示空间体系,2 表示资产体系。

常见属性解释

ISpace 接口

接口 说明
getSpaceId(): String 空间的唯一标识符
getSpaceName(): String 空间名称
getParentSpaceId(): String 父级空间的唯一标识符
getPermission(): String 空间权限
  • all:拥有空间的所有权限
  • read:拥有空间的只读权限
getCurrentSubSpaceNum(): Int 子空间数量
getCurrentSpaceDeviceNum(): Int 空间下设备数量
getUserDefinedPath(): String 空间路径

ISpaceDeviceListResult 接口

接口 说明
getDevices(): List 设备列表
getHasMore(): Boolean 是否有更多设备
getLastRowKey(): String 最后一行的 RowKey,用于分页查询
getTotal(): Int 总设备数

ISpaceDevice 接口

接口 说明
getDeviceId(): String 设备 ID
getDeviceName(): String 设备名称
isOnline(): Boolean 设备是否在线,指局域网或者云端在线
getIcon(): String 设备图片
getActiveTime(): Long 设备激活时间戳
getSpaceId(): String 空间 ID
getCategoryName(): String 品类名称
getCategory(): String 品类 Code
getIsGateWay(): Boolean 是否为网关设备
getSub(): Boolean 是否有子设备
getProductName(): String 产品名称
getTimeZone(): String 设备所在时区

IDeviceStatistic 接口

接口 说明
getStatisticType(): String 统计类型
getTotal(): Long 设备总数
getTypeValue(): String 统计类型显示文案

新增空间

参数说明

参数名 类型 是否必填 说明
name String 要创建的名称
parentSpaceId String 父空间的 ID
callback IndustryCallBack 回调函数

代码示例

SpaceService.create("name", "parentSpaceId", new IndustryCallBack() {
            @Override
            public void onSuccess() {
                Log.d(TAG, "onSuccess: ");
            }

            @Override
            public void onError(int i, String s) {
                Log.d(TAG, "onError: ");

            }
        });

修改空间名称

参数说明

参数名 类型 是否必填 说明
spaceId String 要修改的空间的 ID
name String 修改后的名称
callback IndustryCallBack 回调函数

代码示例

SpaceService.update("spaceId", "name", new IndustryCallBack() {
            @Override
            public void onSuccess() {
                Log.d(TAG, "onSuccess: ");

            }

            @Override
            public void onError(int i, String s) {
                Log.d(TAG, "onError: ");

            }
        });

删除空间

参数说明

参数名 类型 是否必填 说明
spaceId String 要删除的空间的 ID
callback IndustryCallBack 回调函数

代码示例

SpaceService.remove("spaceId", new IndustryCallBack() {
            @Override
            public void onSuccess() {
                Log.d(TAG, "onSuccess: ");

            }

            @Override
            public void onError(int i, String s) {
                Log.d(TAG, "onError: ");

            }
        });

获取单个空间属性

参数说明

参数名 类型 是否必填 说明
spaceId String 要查询的空间的 ID
callback IndustryValueCallBack 回调函数

代码示例

SpaceService.space("spaceId", new IndustryValueCallBack<ISpace>() {
            @Override
            public void onSuccess(ISpace iSpace) {
                Log.d(TAG, "onSuccess: ");
            }

            @Override
            public void onError(int i, String s) {
                Log.d(TAG, "onError: ");

            }
        });

获取子空间属性列表

参数说明

参数名 类型 是否必填 说明
spaceId String? 要查询的空间的 ID。如果为 nil,则查询所有子空间
callback IndustryValueCallBack<List> 回调函数,返回查询到的子空间列表

代码示例

SpaceService.subSpaces("spaceId", new IndustryValueCallBack<List<ISpace>>() {
            @Override
            public void onSuccess(List<ISpace> iSpaces) {
                Log.d(TAG, "onSuccess: ");

            }

            @Override
            public void onError(int i, String s) {
                Log.d(TAG, "onError: ");

            }
        });

获取设备统计列表

参数说明

参数名 类型 是否必填 说明
spaceId String 要查询的空间的 ID
callback IndustryValueCallBack<List> 回调函数,返回设备统计列表

代码示例

SpaceService.statistics("spaceId", new IndustryValueCallBack<List<IDeviceStatistic>>() {
            @Override
            public void onSuccess(List<IDeviceStatistic> result) {
                Log.d(TAG, "onSuccess: ");
            }

            @Override
            public void onError(int i, String s) {
                Log.d(TAG, "onError: ");

            }
        });

获取设备列表

参数说明

参数名 类型 是否必填 说明
spaceId String 要查询的空间的 ID
lastRowKey String? 上一次查询返回的最后一行的 RowKey,用于分页查询
callback IndustryValueCallBack 回调函数,返回查询到的设备列表

代码示例

SpaceService.devices("spaceId", "lastRowKey", new IndustryValueCallBack<ISpaceDeviceListResult>() {
            @Override
            public void onSuccess(ISpaceDeviceListResult iSpaceDeviceListResult) {
                Log.d(TAG, "onSuccess: ");
            }

            @Override
            public void onError(int i, String s) {
                Log.d(TAG, "onError: ");

            }
        });

参数说明

参数名 类型 是否必填 说明
spaceId String 要查询的空间的 ID
statisticsType String 统计类型,IDeviceStatistic.getStatisticType
lastRowKey String? 上一次查询返回的最后一行的 RowKey,用于分页查询
pageSize Int 分页数量
callback IndustryValueCallBack 回调函数,返回查询到的设备列表

代码示例

SpaceService.devices("spaceId", null, 20, "lastRowKey", new IndustryValueCallBack<ISpaceDeviceListResult>() {
            @Override
            public void onSuccess(ISpaceDeviceListResult iSpaceDeviceListResult) {
                Log.d(TAG, "onSuccess: ");
            }

            @Override
            public void onError(int i, String s) {
                Log.d(TAG, "onError: ");

            }
        });

查询设备列表

参数说明

参数名 类型 是否必填 说明
spaceId String 要查询的空间的 ID
lastRowKey String? 上一次查询返回的最后一行的 RowKey,用于分页查询
deviceName String 设备名称
pageSize Int 分页数量
callback IndustryValueCallBack 回调函数,返回查询到的设备列表

代码示例

SpaceService.search("spaceId", "灯", 20, "lastRowKey", new IndustryValueCallBack<ISpaceDeviceListResult>() {
            @Override
            public void onSuccess(ISpaceDeviceListResult iSpaceDeviceListResult) {
                Log.d(TAG, "onSuccess: ");
            }

            @Override
            public void onError(int i, String s) {
                Log.d(TAG, "onError: ");

            }
        });

获取单个空间管理实例

参数说明

参数名 类型 是否必填 说明
spaceId String 要查询的空间的 ID

代码示例

ISpaceManager manager = SpaceService.assetManager("spaceId");