Class ClaimingHelper

Helper class for handling Claiming API calls to the cloud.

Index

Constructors

Methods

initiateClaim verifyClaim

Constructors

constructor

new ClaimingHelper(): ClaimingHelper
Returns ClaimingHelper

Methods

`Static`initiateClaim

initiateClaim(deviceInfo: ClaimInitiateRequest): Promise<string>
Initiates the claiming process by sending device info to the cloud.
Parameters
- deviceInfo: ClaimInitiateRequest
  The device info JSON from the claim start response
Returns Promise<string>
Promise resolving to the cloud response data

Throws
Error if the API call fails
- Defined in src/services/ESPRMHelpers/ClaimingHelper.ts:52

`Static`verifyClaim

verifyClaim(
csrData: ClaimVerifyRequest,
claimCapability?: CAMERA_CLAIM,
): Promise<string>
Verifies the claiming by sending CSR to the cloud and getting the certificate.
Parameters
- csrData: ClaimVerifyRequest
  The CSR JSON data from the device
- OptionalclaimCapability: CAMERA_CLAIM
  Optional claim capability string. When set to ClaimCapabilities.CAMERA_CLAIM, adds node_policies for video streaming.
Returns Promise<string>
Promise resolving to the certificate data

Throws
Error if the API call fails
- Defined in src/services/ESPRMHelpers/ClaimingHelper.ts:85