站点用户管理

功能说明

TuyaSmartResidence 的 TuyaResidenceSiteInvitation 类用于站点中的用户邀请和变更。

• 商业端站点：商家端授权的站点，用户角色最高为 admin。不能操作站点的删除、转移、信息修改。
• 单用户端站点：用户自建站点，创建人角色为 owner，拥有最高权限。

创建邀请码

接口说明

仅用于用户自建站点，即单用户端站点。TuyaResidenceSiteInvitation 中有创建邀请码的实例方法。

- (void)invitationMemberWithCreateRequestModel:(TuyaResidenceInvitationCreateRequestModel *)createRequestModel
                                       success:(void(^)(TuyaResidenceInvitationResultModel *invitationResultModel))success
                                       failure:(TYFailureError)failure;

参数说明

参数	说明
createRequestModel	创建邀请码请求模型
success	成功回调
failure	失败回调

TuyaResidenceInvitationCreateRequestModel 数据模型

字段	类型	描述
siteID	long long	需要邀请成员加入的站点 ID
needMsgContent	BOOL	是否需要邀请文案信

TuyaResidenceInvitationResultModel 数据模型

字段	类型	描述
invitationMsgContent	NSString	邀请文案信
invitationCode	NSString	邀请码
invitationId	NSNumber	邀请码 ID

示例代码

[self.siteInvitation invitationMemberWithCreateRequestModel:model success:^(TuyaResidenceInvitationResultModel * _Nonnull invitationResultModel) {

} failure:^(NSError *error) {

}];

通过邀请码加入一个站点

接口说明

- (void)joinSiteWithInvitationCode:(NSString *)invitationCode
                           success:(TYSuccessBOOL)success
                           failure:(TYFailureError)failure;

参数说明

参数	说明
invitationCode	邀请码
success	成功回调
failure	失败回调

示例代码

[self.siteInvitation joinSiteWithInvitationCode:invitationCode success:^(BOOL result) {

} failure:^(NSError *error) {

}];

发送邀请码重新邀请

接口说明

- (void)reinviteInvitationWithReinviteRquestModel:(TuyaResidenceInvitationCreateRequestModel *)createRequestModel
                                          success:(void(^)(TuyaResidenceInvitationResultModel *invitationResultModel))success
                                          failure:(TYFailureError)failure;

参数说明

参数	说明
createRequestModel	创建邀请码请求模型
success	成功回调
failure	失败回调

示例代码

[self.siteInvitation reinviteInvitationWithReinviteRquestModel:model success:^(TuyaResidenceInvitationResultModel * _Nonnull invitationResultModel) {

} failure:^(NSError *error) {

}];

通过邮箱或手机号邀请

接口说明

- (void)addMemberWithSiteId:(long long)siteId
                   nickName:(NSString *)nickName
                   userName:(NSString *)userName
                    isAdmin:(BOOL)isAdmin
               isAutoAccept:(BOOL)isAutoAccept
                    success:(TYSuccessHandler)success
                    failure:(TYFailureError)failure;

参数说明

参数	说明
siteId	站点 ID
nickName	用户昵称
userName	用户账号，支持手机和邮箱，如果是手机账号，需要拼接国家码 格式为 国家码-手机号，如 00-1234567
isAdmin	被邀请人是否设置为管理员 1：是 0：不是 此参数仅单用户端站点下有效
isAutoAccept	被邀请人是否自动接受 1：是 0：不是 此参数仅单用户端站点下有效
success	成功回调
failure	失败回调

示例代码

[self.siteInvitation addMemberWithSiteId:[Helper getCurrentSiteModel].siteId nickName:_nicknameTextField.text userName:_accountTextField.text isAdmin:NO isAutoAccept:YES success:^{

} failure:^(NSError *error) {

}];

撤销邀请码对应的邀请

接口说明

- (void)cancelInvitationWithInvitationID:(NSNumber *)invitationID
                                 success:(TYSuccessBOOL)success
                                 failure:(TYFailureError)failure;

参数说明

参数	说明
invitationID	邀请码 ID
success	成功回调
failure	失败回调

示例代码

[self.siteInvitation cancelInvitationWithInvitationID:invitationID success:^(BOOL result) {

} failure:^(NSError *error) {

}];

查询邀请记录

返回用户自建站点的邀请记录。

接口说明

- (void)fetchInvitationRecordListWithSiteID:(long long)siteID
                                    success:(void(^)(NSArray<TuyaResidenceInvitationRecordModel *> *invitationRecordList))success
                                    failure:(TYFailureError)failure;

参数说明

参数	说明
siteID	站点 ID
success	成功回调
failure	失败回调

示例代码

[self.siteInvitation fetchInvitationRecordListWithSiteID:siteID success:^(NSArray<TuyaResidenceInvitationRecordModel *> * _Nonnull invitationRecordList) {

} failure:^(NSError *error) {

}];