文档中心

主题

房间信息 ​

功能概述 ​

本文介绍了如何管理家庭下房间信息, 包括创建房间, 修改房间名称, 删除房间, 移入设备到房间, 设置房间排序, 房间中设备列表等。

房间管理 ​

创建房间 ​

接口说明

创建家庭下房间

objc
- (void)addFamilyRoomWithFid:(NSString *)fid
                    roomName:(NSString *)roomName
                     success:(QuecVoidBlock)success
                     failure:(QuecErrorBlock)failure;

参数说明

参数是否必传说明
fid是家庭id
roomName是房间名称
success否接口请求成功回调
failure否接口请求失败回调

示例代码

objc
[QuecSmartHomeService.sharedInstance addFamilyRoomWithFid:@"your fid" roomName:@"room name" success:^{
    /// Next Action
} failure:^(NSError *error) {
    NSLog(@"check error: %@", error);
}];

修改房间名称 ​

接口说明

修改房间名称

objc
- (void)setFamilyRoomWithFrid:(NSString *)frid
                     roomName:(NSString *)roomName
                      success:(QuecVoidBlock)success
                      failure:(QuecErrorBlock)failure;

参数说明

参数是否必传说明
frid是家庭房间id
roomName是房间名称
success否接口请求成功回调
failure否接口请求失败回调

示例代码

objc
[QuecSmartHomeService.sharedInstance setFamilyRoomWithFrid:@"your frid" roomName:@"room name" success:^{
    /// Next Action
} failure:^(NSError *error) {
    NSLog(@"check error: %@", error);
}];

删除房间 ​

接口说明

删除房间, 支持批量删除

objc
- (void)deleteFamilyRoomsWithIds:(NSArray<NSString *> *)fridList
                         success:(QuecVoidBlock)success
                         failure:(QuecErrorBlock)failure;

参数说明

参数是否必传说明
fridList是房间id列表
success否接口请求成功回调
failure否接口请求失败回调

示例代码

objc
[QuecSmartHomeService.sharedInstance deleteFamilyRoomsWithIds:@[@"room id1", @"room id2"] success:^{
    /// Next Action
} failure:^(NSError *error) {
    NSLog(@"check error: %@", error);
}];

移入设备到房间 ​

接口说明

移入设备到房间, 支持批量添加

objc
- (void)addDeviceInFamilyRoomWithDeviceList:(NSArray<QuecAddDeviceEnterModel *> *)deviceList
                                    success:(void(^)(QuecFamilyAddDeviceModel *model))success
                                    failure:(QuecErrorBlock)failure;

参数说明

参数是否必传说明
deviceList是设备列表
success否接口请求成功回调
failure否接口请求失败回调

QuecAddDeviceEnterModel属性定义

字段类型描述
pkNSString产品pk
dkNSString设备dk
oldFridNSString原房间号
nFridNSString新房间号

QuecFamilyAddDeviceModel属性定义

字段类型描述
successListNSArray<QuecFamilyAddDeviceListModel *> *执行成功列表
failureListNSArray<QuecFamilyAddDeviceListModel *> *执行失败列表

QuecFamilyAddDeviceListModel属性定义

字段类型描述
oldFridNSString原房间号
nFridNSString新房间号
pkNSString产品pk
dkNSString设备dk
NSIntegerNSInteger错误码（仅failureList有此属性）
NSStringNSString错误提示文案 （仅failureList有此属性）

示例代码

objc
QuecAddDeviceEnterModel *addEnterModel = QuecAddDeviceEnterModel.new;
addEnterModel.pk = @"pk";
addEnterModel.dk = @"dk";
addEnterModel.oldFrid = @"old frid";
addEnterModel.nFrid = @"new frid";
[QuecSmartHomeService.sharedInstance addDeviceInFamilyRoomWithDeviceList:@[addEnterModel] success:^(QuecFamilyAddDeviceModel *model) {
    /// Next Action
} failure:^(NSError *error) {
    NSLog(@"check error: %@", error);
}];

设置房间排序 ​

接口说明

设置房间排序, 设置房间显示优先级

objc
- (void)setFamilyRoomSortWithRoomRortList:(NSArray<QuecSortDeviceEnterModel *> *)roomSortList
                                  success:(QuecVoidBlock)success
                                  failure:(QuecErrorBlock)failure;

参数说明

参数是否必传说明
roomSortList是待排序房间数组
success否接口请求成功回调
failure否接口请求失败回调

QuecSortDeviceEnterModel属性定义

字段类型描述
fridNSString家庭房间ID
roomSortNSString房间顺序，从 0 开始累加，数字小的排列在列表前面，可以不连续，不允许相等

示例代码

objc
QuecSortDeviceEnterModel *sort0 = QuecSortDeviceEnterModel.new;
sort0.roomSort = @"0";
sort0.frid = @"first frid";
QuecSortDeviceEnterModel *sort1 = QuecSortDeviceEnterModel.new;
sort1.roomSort = @"1";
sort1.frid = @"second frid";
[QuecSmartHomeService.sharedInstance setFamilyRoomSortWithRoomRortList:@[sort0, sort1]
                                                                success:^{
    /// Next Action
} failure:^(NSError *error) {
    NSLog(@"check error: %@", error);
}];

房间中设备列表 ​

接口说明

查询房间中设备列表

objc
- (void)getFamilyRoomDeviceListWithFrid:(NSString *)frid 
                             pageNumber:(NSInteger)pageNumber
                               pageSize:(NSInteger)pageSize
                      isGroupDeviceShow:(BOOL)isGroupDeviceShow
                                success:(void(^)(NSArray <QuecDeviceModel *> *list, NSInteger total))success 
                                failure:(QuecErrorBlock)failure;

参数说明

参数是否必传说明
frid是家庭房间id
pageNumber否页码，非必填，默认1
pageSize否页大小，非必填，默认10
isGroupDeviceShow否是否显示群组设备，默认缺省
success否接口请求成功回调
failure否接口请求失败回调

QuecDeviceModel属性定义同设备SDK说明

示例代码

objc
[QuecSmartHomeService.sharedInstance getFamilyRoomDeviceListWithFrid:@"your frid"
                                                              pageNumber:1
                                                                pageSize:10
                                                       isGroupDeviceShow:YES
                                                                 success:^(NSArray<QuecDeviceModel *> *list, NSInteger total) {
    /// Next Action
} failure:^(NSError *error) {
    NSLog(@"check error: %@", error);
}];

家庭下的房间列表 ​

接口说明

查询家庭中的房间列表

objc
- (void)getFamilyRoomListWithFid:(NSString *)fid
                      pageNumber:(NSInteger)pageNumber
                        pageSize:(NSInteger)pageSize
                         success:(void(^)(NSArray <QuecFamilyRoomItemModel *> *list, NSInteger total))success
                         failure:(QuecErrorBlock)failure;

参数说明

参数是否必传说明
fid是家庭id
pageNumber否页码，非必填，默认1
pageSize否页大小，非必填，默认10
success否接口请求成功回调
failure否接口请求失败回调

QuecFamilyRoomItemModel属性定义同上

示例代码

objc
[QuecSmartHomeService.sharedInstance getFamilyRoomListWithFid:@"your fid"
                                                       pageNumber:1
                                                         pageSize:10
                                                          success:^(NSArray<QuecFamilyRoomItemModel *> *list, NSInteger total) {
    /// Next Action
} failure:^(NSError *error) {
    NSLog(@"check error: %@", error);
}];

编辑设备信息 ​

接口说明

编辑设备信息, 设置房间信息 是否常用等

objc
- (void)setDeviceInfoWithModelArray:(NSArray<QuecSetDeviceInfoModel *> *)modelArray
                            success:(void(^)(QuecOperateDeviceRespModel *model))success
                            failure:(QuecErrorBlock)failure;

参数说明

参数是否必传说明
modelArray否待设置房间信息设备列表
success否接口请求成功回调
failure否接口请求失败回调

QuecSetDeviceInfoModel属性定义

字段类型描述
fidNSString家庭Id
dkNSString设备dk
pkNSString产品pk
deviceNameNSString设备名称
isCommonUsedBOOL是否常用：true-常用，false-不是常用
typeint设备类型：1-家庭中的设备，2-用户接收分享的设备，3-用户多绑模式的设备
oldFridNSString移出房间ID
selectFridNSString移入房间ID
shareCodeNSString分享码

QuecOperateDeviceRespModel属性定义同上

示例代码

objc
QuecSetDeviceInfoModel *setInfoModel = QuecSetDeviceInfoModel.new;
setInfoModel.fid = @"your fid";
setInfoModel.dk = @"dk";
setInfoModel.pk = @"pk";
setInfoModel.deviceName = @"device name";
setInfoModel.isCommonUsed = YES;
setInfoModel.type = 3;
setInfoModel.oldFrid = @"old frid"; /// can be null
setInfoModel.selectFrid = @"select frid";
[QuecSmartHomeService.sharedInstance setDeviceInfoWithModelArray:@[setInfoModel]
                                                            success:^(QuecOperateDeviceRespModel *model) {
    /// Next Action
} failure:^(NSError *error) {
    NSLog(@"check error: %@", error);
}];

版权所有 ©2023 上海移远通信技术股份有限公司 版权所有