Tuya iOS Smart Life App SDK 5.15.0
ThingSmartMatterMultipleFabricShare Class Reference

#import <ThingSmartMatterMultipleFabricShare.h>

Inheritance diagram for ThingSmartMatterMultipleFabricShare:

Instance Methods

(instancetype) - initWithDeviceModel:
 
(BOOL) - checkPipelineAvailable
 Check the device multiple fabric command communicate channels available or not. More...
 
(void) - sendEnhancedCommissioningMethod:ssidInfo:success:failure:
 
(void) - sendEnhancedCommissioning:ssidInfo:success:failure:
 
(void) - readFabricsWithSuccess:failure:
 
(void) - removeFabricIndex:success:failure:
 
(void) - sendEnhancedCommissioningCommandWithFabricPasscodeModel:success:failure:
 
(void) - getConnectedStatusSuccess:failure:
 Get matter connected Status. More...
 
(void) - readSupportedFabricsSuccess:failure:
 Read supported fabric max count. More...
 
(void) - readCommissionedFabricsSuccess:failure:
 Read the commisstioned fabric count. More...
 
(void) - getMultipleFabricPasscodeCompletion:
 Request the multiple fabric passcode model. More...
 
(void) - getMultipleFabricPasscodeForceRefreshCompletion:
 Request the multiple fabric passcode model. (Force Refresh) More...
 
(NSString *) - generateQrCodeWithFabricPasscodeModel:
 GenerateQrCode. More...
 
(void) - getWifiDeviceSsid:failure:
 Get the Wi-Fi ssid currently connected to the device. More...
 
(void) - revokeCommissioningCommandSuccess:failure:
 Close commissing window. More...
 
(instancetype) - initWithDeviceModel:
 
(BOOL) - checkPipelineAvailable
 Check the device multiple fabric command communicate channels available or not. More...
 
(void) - sendEnhancedCommissioningMethod:ssidInfo:success:failure:
 
(void) - sendEnhancedCommissioning:ssidInfo:success:failure:
 
(void) - readFabricsWithSuccess:failure:
 
(void) - removeFabricIndex:success:failure:
 
(void) - sendEnhancedCommissioningCommandWithFabricPasscodeModel:success:failure:
 
(void) - getConnectedStatusSuccess:failure:
 Get matter connected Status. More...
 
(void) - readSupportedFabricsSuccess:failure:
 Read supported fabric max count. More...
 
(void) - readCommissionedFabricsSuccess:failure:
 Read the commisstioned fabric count. More...
 
(void) - getMultipleFabricPasscodeCompletion:
 Request the multiple fabric passcode model. More...
 
(void) - getMultipleFabricPasscodeForceRefreshCompletion:
 Request the multiple fabric passcode model. (Force Refresh) More...
 
(NSString *) - generateQrCodeWithFabricPasscodeModel:
 GenerateQrCode. More...
 
(void) - getWifiDeviceSsid:failure:
 Get the Wi-Fi ssid currently connected to the device. More...
 
(void) - revokeCommissioningCommandSuccess:failure:
 Close commissing window. More...
 

Detailed Description

Definition at line 24 of file ThingSmartMatterMultipleFabricShare.h.

Method Documentation

◆ checkPipelineAvailable [1/2]

- (BOOL) checkPipelineAvailable

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

◆ checkPipelineAvailable [2/2]

- (BOOL) checkPipelineAvailable

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

◆ generateQrCodeWithFabricPasscodeModel: [1/2]

- (NSString *) generateQrCodeWithFabricPasscodeModel: ("This api is deprecate. Please use `- sendEnhancedCommissioning:ssidInfo:success:failure:` directly")  __deprecated_msg

GenerateQrCode.

◆ generateQrCodeWithFabricPasscodeModel: [2/2]

- (NSString *) generateQrCodeWithFabricPasscodeModel: ("This api is deprecate. Please use `- sendEnhancedCommissioning:ssidInfo:success:failure:` directly")  __deprecated_msg

GenerateQrCode.

◆ getConnectedStatusSuccess:failure: [1/2]

- (void) getConnectedStatusSuccess: (ThingSuccessHandler success
failure: ("This api is deprecate.")  __deprecated_msg 

Get matter connected Status.

◆ getConnectedStatusSuccess:failure: [2/2]

- (void) getConnectedStatusSuccess: (ThingSuccessHandler success
failure: ("This api is deprecate.")  __deprecated_msg 

Get matter connected Status.

◆ getMultipleFabricPasscodeCompletion: [1/2]

- (void) getMultipleFabricPasscodeCompletion: ("This api is deprecate. Please use `- sendEnhancedCommissioning:ssidInfo:success:failure:` directly")  __deprecated_msg

Request the multiple fabric passcode model.

◆ getMultipleFabricPasscodeCompletion: [2/2]

- (void) getMultipleFabricPasscodeCompletion: ("This api is deprecate. Please use `- sendEnhancedCommissioning:ssidInfo:success:failure:` directly")  __deprecated_msg

Request the multiple fabric passcode model.

◆ getMultipleFabricPasscodeForceRefreshCompletion: [1/2]

- (void) getMultipleFabricPasscodeForceRefreshCompletion: ("This api is deprecate. Please use `- sendEnhancedCommissioning:ssidInfo:success:failure:` directly")  __deprecated_msg

Request the multiple fabric passcode model. (Force Refresh)

◆ getMultipleFabricPasscodeForceRefreshCompletion: [2/2]

- (void) getMultipleFabricPasscodeForceRefreshCompletion: ("This api is deprecate. Please use `- sendEnhancedCommissioning:ssidInfo:success:failure:` directly")  __deprecated_msg

Request the multiple fabric passcode model. (Force Refresh)

◆ getWifiDeviceSsid:failure: [1/2]

- (void) getWifiDeviceSsid: (ThingSuccessString success
failure: (nullable ThingFailureError failure 

Get the Wi-Fi ssid currently connected to the device.

◆ getWifiDeviceSsid:failure: [2/2]

- (void) getWifiDeviceSsid: (ThingSuccessString success
failure: (nullable ThingFailureError failure 

Get the Wi-Fi ssid currently connected to the device.

◆ initWithDeviceModel: [1/2]

- (instancetype) initWithDeviceModel: (ThingSmartDeviceModel *)  deviceModel

Create a ThingSmartMatterMultipleFabricShare object with a ThingSmartDeviceModel object.

Parameters
deviceModelThe object of ThingSmartDeviceModel

◆ initWithDeviceModel: [2/2]

- (instancetype) initWithDeviceModel: (ThingSmartDeviceModel *)  deviceModel

Create a ThingSmartMatterMultipleFabricShare object with a ThingSmartDeviceModel object.

Parameters
deviceModelThe object of ThingSmartDeviceModel

◆ readCommissionedFabricsSuccess:failure: [1/2]

- (void) readCommissionedFabricsSuccess: (ThingSuccessInt success
failure: ("This api is deprecate.")  __deprecated_msg 

Read the commisstioned fabric count.

◆ readCommissionedFabricsSuccess:failure: [2/2]

- (void) readCommissionedFabricsSuccess: (ThingSuccessInt success
failure: ("This api is deprecate.")  __deprecated_msg 

Read the commisstioned fabric count.

◆ readFabricsWithSuccess:failure: [1/2]

- (void) readFabricsWithSuccess: (void(^)(NSArray< ThingSmartMatterMultipleFabricInfoModel * > *fabrics))  success
failure: (nullable ThingFailureError failure 

Read fabric info list.

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

◆ readFabricsWithSuccess:failure: [2/2]

- (void) readFabricsWithSuccess: (void(^)(NSArray< ThingSmartMatterMultipleFabricInfoModel * > *fabrics))  success
failure: (nullable ThingFailureError failure 

Read fabric info list.

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

◆ readSupportedFabricsSuccess:failure: [1/2]

- (void) readSupportedFabricsSuccess: (ThingSuccessInt success
failure: ("This api is deprecate.")  __deprecated_msg 

Read supported fabric max count.

◆ readSupportedFabricsSuccess:failure: [2/2]

- (void) readSupportedFabricsSuccess: (ThingSuccessInt success
failure: ("This api is deprecate.")  __deprecated_msg 

Read supported fabric max count.

◆ removeFabricIndex:success:failure: [1/2]

- (void) removeFabricIndex: (NSInteger)  fabricIndex
success: (ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Remove fabric by fabric index. Notice: CAN'T remove current app fabric index.

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

◆ removeFabricIndex:success:failure: [2/2]

- (void) removeFabricIndex: (NSInteger)  fabricIndex
success: (ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Remove fabric by fabric index. Notice: CAN'T remove current app fabric index.

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

◆ revokeCommissioningCommandSuccess:failure: [1/2]

- (void) revokeCommissioningCommandSuccess: (ThingSuccessHandler success
failure: ("This api is deprecate.")  __deprecated_msg 

Close commissing window.

◆ revokeCommissioningCommandSuccess:failure: [2/2]

- (void) revokeCommissioningCommandSuccess: (ThingSuccessHandler success
failure: ("This api is deprecate.")  __deprecated_msg 

Close commissing window.

◆ sendEnhancedCommissioning:ssidInfo:success:failure: [1/2]

- (void) sendEnhancedCommissioning: (BOOL)  forceRefresh
ssidInfo: (nullable void(^)(NSString *__nullable ssid))  ssidInfo
success: (void(^)(NSString *qrCodeStr, NSString *setupCode))  success
failure: ("Please use `-sendEnhancedCommissioningMethod:ssidInfo:success:failure:`")  __deprecated_msg 

Open commissing window. (ECM Command)

  • Parameters:
    • 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.

◆ sendEnhancedCommissioning:ssidInfo:success:failure: [2/2]

- (void) sendEnhancedCommissioning: (BOOL)  forceRefresh
ssidInfo: (nullable void(^)(NSString *__nullable ssid))  ssidInfo
success: (void(^)(NSString *qrCodeStr, NSString *setupCode))  success
failure: ("Please use `-sendEnhancedCommissioningMethod:ssidInfo:success:failure:`")  __deprecated_msg 

Open commissing window. (ECM Command)

  • Parameters:
    • 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.

◆ sendEnhancedCommissioningCommandWithFabricPasscodeModel:success:failure: [1/2]

- (void) sendEnhancedCommissioningCommandWithFabricPasscodeModel: (ThingSmartMatterMultipleFabricPasscodeModel *)  passcodeModel
success: (void(^)(NSString *qrCodeStr, NSString *setupCode))  success
failure: ("Please use `-sendEnhancedCommissioning:ssidInfo:success:failure:`")  __deprecated_msg 

Open commissing window. (ECM Command). Notice This API is deprecated, -sendEnhancedCommissioning:ssidInfo:success:failure: is recommended. If you still want to use, you should use some other API to check before use this API:

  1. Use -getConnectedStatusSuccess: to check device connect status
  2. Use -readSupportedFabricsSuccess:failure: to get the maximum supported fabrics, and use -readSupportedFabricsSuccess:failure: to get the used fabrics number, if them equal, you CAN'T continue the flow.
  3. Use -revokeCommissioningCommandSuccess:failure: to precheck the commissioning window.
  4. Use -getMultipleFabricPasscodeCompletion: or -getMultipleFabricPasscodeForceRefreshCompletion to Get the passcodeModel.

Parameters:

  • passcodeModel: Use -getMultipleFabricPasscodeCompletion: or -getMultipleFabricPasscodeForceRefreshCompletion to Get the passcodeModel.
  • success: Called when the task is finished.
  • failure: Called when the task is interrupted by an error.

◆ sendEnhancedCommissioningCommandWithFabricPasscodeModel:success:failure: [2/2]

- (void) sendEnhancedCommissioningCommandWithFabricPasscodeModel: (ThingSmartMatterMultipleFabricPasscodeModel *)  passcodeModel
success: (void(^)(NSString *qrCodeStr, NSString *setupCode))  success
failure: ("Please use `-sendEnhancedCommissioning:ssidInfo:success:failure:`")  __deprecated_msg 

Open commissing window. (ECM Command). Notice This API is deprecated, -sendEnhancedCommissioning:ssidInfo:success:failure: is recommended. If you still want to use, you should use some other API to check before use this API:

  1. Use -getConnectedStatusSuccess: to check device connect status
  2. Use -readSupportedFabricsSuccess:failure: to get the maximum supported fabrics, and use -readSupportedFabricsSuccess:failure: to get the used fabrics number, if them equal, you CAN'T continue the flow.
  3. Use -revokeCommissioningCommandSuccess:failure: to precheck the commissioning window.
  4. Use -getMultipleFabricPasscodeCompletion: or -getMultipleFabricPasscodeForceRefreshCompletion to Get the passcodeModel.

Parameters:

  • passcodeModel: Use -getMultipleFabricPasscodeCompletion: or -getMultipleFabricPasscodeForceRefreshCompletion to Get the passcodeModel.
  • success: Called when the task is finished.
  • failure: Called when the task is interrupted by an error.

◆ sendEnhancedCommissioningMethod:ssidInfo:success:failure: [1/2]

- (void) sendEnhancedCommissioningMethod: (BOOL)  forceRefresh
ssidInfo: (nullable void(^)(NSString *__nullable ssid))  ssidInfo
success: (void(^)(ThingSmartMatterFabricShareModel *shareModel))  success
failure: (nullable ThingFailureError failure 

Open commissing window. (ECM Command)

  • Parameters:
    • 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.

◆ sendEnhancedCommissioningMethod:ssidInfo:success:failure: [2/2]

- (void) sendEnhancedCommissioningMethod: (BOOL)  forceRefresh
ssidInfo: (nullable void(^)(NSString *__nullable ssid))  ssidInfo
success: (void(^)(ThingSmartMatterFabricShareModel *shareModel))  success
failure: (nullable ThingFailureError failure 

Open commissing window. (ECM Command)

  • Parameters:
    • 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.

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