电子钥匙管理

本文介绍如何管理电子钥匙。关于电子钥匙的更多信息，参考 商业门锁 SDK 概述。

获取已创建的电子钥匙列表

接口说明

+ (void)getEKeyListWithSiteId:(long long)siteId
                     deviceId:(NSString *)deviceId
                       pageNo:(NSInteger)pageNo
                     pageSize:(NSInteger)pageSize
                      success:(ThingLockEKeySuccessList)success
                      failure:(ThingFailureError)failure;

参数说明

参数	说明
siteId	站点 ID
deviceId	设备 ID
pageNo	页码，从 1 开始
pageSize	每页数量
success	成功回调
failure	失败回调

示例代码

[ThingLockDevice getEKeyListWithSiteId:siteId
                              deviceId:self.devId
                                pageNo:1
                              pageSize:20
                               success:^(NSArray<ThingEKeyModel *> * _Nullable list, NSInteger totalPage) {

} failure:^(NSError *error) {

}];

创建永久电子钥匙

接口说明

+ (void)createPermanentEKeyWithSiteId:(long long)siteId
                             deviceId:(NSString *)deviceId
                              account:(NSString *)account
                             eKeyName:(NSString *)ekeyName
                              success:(ThingSuccessID)success
                              failure:(ThingFailureError)failure;

参数说明

参数	说明
siteId	站点 ID
deviceId	设备 ID
account	授权电子钥匙的账号
ekeyName	电子钥匙的名称
success	成功回调
failure	失败回调

示例代码

[ThingLockDevice createPermanentEKeyWithSiteId:SiteManager.shared.siteId
                                  deviceId:self.devId
                                   account:self.accountLabel.text
                                  eKeyName:self.eKeyNameLabel.text
                                   success:^(id result) {

} failure:^(NSError *error) {

}];

创建限时电子钥匙

接口说明

+ (void)createLimitEKeyWithSiteId:(long long)siteId
                         deviceId:(NSString *)deviceId
                          account:(NSString *)account
                         eKeyName:(NSString *)ekeyName
            effectiveTimeInterval:(NSTimeInterval)effectiveTimeInterval
              invalidTimeInterval:(NSTimeInterval)invalidTimeInterval
                       workingDay:(NSString *)workingDay
                        startTime:(NSString *)startTime
                          endTime:(NSString *)endTime
                          success:(ThingSuccessID)success
                          failure:(ThingFailureError)failure;

参数说明

参数	说明
siteId	站点 ID
deviceId	设备 ID
account	授权电子钥匙的账号
ekeyName	电子钥匙的名称
effectiveTimeInterval	生效时间，生效时间的整点时间戳，单位秒。例如 15:32，则传入 15:00 的时间戳
invalidTimeInterval	失效时间，失效时间的整点时间戳，单位秒。例如 18:24，则传入 18:00 的时间戳
workingDay	循环模式，例如 1011111，从周日开始到周一，如果是 1 则表示循环，0 则表示不循环
startTime	开始时间，例如 7:00
endTime	结束时间，例如 19:00
success	成功回调
failure	失败回调

示例代码

[ThingLockDevice createLimitEKeyWithSiteId:SiteManager.shared.siteId
                                  deviceId:self.devId
                                   account:self.accountLabel.text
                                  eKeyName:self.eKeyNameLabel.text
                     effectiveTimeInterval:effectiveTime
                       invalidTimeInterval:invalidTime
                                workingDay:@"1000101"
                                 startTime:@"7:00"
                                   endTime:@"19:00"
                                   success:^(id result) {

} failure:^(NSError *error) {

}];

创建单次电子钥匙

接口说明

+ (void)createOnceEKeyWithSiteId:(long long)siteId
                        deviceId:(NSString *)deviceId
                         account:(NSString *)account
                        eKeyName:(NSString *)ekeyName
           effectiveTimeInterval:(NSTimeInterval)effectiveTimeInterval
             invalidTimeInterval:(NSTimeInterval)invalidTimeInterval
                         success:(ThingSuccessID)success
                         failure:(ThingFailureError)failure;

参数说明

参数	说明
siteId	站点 ID
deviceId	设备 ID
account	授权电子钥匙的账号
ekeyName	电子钥匙的名称
effectiveTimeInterval	生效时间，生效时间的整点时间戳，单位秒。例如 15:32，则传入 15:00 的时间戳
invalidTimeInterval	失效时间，失效时间的整点时间戳，单位秒。例如 18:24，则传入 18:00 的时间戳
success	成功回调
failure	失败回调

示例代码

[ThingLockDevice createOnceEKeyWithSiteId:SiteManager.shared.siteId
                                  deviceId:self.devId
                                   account:self.accountLabel.text
                                  eKeyName:self.eKeyNameLabel.text
                     effectiveTimeInterval:effectiveTime
                       invalidTimeInterval:invalidTime
                                   success:^(id result) {

} failure:^(NSError *error) {

}];

获取电子钥匙详情

接口说明

+ (void)getEKeyDetailWithSiteId:(long long)siteId
                       deviceId:(NSString *)deviceId
                         eKeyId:(NSString *)eKeyId
                        success:(ThingLockEKeySuccess)success
                        failure:(ThingFailureError)failure;

参数说明

参数	说明
siteId	站点 ID
deviceId	设备 ID
eKeyId	电子钥匙 ID
success	成功回调
failure	失败回调

示例代码

[ThingLockDevice getEKeyDetailWithSiteId:siteId
                                deviceId:self.devId
                                  eKeyId:self.eKeyId
                                 success:^(ThingEKeyModel * _Nullable eKeyModel) {

} failure:^(NSError *error) {

}];

修改限时电子钥匙信息

接口说明

+ (void)updateLimitEKeyWithSiteId:(long long)siteId
                         deviceId:(NSString *)deviceId
                           eKeyId:(NSString *)eKeyId
                         eKeyName:(NSString *)ekeyName
            effectiveTimeInterval:(NSTimeInterval)effectiveTimeInterval
              invalidTimeInterval:(NSTimeInterval)invalidTimeInterval
                       workingDay:(NSString *)workingDay
                        startTime:(NSString *)startTime
                          endTime:(NSString *)endTime
                          success:(ThingSuccessID)success
                          failure:(ThingFailureError)failure;

参数说明

参数	说明
siteId	站点 ID
deviceId	设备 ID
eKeyId	电子钥匙 ID
eKeyName	电子钥匙名称
effectiveTimeInterval	生效时间，生效时间的整点时间戳，单位秒。例如 15:32，则传入 15:00 的时间戳
invalidTimeInterval	失效时间，失效时间的整点时间戳，单位秒。例如 18:24，则传入 18:00 的时间戳
workingDay	循环模式，例如 1011111，从周日开始到周一，如果是 1 则表示循环，0 则表示不循环
startTime	开始时间，例如 7:00
endTime	结束时间，例如 19:00
success	成功回调
failure	失败回调

示例代码

[ThingLockDevice updateLimitEKeyWithSiteId:siteId
                                  deviceId:self.devId
                                    eKeyId:self.eKeyModel.eKeyId
                                  eKeyName:self.nameLabel.text
                     effectiveTimeInterval:effectiveTime
                       invalidTimeInterval:invalidTime
                                workingDay:workingDay
                                 startTime:startMinute
                                   endTime:endMinute
                                   success:^(id _Nullable result) {

} failure:^(NSError *error) {

}];

修改永久电子钥匙信息

接口说明

+ (void)updatePermanentEKeyWithSiteId:(long long)siteId
                             deviceId:(NSString *)deviceId
                               eKeyId:(NSString *)eKeyId
                             eKeyName:(NSString *)ekeyName
                              success:(ThingSuccessID)success
                              failure:(ThingFailureError)failure;

参数说明

参数	说明
siteId	站点 ID
deviceId	设备 ID
eKeyId	电子钥匙 ID
eKeyName	电子钥匙名称
success	成功回调
failure	失败回调

示例代码

[ThingLockDevice updatePermanentEKeyWithSiteId:siteId
                                      deviceId:self.devId
                                        eKeyId:self.eKeyModel.eKeyId
                                      eKeyName:self.nameLabel.text
                                       success:^(id _Nullable result) {

} failure:^(NSError *error) {

}];

修改单次电子钥匙信息

接口说明

+ (void)updateOnceEKeyWithSiteId:(long long)siteId
                        deviceId:(NSString *)deviceId
                          eKeyId:(NSString *)eKeyId
                        eKeyName:(NSString *)ekeyName
           effectiveTimeInterval:(NSTimeInterval)effectiveTimeInterval
             invalidTimeInterval:(NSTimeInterval)invalidTimeInterval
                         success:(ThingSuccessID)success
                         failure:(ThingFailureError)failure;

参数说明

参数	说明
siteId	站点 ID
deviceId	设备 ID
eKeyId	电子钥匙 ID
eKeyName	电子钥匙名称
effectiveTimeInterval	生效时间，生效时间的整点时间戳，单位秒。例如 15:32，则传入 15:00 的时间戳
invalidTimeInterval	失效时间，失效时间的整点时间戳，单位秒。例如 18:24，则传入 18:00 的时间戳
success	成功回调
failure	失败回调

示例代码

[ThingLockDevice updateOnceEKeyWithSiteId:siteId
                                 deviceId:self.devId
                                   eKeyId:self.eKeyModel.eKeyId
                                 eKeyName:self.nameLabel.text
                    effectiveTimeInterval:effectiveTime
                      invalidTimeInterval:invalidTime
                                  success:^(id _Nullable result) {

} failure:^(NSError *error) {

}];

删除电子钥匙

接口说明

+ (void)removeEKeyWithSiteId:(long long)siteId
                    deviceId:(NSString *)deviceId
                      eKeyId:(NSString *)eKeyId
                     success:(ThingSuccessID)success
                     failure:(ThingFailureError)failure;

参数说明

参数	说明
siteId	站点 ID
deviceId	设备 ID
eKeyId	电子钥匙
success	成功回调
failure	失败回调

示例代码

[ThingLockDevice removeEKeyWithSiteId:siteId
                             deviceId:self.devId
                               eKeyId:self.eKeyId
                              success:^(id _Nullable result) {

} failure:^(NSError *error) {

}];