简体中文
简体中文
English
联系我们
注册
登录
layout空间导航

成员管理

更新时间:2022-02-17 06:49:38下载pdf

TuyaCommunityHouseMemberService 用于对房屋成员的一些操作服务,其中包括添加成员、迁出成员、删除成员、查询成员详情、查询成员列表等API。

功能说明

添加成员

对所选房屋添加成员。

接口说明

- (void)addMemberWithCommunityId:(NSString *)communityId
                       roomId:(NSString *)roomId
                      realName:(NSString *)realName
                           sex:(TuyaCommunityGenderType)sex
                   phoneNumber:(NSString *)phoneNumber
                      userType:(NSString *)userType
                          role:(TuyaCommunityMemberRole)role
                    expireTime:(NSString * _Nullable)expireTime
                       success:(void(^)(NSString *roomUserId))success
                       failure:(void(^)(NSError *error))failure;

参数说明

参数 说明
communityId 小区 ID
roomId 房号 ID
realName 真实姓名
sex 成员性别:
  • TuyaCommunityGenderTypeMale:男
  • TuyaCommunityGenderTypeFemale:女
phoneNumber 手机号码
userType 成员类型,可从成员类型列表中查询
role 房屋成员权限:
  • TuyaCommunityMemberRoleCustom:自定义成员
  • TuyaCommunityMemberRoleMember:房屋成员
  • TuyaCommunityMemberRoleAdmin:管理员
  • TuyaCommunityMemberRoleOwner:拥有者
  • TuyaCommunityMemberRoleUnknown:无效成员,成员会失效
expireTime 到期时间,针对租客类型,非必传
success 成功回调
failure 失败回调

示例代码

[self.service addMemberWithCommunityId:@"xxx"
                                roomId:@"xxx"
                              realName:@"xxx"
                                   sex:TuyaCommunityGenderTypeMale
                           phoneNumber:@"xxx"
                              userType:@"xxx"
                                  role:TuyaCommunityMemberRoleMember
                            expireTime:nil
                               success:^(NSString * _Nonnull roomUserId) {
    // success handler
}
                               failure:^(NSError * _Nonnull error) {
    // failure handler
}];

查询成员详情

查询房屋下成员的详细数据。

接口说明

- (void)getMemberDetailWithCommunityId:(NSString *)communityId
                            roomUserId:(NSString *)roomUserId
                               success:(void(^)(TuyaCommunityMemberModel *result))success
                               failure:(void(^)(NSError *error))failure;

参数说明

参数 说明
communityId 小区 ID
roomUserId 人房绑定关系 ID
success 成功回调
failure 失败回调

示例代码

[self.service getMemberDetailWithCommunityId:@"xxx"
                                  roomUserId:@"xxx"
                                     success:^(TuyaCommunityMemberModel * _Nonnull result) {
    // success handler
} failure:^(NSError * _Nonnull error) {
    // failure handler
}];

查询已迁出成员详情

查询房屋下已迁出成员的详细数据。

接口说明

- (void)getMoveOutMemberDetailWithCommunityId:(NSString *)communityId
                                   roomUserId:(NSString *)roomUserId
                                      success:(void(^)(TuyaCommunityMemberModel *result))success
                                      failure:(void(^)(NSError *error))failure;

参数说明

参数 说明
communityId 小区 ID
roomUserId 人房绑定关系 ID
success 成功回调
failure 失败回调

示例代码

[self.service getMoveOutMemberDetailWithCommunityId:@"xxx"
                                         roomUserId:@"xxx"
                                            success:^(TuyaCommunityMemberModel * _Nonnull result) {
                                               // success handler
                                          } failure:^(NSError * _Nonnull error) {
                                              // failure handler
}];

查询成员列表

接口说明

- (void)getMemberListWithCommunityId:(NSString *)communityId
                             houseId:(long long)houseId
                             success:(void(^)(NSArray<TuyaCommunityMemberModel *>*list))success
                             failure:(void(^)(NSError *error))failure;

参数说明

参数 说明
communityId 小区 ID
houseId 房屋 ID
success 成功回调
failure 失败回调

示例代码

[self.service getMemberListWithCommunityId:@"xxx"
                                   houseId:@"xxx"
                                   success:^(NSArray<TuyaCommunityMemberModel *> * _Nonnull list) {
    // success handler
} failure:^(NSError * _Nonnull error) {
    // failure handler
}];

查询已迁出成员列表

接口说明

- (void)getMemberListWithCommunityId:(NSString *)communityId
                             houseId:(long long)houseId
                             success:(void(^)(NSArray<TuyaCommunityMemberModel *>*list))success
                             failure:(void(^)(NSError *error))failure;

参数说明

参数 说明
communityId 小区 ID
houseId 房屋 ID
success 成功回调
failure 失败回调

示例代码

[self.service getMoveOutMemberListWithCommunityId:@"xxx"
                                          houseId:@"xxx"
                                          success:^(NSArray<TuyaCommunityMemberModel *> * _Nonnull list) {
    // success handler
} failure:^(NSError * _Nonnull error) {
    // failure handler
}];

查询成员类型列表

接口说明

- (void)getMemberTypeListWithRoomId:(NSString *)roomId
                            success:(void(^)(NSArray<TuyaCommunityMemberTypeModel *>*list))success
                            failure:(void(^)(NSError *error))failure;

参数说明

参数 说明
roomId 房号 ID
success 成功回调
failure 失败回调

示例代码

[self.service getMemberTypeListWithroomId:@"xxx"
                                  success:^(NSArray<TuyaCommunityMemberTypeModel *> * _Nonnull list) {
    // success handler
} failure:^(NSError * _Nonnull error) {
    // failure handler
}];

审核成员

接口说明

- (void)auditMemberWithCommunityId:(NSString *)communityId
                        roomUserId:(NSString *)roomUserId
                             audit:(TuyaCommunityMemberAuditStatus)audit
                              role:(TuyaCommunityMemberRole)role
                           success:(void(^)(void))success
                           failure:(void(^)(NSError *error))failure;

参数说明

参数 说明
communityId 小区 ID
roomUserId 人房绑定关系 ID
audit 审核状态:
  • TuyaCommunityMemberAuditStatusPass 通过
  • TuyaCommunityMemberAuditStatusFailure 失败
role 房屋智家角色:
  • TuyaCommunityMemberRoleMember 成员
  • TuyaCommunityMemberRoleAdmin 管理员
  • TuyaCommunityMemberRoleOwner 拥有者
success 成功回调
failure 失败回调

示例代码

[self.service getMemberTypeListWithroomId:@"xxx"
                                  success:^(NSArray<TuyaCommunityMemberTypeModel *> * _Nonnull list) {
    // success handler
} failure:^(NSError * _Nonnull error) {
    // failure handler
}];

查询用户认证状态

接口说明

- (void)getUserCertificationInfoWithSuccess:(void(^)(TuyaCommunityUserCertificationInfoModel *result))success
                                    failure:(void(^)(NSError *error))failure;

参数说明

参数 说明
success 成功回调
failure 失败回调

示例代码

[self.service getUserCertificationInfoWithSuccess:^(TuyaCommunityUserCertificationInfoModel * _Nonnull result) {
    // success handler
} failure:^(NSError * _Nonnull error) {
    // failure handler
}];

注意事项

此接口主要是在社区认证真实姓名和手机号码,此步是添加房屋的前提,只有认证后,才可添加房屋。

认证用户信息

接口说明

- (void)verifyUserInfoWithRealName:(NSString *)realName
                               sex:(TuyaCommunityGenderType)sex
                            idCard:(NSString * _Nullable)idCard
                           success:(void(^)(void))success
                           failure:(void(^)(NSError *error))failure;

参数说明

参数 说明
realName 真实姓名
sex 性别
idCard 身份证,非必选
success 成功回调
failure 失败回调

示例代码

[self.service verifyUserInfoWithRealName:@"xxx"
                                     sex:TuyaCommunityGenderTypeMale
                                  idCard:nil
                                 success:^{
    // success handler
} failure:^(NSError * _Nonnull error) {
    // failure handler
}];
  • 当前用户查询用户认证状态结果为未认证时,需要调用该接口完成用户认证,然后可以执行添加房屋的操作。
  • 添加房屋调用 TuyaCommunityHouseManager 类的 addHouseWithName:communityId:roomId:userType:expireTime:success:failure: 方法。

更新成员信息

该接口可以用于修改房屋下某个成员的房屋智家角色,通常用于转移智家拥有者。

接口说明

- (void)updateMemberRoleWithMemberId:(long long)memberId
                                role:(TuyaCommunityMemberRole)role
                             success:(void(^)(void))success
                             failure:(void(^)(NSError *error))failure;

参数说明

参数 说明
memberId 成员 ID
role 房屋智家角色:
  • TuyaCommunityMemberRoleMember:自定义成员
  • TuyaCommunityMemberRoleAdmin:管理员
  • TuyaCommunityMemberRoleOwner:拥有者
success 成功回调
failure 失败回调

示例代码

[self.service updateMemberRoleWithMemberId:0
                                      role:TuyaCommunityMemberRoleMember
                                   success:^{
    // success handler
} failure:^(NSError * _Nonnull error) {
    // failure handler
}];
  • TuyaCommunityMemberRole 角色的权限级别大小为 Custom < Member < Admin < Owner,每级角色只能管理同级及下级角色。
  • TuyaCommunityMemberRoleOwner 智家拥有者为当前房屋下的最高智家角色。只有用户为处于智家拥有者的角色,才可对当前房屋下的其他成员进行智家所有者转移。

迁出成员

业主用户想迁出非业主成员时,可以调用迁出成员接口。

接口说明

- (void)moveOutMemberWithCommunityId:(NSString *)communityId
                          roomUserId:(NSString *)roomUserId
                             success:(void(^)(void))success
                             failure:(void(^)(NSError *error))failure;

参数说明

参数 说明
communityId 小区 ID
roomUserId 人房绑定关系 ID
success 成功回调
failure 失败回调

示例代码

[self.service moveOutMemberWithCommunityId:@"xxx"
                                roomUserId:@"xxx"
                                   success:^{
    // success handler
} failure:^(NSError * _Nonnull error) {
    // failure handler
}];

删除成员

接口说明

- (void)deleteMemberWithCommunityId:(NSString *)communityId
                            houseId:(long long)houseId
                         roomUserId:(NSString *)roomUserId
                            success:(void(^)(void))success
                            failure:(void(^)(NSError *error))failure;

参数说明

参数 说明
communityId 小区 ID
houseId 房屋 ID
roomUserId 人房绑定关系 ID
success 成功回调
failure 失败回调

示例代码

[self.service deleteMemberWithCommunityId:@"xxx"
                                  houseId:0
                               roomUserId:@"xxx"
                                  success:^{
    // success handler
} failure:^(NSError * _Nonnull error) {
    // failure handler
}];

对象说明

TuyaCommunityMemberModel

属性 类型 说明
memberId long long 成员 ID
headPic NSString 头像
sex TuyaCommunityGenderType 性别:
  • TuyaCommunityGenderTypeMale 男
  • TuyaCommunityGenderTypeFemale 女
nickName NSString 昵称
realName NSString 真名
account NSString 账号
roomUserId NSString 人房绑定关系 ID
houseId long long 房屋 ID
userTypeName NSString 成员身份类型,如业主
userTypeCode NSString 当前用户的成员身份类型 code:
  • HOUSEHOLDER:业主
  • FAMILY:家人
  • TENANT:租客
  • FRIEND:朋友
  • RELATIVES:亲属
  • COLLEAGUE:同事
  • DECORATOR:装修人员
  • BABYSITTER:保姆
  • OTHER:其它
role TuyaCommunityMemberRole 房屋成员权限(智家权限):
  • TuyaCommunityMemberRoleCustom 自定义成员
  • TuyaCommunityMemberRoleMember 房屋成员
  • TuyaCommunityMemberRoleAdmin 管理员
  • TuyaCommunityMemberRoleOwner 拥有者
audit TuyaCommunityMemberAuditStatus 成员审核状态:
  • TuyaCommunityMemberAuditStatusPending 待审核
  • TuyaCommunityMemberAuditStatusFailure 审核失败
  • TuyaCommunityMemberAuditStatusPass 成功
dealStatus TuyaCommunityMemberInviteStatus 成员邀请状态
countryCode NSString 国家码
activeStatus BOOL 激活状态
uploaded BOOL 成员是否上传过人脸
mobile NSString 手机号码
uid NSString 用户ID
applySource TuyaCommunityMemberApplySourceType 成员申请渠道来源类型