src/darwin/Framework/CHIP/CHIPDevicePairingDelegate.h

   1 /**
   2  *
   3  *    Copyright (c) 2020 Project CHIP Authors
   4  *
   5  *    Licensed under the Apache License, Version 2.0 (the "License");
   6  *    you may not use this file except in compliance with the License.
   7  *    You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *    Unless required by applicable law or agreed to in writing, software
  12  *    distributed under the License is distributed on an "AS IS" BASIS,
  13  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *    See the License for the specific language governing permissions and
  15  *    limitations under the License.
  16  */
  17
  18 #import <Foundation/Foundation.h>
  19
  20 NS_ASSUME_NONNULL_BEGIN
  21
  22 typedef NS_ENUM(NSUInteger, CHIPPairingStatus) {
  23     kSecurePairingSuccess = 0,
  24     kSecurePairingFailed,
  25     kNetworkProvisioningSuccess,
  26     kNetworkProvisioningFailed,
  27     kUnknownStatus,
  28 };
  29
  30 typedef NS_ENUM(NSUInteger, CHIPNetworkCredentialType) {
  31     kNetworkCredentialTypeWiFi = 0,
  32     kNetworkCredentialTypeThread,
  33     kNetworkCredentialTypeAll,
  34 };
  35
  36 /**
  37  * The protocol definition for the CHIPDevicePairingDelegate
  38  *
  39  * All delegate methods will be called on the supplied Delegate Queue.
  40  */
  41 @protocol CHIPDevicePairingDelegate <NSObject>
  42 @required
  43 /**
  44  * Notify the delegate when pairing requires network credentials along with the NetworkCredentialType requested
  45  *
  46  */
  47 - (void)onNetworkCredentialsRequested:(CHIPNetworkCredentialType)type;
  48
  49 @optional
  50 /**
  51  * Notify the delegate when pairing status gets updated
  52  *
  53  */
  54 - (void)onStatusUpdate:(CHIPPairingStatus)status;
  55
  56 /**
  57  * Notify the delegate when pairing is completed
  58  *
  59  */
  60 - (void)onPairingComplete:(NSError *)error;
  61
  62 /**
  63  * Notify the delegate when pairing is deleted
  64  *
  65  */
  66 - (void)onPairingDeleted:(NSError *)error;
  67 @end
  68
  69 NS_ASSUME_NONNULL_END