<ThingMatterShareInterfaceProtocol> Protocol Reference

#import <ThingMatterShareInterfaceAPI.h>

Inheritance diagram for <ThingMatterShareInterfaceProtocol>:

Instance Methods
(void)	- getConnectedStatusSuccessWithDevid:success:failure:
(void)	- readSupportedFabricsWithDevid:success:failure:
(void)	- readCommissionedFabricsWithDevid:success:failure:
(void)	- getMultipleFabricPasscodeWithDevid:completion:
(void)	- getMultipleFabricPasscodeForceRefreshWithDevid:completion:
(NSString *)	- generateQrCodeWithDevid:fabricPasscodeModel:
(void)	- sendEnhancedCommissioningCommandWithDevid:fabricPasscodeModel:success:failure:
(void)	- revokeCommissioningCommandWithDevid:success:failure:
(void)	- getWifiDeviceSsidWithDevid:success:failure:
(void)	- writeAccessControlListWithDevId:success:failure:
(void)	- notifyAccessControlListWithDevId:success:failure:
(void)	- readFabricsWithDevid:success:failure:
(void)	- removeFabricDevid:Index:success:failure:
(BOOL)	- checkPipelineAvailableWithDevid:
	Check the device multiple fabric command communicate channels avaliable or not. More...
(void)	- sendEnhancedCommissioningWithDevid:forceRefresh:ssidInfo:success:failure:
(void)	- sendEnhancedCommissioningMethodWithDevid:forceRefresh:ssidInfo:success:failure:
(void)	- getConnectedStatusSuccessWithDevid:success:failure:
(void)	- readSupportedFabricsWithDevid:success:failure:
(void)	- readCommissionedFabricsWithDevid:success:failure:
(void)	- getMultipleFabricPasscodeWithDevid:completion:
(void)	- getMultipleFabricPasscodeForceRefreshWithDevid:completion:
(NSString *)	- generateQrCodeWithDevid:fabricPasscodeModel:
(void)	- sendEnhancedCommissioningCommandWithDevid:fabricPasscodeModel:success:failure:
(void)	- revokeCommissioningCommandWithDevid:success:failure:
(void)	- getWifiDeviceSsidWithDevid:success:failure:
(void)	- writeAccessControlListWithDevId:success:failure:
(void)	- notifyAccessControlListWithDevId:success:failure:
(void)	- readFabricsWithDevid:success:failure:
(void)	- removeFabricDevid:Index:success:failure:
(BOOL)	- checkPipelineAvailableWithDevid:
	Check the device multiple fabric command communicate channels avaliable or not. More...
(void)	- sendEnhancedCommissioningWithDevid:forceRefresh:ssidInfo:success:failure:
(void)	- sendEnhancedCommissioningMethodWithDevid:forceRefresh:ssidInfo:success:failure:

Detailed Description

Definition at line 24 of file ThingMatterShareInterfaceAPI.h.

Method Documentation

checkPipelineAvailableWithDevid: [1/2]

- (BOOL) checkPipelineAvailableWithDevid:

(NSString *)

devid

Check the device multiple fabric command communicate channels avaliable or not.

checkPipelineAvailableWithDevid: [2/2]

- (BOOL) checkPipelineAvailableWithDevid:

(NSString *)

devid

Check the device multiple fabric command communicate channels avaliable or not.

generateQrCodeWithDevid:fabricPasscodeModel: [1/2]

- (NSString *) generateQrCodeWithDevid:		(NSString *)	devid
fabricPasscodeModel:		("This api is deprecate. Please use `-sendEnhancedCommissioningWithDevid:forceRefresh:ssidInfo:success:failure:` directly")	__deprecated_msg

generateQrCode 生成二维码内容

Returns

QrCode

generateQrCodeWithDevid:fabricPasscodeModel: [2/2]

- (NSString *) generateQrCodeWithDevid:		(NSString *)	devid
fabricPasscodeModel:		("This api is deprecate. Please use `-sendEnhancedCommissioningWithDevid:forceRefresh:ssidInfo:success:failure:` directly")	__deprecated_msg

generateQrCode 生成二维码内容

Returns

QrCode

getConnectedStatusSuccessWithDevid:success:failure: [1/2]

- (void) getConnectedStatusSuccessWithDevid:		(NSString *)	devid
success:		(ThingSuccessHandler)	success
failure:		("This api is deprecate.")	__deprecated_msg

get matter connected Status 获取matter连接状态

Parameters

devid	devid
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

getConnectedStatusSuccessWithDevid:success:failure: [2/2]

- (void) getConnectedStatusSuccessWithDevid:		(NSString *)	devid
success:		(ThingSuccessHandler)	success
failure:		("This api is deprecate.")	__deprecated_msg

get matter connected Status 获取matter连接状态

Parameters

devid	devid
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

getMultipleFabricPasscodeForceRefreshWithDevid:completion: [1/2]

- (void) getMultipleFabricPasscodeForceRefreshWithDevid:		(NSString *)	devid
completion:		("This api is deprecate. Please use `-sendEnhancedCommissioningWithDevid:forceRefresh:ssidInfo:success:failure:` directly")	__deprecated_msg

getMultipleFabricPasscode

Parameters

devid	devid
completionBlock	Called when the task is finished.

getMultipleFabricPasscodeForceRefreshWithDevid:completion: [2/2]

- (void) getMultipleFabricPasscodeForceRefreshWithDevid:		(NSString *)	devid
completion:		("This api is deprecate. Please use `-sendEnhancedCommissioningWithDevid:forceRefresh:ssidInfo:success:failure:` directly")	__deprecated_msg

getMultipleFabricPasscode

Parameters

devid	devid
completionBlock	Called when the task is finished.

getMultipleFabricPasscodeWithDevid:completion: [1/2]

- (void) getMultipleFabricPasscodeWithDevid:		(NSString *)	devid
completion:		("This api is deprecate. Please use `-sendEnhancedCommissioningWithDevid:forceRefresh:ssidInfo:success:failure:` directly")	__deprecated_msg

getMultipleFabricPasscode

Parameters

devid	devid
completionBlock	Called when the task is finished.

getMultipleFabricPasscodeWithDevid:completion: [2/2]

- (void) getMultipleFabricPasscodeWithDevid:		(NSString *)	devid
completion:		("This api is deprecate. Please use `-sendEnhancedCommissioningWithDevid:forceRefresh:ssidInfo:success:failure:` directly")	__deprecated_msg

getMultipleFabricPasscode

Parameters

devid	devid
completionBlock	Called when the task is finished.

getWifiDeviceSsidWithDevid:success:failure: [1/2]

- (void) getWifiDeviceSsidWithDevid:		(NSString *)	devid
success:		(ThingSuccessString)	success
failure:		(ThingFailureError)	failure

获取当前设备 Wifi 名称

Parameters

devid	devid
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

getWifiDeviceSsidWithDevid:success:failure: [2/2]

- (void) getWifiDeviceSsidWithDevid:		(NSString *)	devid
success:		(ThingSuccessString)	success
failure:		(ThingFailureError)	failure

获取当前设备 Wifi 名称

Parameters

devid	devid
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

notifyAccessControlListWithDevId:success:failure: [1/2]

- (void) notifyAccessControlListWithDevId:		(NSString *)	devId
success:		(ThingSuccessHandler)	success
failure:		(ThingFailureError)	failure

通知设备写入ACL

Parameters

devId	devId
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

notifyAccessControlListWithDevId:success:failure: [2/2]

- (void) notifyAccessControlListWithDevId:		(NSString *)	devId
success:		(ThingSuccessHandler)	success
failure:		(ThingFailureError)	failure

通知设备写入ACL

Parameters

devId	devId
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

readCommissionedFabricsWithDevid:success:failure: [1/2]

- (void) readCommissionedFabricsWithDevid:		(NSString *)	devid
success:		(ThingSuccessInt)	success
failure:		("This api is deprecate.")	__deprecated_msg

readCommissionedFabrics

Parameters

devid	devid
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

readCommissionedFabricsWithDevid:success:failure: [2/2]

- (void) readCommissionedFabricsWithDevid:		(NSString *)	devid
success:		(ThingSuccessInt)	success
failure:		("This api is deprecate.")	__deprecated_msg

readCommissionedFabrics

Parameters

devid	devid
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

readFabricsWithDevid:success:failure: [1/2]

- (void) readFabricsWithDevid:		(NSString *)	devid
success:		(void(^)(NSArray< ThingMatterMultipleFabricInfoModel * > *fabrics))	success
failure:		(ThingFailureError)	failure

Read fabric list. 获取 Fabirc 列表

• Parameters:
  • devId: devId
  • success: Called when the task is finished.
  • failure: Called when the task is interrupted by an error.

readFabricsWithDevid:success:failure: [2/2]

- (void) readFabricsWithDevid:		(NSString *)	devid
success:		(void(^)(NSArray< ThingMatterMultipleFabricInfoModel * > *fabrics))	success
failure:		(ThingFailureError)	failure

Read fabric list. 获取 Fabirc 列表

• Parameters:
  • devId: devId
  • success: Called when the task is finished.
  • failure: Called when the task is interrupted by an error.

readSupportedFabricsWithDevid:success:failure: [1/2]

- (void) readSupportedFabricsWithDevid:		(NSString *)	devid
success:		(ThingSuccessInt)	success
failure:		("This api is deprecate.")	__deprecated_msg

readSupportedFabrics 支持的Fabric数量

Parameters

devid	devid
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

readSupportedFabricsWithDevid:success:failure: [2/2]

- (void) readSupportedFabricsWithDevid:		(NSString *)	devid
success:		(ThingSuccessInt)	success
failure:		("This api is deprecate.")	__deprecated_msg

readSupportedFabrics 支持的Fabric数量

Parameters

devid	devid
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

removeFabricDevid:Index:success:failure: [1/2]

- (void) removeFabricDevid:		(NSString *)	devid
Index:		(NSInteger)	fabricIndex
success:		(ThingSuccessHandler)	success
failure:		(ThingFailureError)	failure

Remove Fabric by Fabric index.

• Parameters:
  • devId: devId
  • faibricIndex: The fabric index.
  • success: Called when the task is finished.
  • failure: Called when the task is interrupted by an error.

removeFabricDevid:Index:success:failure: [2/2]

- (void) removeFabricDevid:		(NSString *)	devid
Index:		(NSInteger)	fabricIndex
success:		(ThingSuccessHandler)	success
failure:		(ThingFailureError)	failure

Remove Fabric by Fabric index.

• Parameters:
  • devId: devId
  • faibricIndex: The fabric index.
  • success: Called when the task is finished.
  • failure: Called when the task is interrupted by an error.

revokeCommissioningCommandWithDevid:success:failure: [1/2]

- (void) revokeCommissioningCommandWithDevid:		(NSString *)	devid
success:		(ThingSuccessHandler)	success
failure:		("This api is deprecate.")	__deprecated_msg

close commissing window 关闭设备调试窗口

Parameters

devid	devid
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

revokeCommissioningCommandWithDevid:success:failure: [2/2]

- (void) revokeCommissioningCommandWithDevid:		(NSString *)	devid
success:		(ThingSuccessHandler)	success
failure:		("This api is deprecate.")	__deprecated_msg

close commissing window 关闭设备调试窗口

Parameters

devid	devid
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

sendEnhancedCommissioningCommandWithDevid:fabricPasscodeModel:success:failure: [1/2]

- (void) sendEnhancedCommissioningCommandWithDevid:		(NSString *)	devid
fabricPasscodeModel:		(ThingMatterMultipleFabricPasscodeModel *)	passcodeModel
success:		(void(^)(NSString *qrCode, NSString *setupCode))	success
failure:		("This api is deprecate. Please use `-sendEnhancedCommissioningWithDevid:forceRefresh:ssidInfo:success:failure:` directly")	__deprecated_msg

open commissing window 发送ECM指令

Parameters

devid	devid
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

sendEnhancedCommissioningCommandWithDevid:fabricPasscodeModel:success:failure: [2/2]

- (void) sendEnhancedCommissioningCommandWithDevid:		(NSString *)	devid
fabricPasscodeModel:		(ThingMatterMultipleFabricPasscodeModel *)	passcodeModel
success:		(void(^)(NSString *qrCode, NSString *setupCode))	success
failure:		("This api is deprecate. Please use `-sendEnhancedCommissioningWithDevid:forceRefresh:ssidInfo:success:failure:` directly")	__deprecated_msg

open commissing window 发送ECM指令

Parameters

devid	devid
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

sendEnhancedCommissioningMethodWithDevid:forceRefresh:ssidInfo:success:failure: [1/2]

- (void) sendEnhancedCommissioningMethodWithDevid:		(NSString *)	devid
forceRefresh:		(BOOL)	forceRefresh
ssidInfo:		(nullable void(^)(NSString *__nullable ssid))	ssidInfo
success:		(void(^)(NSString *qrCodeStr, NSString *setupCode, long long duration))	success
failure:		(nullable ThingFailureError)	failure

Open commissing window. (ECM Command)

• Parameters:
  • devId: devId
  • forceRefresh: Force refresh the passcode info.
  • ssidInfo: The Wi-Fi ssid currently connected to the device.
  • success: Called when the task is finished.
  • failure: Called when the task is interrupted by an error.

sendEnhancedCommissioningMethodWithDevid:forceRefresh:ssidInfo:success:failure: [2/2]

- (void) sendEnhancedCommissioningMethodWithDevid:		(NSString *)	devid
forceRefresh:		(BOOL)	forceRefresh
ssidInfo:		(nullable void(^)(NSString *__nullable ssid))	ssidInfo
success:		(void(^)(NSString *qrCodeStr, NSString *setupCode, long long duration))	success
failure:		(nullable ThingFailureError)	failure

Open commissing window. (ECM Command)

• Parameters:
  • devId: devId
  • forceRefresh: Force refresh the passcode info.
  • ssidInfo: The Wi-Fi ssid currently connected to the device.
  • success: Called when the task is finished.
  • failure: Called when the task is interrupted by an error.

sendEnhancedCommissioningWithDevid:forceRefresh:ssidInfo:success:failure: [1/2]

- (void) sendEnhancedCommissioningWithDevid:		(NSString *)	devid
forceRefresh:		(BOOL)	forceRefresh
ssidInfo:		(nullable void(^)(NSString *__nullable ssid))	ssidInfo
success:		(void(^)(NSString *qrCodeStr, NSString *setupCode))	success
failure:		(nullable ThingFailureError)	failure

Open commissing window. (ECM Command)

• Parameters:
  • devId: devId
  • forceRefresh: Force refresh the passcode info.
  • ssidInfo: The Wi-Fi ssid currently connected to the device.
  • success: Called when the task is finished.
  • failure: Called when the task is interrupted by an error.

sendEnhancedCommissioningWithDevid:forceRefresh:ssidInfo:success:failure: [2/2]

- (void) sendEnhancedCommissioningWithDevid:		(NSString *)	devid
forceRefresh:		(BOOL)	forceRefresh
ssidInfo:		(nullable void(^)(NSString *__nullable ssid))	ssidInfo
success:		(void(^)(NSString *qrCodeStr, NSString *setupCode))	success
failure:		(nullable ThingFailureError)	failure

Open commissing window. (ECM Command)

• Parameters:
  • devId: devId
  • forceRefresh: Force refresh the passcode info.
  • ssidInfo: The Wi-Fi ssid currently connected to the device.
  • success: Called when the task is finished.
  • failure: Called when the task is interrupted by an error.

writeAccessControlListWithDevId:success:failure: [1/2]

- (void) writeAccessControlListWithDevId:		(NSString *)	devId
success:		(ThingSuccessHandler)	success
failure:		(ThingFailureError)	failure

writeAccessControlList 写入ACL

Parameters

devId	devId
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

writeAccessControlListWithDevId:success:failure: [2/2]

- (void) writeAccessControlListWithDevId:		(NSString *)	devId
success:		(ThingSuccessHandler)	success
failure:		(ThingFailureError)	failure

writeAccessControlList 写入ACL

Parameters

devId	devId
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

---

The documentation for this protocol was generated from the following files:

• /Users/humtong/Downloads/Pods_副本/ThingSmartMatterInterfaceAPI/ThingSmartMatterInterfaceAPI.xcframework/ios-arm64_x86_64-simulator/ThingSmartMatterInterfaceAPI.framework/Headers/ThingMatterShareInterfaceAPI.h
• /Users/humtong/Downloads/Pods_副本/ThingSmartMatterInterfaceAPI/ThingSmartMatterInterfaceAPI.xcframework/ios-arm64/ThingSmartMatterInterfaceAPI.framework/Headers/ThingMatterShareInterfaceAPI.h