/**
 *    Copyright (c) 2024 Project CHIP Authors
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

#import <Matter/MTRBaseDevice.h> // For MTRAttributePath
#import <Matter/MTRDefines.h>

@class MTRProductIdentity;
@class MTREndpointInfo;
@class MTRNetworkInterfaceInfo;

NS_ASSUME_NONNULL_BEGIN

/**
 * Information read from the commissionee device during commissioning.
 */
NS_SWIFT_SENDABLE
MTR_AVAILABLE(ios(18.4), macos(15.4), watchos(11.4), tvos(18.4))
@interface MTRCommissioneeInfo : NSObject <NSCopying, NSSecureCoding>

/**
 * The product identity (VID / PID) of the commissionee.
 */
@property (nonatomic, copy, readonly) MTRProductIdentity * productIdentity;

/**
 * Endpoint information for all endpoints of the commissionee.
 * Will be present only if readEndpointInformation is set to YES on MTRCommissioningParameters.
 *
 * Use `rootEndpoint` and `-[MTREndpointInfo children]` to traverse endpoints in composition order.
 */
@property (nonatomic, copy, readonly, nullable) NSDictionary<NSNumber *, MTREndpointInfo *> * endpointsById;

/**
 * Endpoint information for the root endpoint of the commissionee.
 * Will be present only if readEndpointInformation is set to YES on MTRCommissioningParameters.
 */
@property (nonatomic, copy, readonly, nullable) MTREndpointInfo * rootEndpoint;

/**
 * Attributes that were read from the commissionee.  This will contain the
 * following, if they are available:
 *
 * 1) The attributes in extraAttributesToRead on MTRCommissioningParameters.
 * 2) The FeatureMap attributes of all Network Commissioning clusters on the commissionee.
 */
@property (nonatomic, copy, readonly, nullable) NSDictionary<MTRAttributePath *, NSDictionary<NSString *, id> *> * attributes MTR_AVAILABLE(ios(26.2), macos(26.2), watchos(26.2), tvos(26.2));

/**
 * Network interfaces the commissionee has.  The array will be empty if there
 * are no network interfaces exposed on the commissionee.
 */
@property (nonatomic, copy, readonly) NSArray<MTRNetworkInterfaceInfo *> * networkInterfaces MTR_UNSTABLE_API;

@end

NS_ASSUME_NONNULL_END
