GizAepHomeManager 家庭管理类

提供家庭、房间、联系人、分组、家庭成员的增删改查接口

目录

API 定义

[sharedInstance]

获取GizAepHomeManager单例的实例

定义

+ (instancetype _Nonnull)sharedInstance

代码示例

GizAepHomeManager *instance = [GizAepHomeManager sharedInstance];

[createHome]

创建家庭

定义

- (void)createHome:(GizAepApiHome* _Nonnull)home callback:(void (^)(AepApiResult* _Nonnull result, GizAepApiHome* _Nullable home))callback;

参数

属性名 描述
home 家庭对象
callback 请求结果，可获取信息查看AepApiResult，GizAepApiHome

回调参数

属性名 描述
result 详细见 AepApiResult 定义
home 家庭对象,创建成功才有值,详细见GizAepApiHome类

代码示例

    GizAepApiHome *home = [[GizAepApiHome alloc] init];
    home.name = @"your_home_name";
    home.wallpaper = @"your_wallpaper";
    [[GizAepHomeManager sharedInstance] createHome:home callback:^(AepApiResult * _Nonnull result, GizAepApiHome * _Nullable home) {  
    }];

[deleteHome]

删除家庭

定义

- (void)deleteHome:(NSString* _Nonnull)homeId callback:(void (^)(AepApiResult* _Nonnull result))callback;

参数

属性名 描述
homeId 家庭id
callback 请求结果，可获取信息查看AepApiResult

回调参数

属性名 描述
result 详细见 AepApiResult 定义

代码示例

[[GizAepHomeManager sharedInstance] deleteHome:@"your_homeId" callback:^(AepApiResult * _Nonnull result) {
}];

[editHome]

编辑家庭

定义

- (void)editHome:(GizAepApiHome* _Nonnull)home callback:(void (^)(AepApiResult* _Nonnull result))callback;

参数

属性名 描述
home 家庭对象
callback 请求结果，可获取信息查看AepApiResult

回调参数

属性名 描述
result 详细见 AepApiResult 定义

代码示例

 [[GizAepHomeManager sharedInstance] editHome:targetHome callback:^(AepApiResult * _Nonnull result) {
 }];

[getHomeList]

获取家庭列表

定义

- (void)getHomeList:(void (^)(AepApiResult* _Nonnull result, NSArray<GizAepApiHome *>* _Nullable homeList))callback;

参数

属性名 描述
callback 请求结果，可获取信息查看AepApiResult，GizAepApiHome

回调参数

属性名 描述
result 详细见 AepApiResult 定义
homeList 账户下的家庭列表，GizAepApiHome数组

代码示例

[[GizAepHomeManager sharedInstance] getHomeList:^(AepApiResult * _Nonnull result, NSArray<GizAepApiHome *> * _Nullable homeList) {
}];

[createRoom]

创建房间

定义

- (void)createRoom:(GizAepApiRoom* _Nonnull)room homeId:(NSString* _Nonnull)homeId callback:(void (^)(AepApiResult * _Nonnull result, GizAepApiRoom* _Nullable room))callback;

参数

属性名 描述
room 房间对象
homeId 家庭id
callback 创建结果，可获取信息查看AepApiResult，GizAepApiRoom

回调参数

属性名 描述
result 详细见 AepApiResult 定义
room 创建家庭成功时，该参数有值，详细见GizAepApiRoom类

代码示例

GizAepApiRoom *tmpRoom = [GizAepApiRoom new];
tmpRoom.name = @"your_room_name";
tmpRoom.icon = @"your_room_icon";
[[GizAepHomeManager sharedInstance] createRoom:tmpRoom homeId:self.testHomeId callback:^(AepApiResult * _Nonnull result, GizAepApiRoom * _Nullable room) {

}];

[deleteRoom]

删除房间

定义

- (void)deleteRoom:(NSString * _Nonnull)roomId callback:(void (^)(AepApiResult * _Nonnull result))callback;

参数

属性名 描述
roomId 房间号ID
callback 删除房间结果回调

回调参数

属性名 描述
result 详细见 AepApiResult 定义

代码示例

[[GizAepHomeManager sharedInstance] deleteRoom:@"your_roomId" callback:^(AepApiResult * _Nonnull result) {
}];

[editRoom]

编辑房间

定义

- (void)editRoom:(GizAepApiRoom* _Nonnull)room callback:(void (^)(AepApiResult * _Nonnull result))callback;

参数

属性名 描述
room 编辑的房间对象
callback 编辑结果，可获取信息查看AepApiResult

回调参数

属性名 描述
result 详细见 AepApiResult 定义

代码示例

[[GizAepHomeManager sharedInstance] editRoom:targetRoom callback:^(AepApiResult * _Nonnull result) {
}];

[getRoomList]

获取房间列表

定义

- (void)getRoomList:(NSString* _Nonnull)homeId callback:(void (^)(AepApiResult* _Nonnull result, NSArray <GizAepApiRoom *>* _Nullable roomList))callback;

参数

属性名 描述
homeId 家庭id
callback 获取结果，可获取信息查看AepApiResultm，GizAepApiRoom

回调参数

属性名 描述
result 详细见 AepApiResult 定义
roomList 家庭下的房间列表，类型是《GizAepApiRoom》数组

代码示例

[[GizAepHomeManager sharedInstance] getRoomList:@"your_homeId" callback:^(AepApiResult * _Nonnull result, NSArray<GizAepApiRoom *> * _Nullable roomList) {
}];

[getMemberList]

获取成员列表

定义

- (void)getMemberList:(NSString* _Nonnull)homeId callback:(void (^)(AepApiResult* _Nonnull result, NSArray <GizHomeMember *>* _Nullable memberList))callback;

参数

属性名 描述
homeId 家庭id
callback 获取结果，可获取信息查看AepApiResultm，GizAepApiRoom

回调参数

属性名 描述
result 详细见 AepApiResult 定义
memberList 《GizHomeMember》数组，获取成员列表成功时有值

代码示例

[[GizAepHomeManager sharedInstance] getMemberList:@"your_homeId" callback:^(AepApiResult * _Nonnull result, NSArray<GizHomeMember *> * _Nullable memberList) {
}];

[remarkMember]

修改家庭成员备注

定义

- (void)remarkMember:(GizHomeMember* _Nonnull)member homeId:(NSString* _Nonnull)homeId callback:(void (^)(AepApiResult * _Nonnull result))callback;

参数

属性名 描述
member 编辑的房间对象
homeId 家庭id
callback 编辑结果，可获取信息查看AepApiResult

回调参数

属性名 描述
result 详细见 AepApiResult 定义

代码示例

[[GizAepHomeManager sharedInstance] getMemberList:@"your_homeId" callback:^(AepApiResult * _Nonnull result, NSArray<GizHomeMember *> * _Nullable memberList) {
            if(result.success && memberList.count > 0){
                GizHomeMember* targetMember = memberList[0];
                targetMember.remark = @"new_remark";
                [[GizAepHomeManager sharedInstance] remarkMember:targetMember homeId:@"your_homeId" callback:^(AepApiResult * _Nonnull result) {
                }];
            }
}];

[deleteMember]

删除家庭成员

定义

- (void)deleteMember:(NSString * _Nonnull)memberId homeId:(NSString* _Nonnull)homeId callback:(void (^)(AepApiResult * _Nonnull result))callback;

参数

属性名 描述
memberId 家庭成员ID
homeId 家庭id
callback 删除家庭成员回调

回调参数

属性名 描述
result 详细见 AepApiResult 定义

代码示例

[[GizAepHomeManager sharedInstance] getMemberList:@"your_homeId" callback:^(AepApiResult * _Nonnull result, NSArray<GizHomeMember *> * _Nullable memberList) {
            if(result.success && memberList.count > 0){
              GizHomeMember* targetMember = memberList[0];
              [[GizAepHomeManager sharedInstance] deleteMember:targetMember.memberId homeId:@"your_homeId" callback:^(AepApiResult * _Nonnull result) {
              }];
            }
}];

[getHomeShareToken]

生成家庭分享token，建议按二维码展示

定义

- (void)getHomeShareToken:(NSString * _Nonnull)homeId minutes:(NSUInteger)minutes times:(NSUInteger)times callback:(void (^)(AepApiResult * _Nonnull result, NSString* _Nullable token))callback;

参数

属性名 描述
homeId 家庭id
minutes 分享token时间，单位为分钟，默认60
times 分享token可被使用次数，默认1次
callback 生成二维码结果回调

回调参数

属性名 描述
result 详细见 AepApiResult 定义
token 家庭分享token，请求成功时有值

代码示例

[[GizAepHomeManager sharedInstance] getHomeShareToken:@"your_homeId" minutes:60 times:1 callback:^(AepApiResult * _Nonnull result, NSString * _Nullable token) {
}];

[checkHome]

检查分享token有效性，用于自动刷新检测

定义

- (void)checkHome:(NSString * _Nonnull)homeId shareToken:(NSString * _Nonnull)token callback:(void (^)(AepApiResult * _Nonnull result,NSString* _Nullable checkResult))callback;

参数

属性名 描述
homeId 家庭id
token 家庭分享token
callback 检查结果回调

回调参数

属性名 描述
result 详细见 AepApiResult 定义
checkResult 返回值含义: 'invalid':失效，'valid':有效，'scanned':被扫码

代码示例

[[GizAepHomeManager sharedInstance] getHomeShareToken:@"your_homeId" minutes:60 times:1 callback:^(AepApiResult * _Nonnull result, NSString * _Nullable token) {
        if(result.success && token){
            [[GizAepHomeManager sharedInstance] checkHome:@"your_homeId" shareToken:token callback:^(AepApiResult * _Nonnull result, NSString * _Nullable checkResult) {
            }];
        }
}];

[acceptHomeShareToken]

接受家庭分享，用户接受另一个用户家庭分享token可以加入另一个用户的家庭，变成成员

定义

- (void)acceptHomeShareToken:(NSString * _Nonnull)token callback:(void (^)(AepApiResult * _Nonnull result))callback;

参数

属性名 描述
token 接受的家庭分享token
callback 接受分享结果回调

回调参数

属性名 描述
result 详细见 AepApiResult 定义

代码示例

[[GizAepHomeManager sharedInstance] acceptHomeShareToken:@"share_home_token" callback:^(AepApiResult * _Nonnull result) {
}];

[quitHome]

退出家庭

定义

- (void)quitHome:(NSString * _Nonnull)homeId callback:(void (^)(AepApiResult * _Nonnull result))callback;

参数

属性名 描述
homeId 家庭id
callback 退出家庭结果回调

回调参数

属性名 描述
result 详细见 AepApiResult 定义

代码示例

[[GizAepHomeManager sharedInstance] quitHome:@"your_homeId" callback:^(AepApiResult * _Nonnull result) {
}];

[createContact]

创建联系人

定义

- (void)createContact:(GizAepContact * _Nonnull)contact homeId:(NSString* _Nonnull)homeId callback:(void (^)(AepApiResult* _Nonnull result, GizAepContact* _Nullable contact))callback;

参数

属性名 描述
contact 联系人对象
homeId 家庭id
callback 请求结果，可获取信息查看AepApiResult，GizAepContact

回调参数

属性名 描述
result 详细见 AepApiResult 定义
contact 联系人对象：GizAepContact, 创建成功时有值

代码示例

    GizAepContact* c = [GizAepContact new];
    c.areaCode = @"your_areaCode";
    c.mobile = @"your_phone_number";
    c.name = @"your_name";
    [[GizAepHomeManager sharedInstance] createContact:c homeId:@"your_homeId" callback:^(AepApiResult * _Nonnull result, GizAepContact * _Nonnull contact) {
    }];

[deleteContact]

删除联系人

定义

- (void)deleteContact:(NSArray<NSString*> * _Nonnull)contactIds callback:(void (^)(AepApiResult* _Nonnull result))callback;

参数

属性名 描述
contactIds 联系人id数组
callback 请求结果，可获取信息查看AepApiResult

回调参数

属性名 描述
result 详细见 AepApiResult 定义

代码示例

[[GizAepHomeManager sharedInstance] deleteContact:@[@"your_contact_id"] callback:^(AepApiResult * _Nonnull result) {
}];

[editContact]

编辑联系人

定义

- (void)editContact:(GizAepContact *)contact homeId:(NSString*)homeId callback:(void (^)(AepApiResult* _Nonnull result))callback;

参数

属性名 描述
contact 联系人对象
homeId 家庭id
callback 请求结果，可获取信息查看AepApiResult，GizAepContact

回调参数

属性名 描述
result 详细见 AepApiResult 定义

代码示例

[[GizAepHomeManager sharedInstance] getContactList:@"your_homeId"  callback:^(AepApiResult * _Nonnull result, NSArray<GizAepContact *> *contactList) {
        if(result.success && contactList && contactList.count > 0){
            GizAepContact* c = contactList[0];
            c.name = @"new_name";
            [[GizAepHomeManager sharedInstance] editContact:c homeId:@"your_homeId" callback:^(AepApiResult * _Nonnull result) {
            }];
        }
    }];

[getContactList]

获取联系人列表

定义

- (void)getContactList:(NSString* _Nonnull)homeId callback:(void (^)(AepApiResult* _Nonnull result , NSArray<GizAepContact *>* _Nullable contactList))callback;

参数

属性名 描述
homeId 家庭id
callback 请求结果，可获取信息查看AepApiResult，GizAepContact

回调参数

属性名 描述
result 详细见 AepApiResult 定义
contactList 获取成功时，返回联系人列表

代码示例

[[GizAepHomeManager sharedInstance] getContactList:@"your_homeId"  callback:^(AepApiResult * _Nonnull result, NSArray<GizAepContact *> *contactList) {
}];

[createGroup]

创建分组

定义

- (void)createGroup:(GizAepGroup* _Nonnull)group roomId:(NSString* _Nonnull)roomId callback:(void (^)(AepApiResult* _Nonnull result, GizAepGroup* _Nullable group))callback;

参数

属性名 描述
group 分组对象
roomId 分组所在房间id
callback 创建分组回调，可获取信息查看AepApiResult，GizAepGroup类属性

回调参数

属性名 描述
result 详细见 AepApiResult 定义
group 创建成功返回的分组对象

代码示例

GizAepGroup* newGroup = [GizAepGroup new];
newGroup.name = @"测试分组";
newGroup.deviceList = [GizWifiSDK sharedInstance].deviceList;
[[GizAepHomeManager sharedInstance] createGroup:newGroup roomId:@"your_roomId" callback:^(AepApiResult * _Nonnull result, GizAepGroup * _Nullable group) {
}];

[editGroup]

编辑分组

定义

- (void)editGroup:(GizAepGroup* _Nonnull)group roomId:(NSString* _Nonnull)roomId callback:(void (^)(AepApiResult* _Nonnull result))callback;

参数

属性名 描述
group 分组对象
roomId 分组所在房间id
callback 编辑分组结果回调

回调参数

属性名 描述
result 详细见 AepApiResult 定义

代码示例

[[GizAepHomeManager sharedInstance] editGroup:group roomId:@"your_roomId" callback:^(AepApiResult * _Nonnull result) {
}];

[deleteGroup]

删除分组

定义

- (void)deleteGroup:(NSString* _Nonnull)groupId roomId:(NSString* _Nonnull)roomId callback:(void (^)(AepApiResult* _Nonnull result))callback;

参数

属性名 描述
groupId 分组对象id
roomId 分组所在房间id
callback 删除分组结果回调

回调参数

属性名 描述
result 详细见 AepApiResult 定义

代码示例

 [[GizAepHomeManager sharedInstance] deleteGroup:@"your_groupId" roomId:@"your_roomId" callback:^(AepApiResult * _Nonnull result) {
 }];

[getGroupDetial]

分组详情

定义

- (void)getGroupDetial:(NSString* _Nonnull)groupId roomId:(NSString* _Nonnull)roomId callback:(void (^)(AepApiResult* _Nonnull result, GizAepGroup* _Nullable group))callback;

参数

属性名 描述
groupId 分组对象id
roomId 分组所在房间id
callback 获取分组详情结果回调

回调参数

属性名 描述
result 详细见 AepApiResult 定义
group 分组详情对象,详情见GizAepGroup

代码示例

[[GizAepHomeManager sharedInstance] getGroupDetial:@"your_groupId" roomId:@"your_roomId" callback:^(AepApiResult * _Nonnull result, GizAepGroup * _Nullable group) {
}];

results matching ""

    No results matching ""