本文档已停止维护，请移步到涂鸦开发者文档中心查看最新文档：涂鸦智能文档中心

1. 家庭业务包

1.1. 功能介绍

家庭业务包主要囊括家庭管理、成员管理、房间管理等业务，这些是对配网后的设备进行管理的基础条件。设备在配网后可设置家庭中设备所处的房间，同时，家庭下拥有不同权限的家庭成员对应着不同的操作权限，家庭也是场景智能执行的最大单位。

1.2. 接入组件

在工程的 Podfile 文件中添加家庭业务包组件，并执行 pod update 命令

source "https://github.com/TuyaInc/TuyaPublicSpecs.git"
source 'https://cdn.cocoapods.org/'

target 'your_target_name' do
  # TuyaSmart SDK
  pod "TuyaSmartHomeKit"
  # 添加 家庭业务包
  pod 'TuyaSmartFamilyBizBundle', '~> 3.22.0'
end

1.3. 服务协议

1.3.1. 提供服务

家庭业务包实现 TYFamilyProtocol 协议以提供服务，在 TYModuleServices 组件中查看 TYFamilyProtocol.h 协议文件内容为：

#import <Foundation/Foundation.h>
#import <UIKit/UIKit.h>

typedef void(^DoneActionBlock)(NSString *changedName);

/// Family Management Service
@protocol TYFamilyProtocol <NSObject>

@optional

/// jump to Family Management ViewController
- (void)gotoFamilyManagement;

@end

1.4. 使用指南

1.4.1. 注意事项

使用任何接口之前，务必确认用户已登录

1.4.2. 跳转到家庭管理页面

Objective-C 示例

#import <TYModuleServices/TYModuleServices.h>
#import <TuyaSmartBizCore/TuyaSmartBizCore.h>

id<TYFamilyProtocol> impl = [[TuyaSmartBizCore sharedInstance] serviceOfProtocol:@protocol(TYFamilyProtocol)];
if ([impl respondsToSelector:@selector(gotoFamilyManagement)]) {
    [impl gotoFamilyManagement];
}

Swift 示例

guard let impl = TuyaSmartBizCore.sharedInstance().service(of: TYFamilyProtocol.self) as? TYFamilyProtocol else {
    return
}
impl.gotoFamilyManagement?()

1.4.3. 邀请家庭成员

邀请

在 家庭设置页面有个 添加成员 功能，目前有两类邀请添加方式：

通过涂鸦账号邀请，输入对方的账号信息即可邀请对方加入自己的家庭
通过邀请码方式邀请对方加入家庭

接受邀请

对于邀请码方式，直接在家庭管理->加入一个家庭页面输入邀请码即可
对于涂鸦账号邀请方式，对方再次进入家庭管理页面后会显示待加入家庭, 点击可以接受或者拒绝

若要实现实时弹出邀请弹窗的需求，可以通过设置 TuyaSmartHomeManager 的代理实现

- (void)homeManager:(TuyaSmartHomeManager *)manager didAddHome:(TuyaSmartHomeModel *)home;

通过 TuyaSmartHomeModel 的 dealStatus判断是否是新邀请家庭

typedef NS_ENUM(NSUInteger, TYHomeStatus) {
    TYHomeStatusPending = 1,      /**< 待加入 受邀者未决定是否加入对应家庭 Not deciding whether to join the home */
    TYHomeStatusAccept,           /**< 受邀者已同意加入对应家庭 The invitee has agreed to join the home */
    TYHomeStatusReject            /**< 受邀者已拒绝加入对应家庭 The invitee have refused to join the home */
};

实现邀请弹窗代码示例 Objective-C：

TuyaSmartHomeManager *manager = [TuyaSmartHomeManager new];
manager.delegate = self;

....
以下为当前控制器代理实现代码部分

- (void)homeManager:(TuyaSmartHomeManager *)manager didAddHome:(TuyaSmartHomeModel *)homeModel {
    if (homeModel.dealStatus <= TYHomeStatusPending && homeModel.name.length > 0) {
    ///弹出接受邀请弹窗代码

    ///接受邀请
    TuyaSmartHome *home = [TuyaSmartHome homeWithHomeId:homeModel.homeId];
    [home joinFamilyWithAccept:YES success:^(BOOL result) {} failure:^(NSError *error) {}];

    ///拒绝邀请
    [home joinFamilyWithAccept:NO success:^(BOOL result) {} failure:^(NSError *error) {}];
    }
}

实现邀请弹窗代码示例 Swift：

let manager = TuyaSmartHomeManager()
manager.delegate = self

....
以下为当前控制器代理实现代码部分

func homeManager(_ manager: TuyaSmartHomeManager!, didAddHome homeModel: TuyaSmartHomeModel!) {
    if (homeModel.dealStatus.rawValue <= TYHomeStatus.pending.rawValue) && (homeModel.name.isEmpty == false) {
        ///弹出接受邀请弹窗代码

        ///接受邀请
        let home = TuyaSmartHome(homeId: homeModel.homeId)
        home?.joinFamily(withAccept: true, success: { (result) in

        }, failure: { (error) in

        })

        ///拒绝邀请
        home?.joinFamily(withAccept: false, success: { (result) in

        }, failure: { (error) in

        })

    }
}

家庭