Class ESPCDFUser

constructor

• new ESPCDFUser(userData: ESPCDFUserInterface): ESPCDFUser

  Parameters

  • userData: ESPCDFUserInterface

  Returns ESPCDFUser

Optional__storeCallbacks

_raw

OptionalcustomData

Readonlyevents

identifier

operations

userInfo

addDevice

• addDevice(params: AddDeviceParams): Promise<ESPCDFNode | null>

  Add a device via provisioning. Orchestrates provision, timezone setup, node fetch, and group store update in the adapter layer.

  Parameters

  • params: AddDeviceParams

  Returns Promise<ESPCDFNode | null>

  The provisioned ESPCDFNode or null on failure

addOnNetworkDevice

• addOnNetworkDevice(params: AddOnNetworkDeviceParams): Promise<ESPCDFNode | null>

  Add a device that is already on the user's local network using the challenge-response flow (LAN HTTP). The device is identified by mDNS discovery and verified through a cloud-issued challenge that the device signs with its credentials.

  Parameters

  • params: AddOnNetworkDeviceParams

    Discovered device, group id, and (optionally) POP

  Returns Promise<ESPCDFNode | null>

  Provisioned ESPCDFNode or null if the active adaptor does not support on-network provisioning or the verification did not yield a fetchable node.

assumeRole

• assumeRole(request: ESPCDFAssumeRoleRequest): Promise<ESPCDFAssumeRoleResponse>

  Obtain short-lived AWS credentials scoped to the requested role/resources. Throws if the active adaptor does not support this operation.

  Parameters

  • request: ESPCDFAssumeRoleRequest

  Returns Promise<ESPCDFAssumeRoleResponse>

changePassword

• changePassword(
      oldPassword: string,
      newPassword: string,
  ): Promise<ESPCDFAPIResponse<any>>

  Parameters

  • oldPassword: string
  • newPassword: string

  Returns Promise<ESPCDFAPIResponse<any>>

confirmAccountDeletion

• confirmAccountDeletion(code: string): Promise<void>

  Parameters

  • code: string

  Returns Promise<void>

createFabric

• createFabric(groupRequest: ESPCDFCreateGroupRequest): Promise<ESPCDFGroup>

  Creates a Matter fabric (ESPRMUser.createFabric). On success, UserStoreSynchronizer adds the fabric to the group store.

  Parameters

  • groupRequest: ESPCDFCreateGroupRequest

  Returns Promise<ESPCDFGroup>

createGroup

• createGroup(groupRequest: ESPCDFCreateGroupRequest): Promise<ESPCDFGroup>

  Parameters

  • groupRequest: ESPCDFCreateGroupRequest

  Returns Promise<ESPCDFGroup>

createHome

• createHome(params: ESPCDFCreateHomeRequestParams): Promise<ESPCDFGroup>

  Create a home and add it to the group store via callbacks (same pattern as syncHomeWithNodes).

  Parameters

  • params: ESPCDFCreateHomeRequestParams

    Name and node IDs to include in the home

  Returns Promise<ESPCDFGroup>

  The created ESPCDFGroup

createProvisioningDevice

• createProvisioningDevice(
      name: string,
      transport: string,
      security?: number,
      proofOfPossession?: string,
      softAPPassword?: string,
      username?: string,
  ): Promise<any>

  Parameters

  • name: string
  • transport: string
  • Optionalsecurity: number
  • OptionalproofOfPossession: string
  • OptionalsoftAPPassword: string
  • Optionalusername: string

  Returns Promise<any>

dispose

• dispose(): void

  Remove all listeners and clean up

  Returns void

getAccessToken

• getAccessToken(): Promise<string>

  Get the access token for the user

  Returns Promise<string>

  The access token

getCustomData

• getCustomData(): Promise<any>

  Returns Promise<any>

getGroupById

• getGroupById(groupId: string, options: Record<string, any>): Promise<any>

  Parameters

  • groupId: string
  • options: Record<string, any>

  Returns Promise<any>

getGroups

• getGroups(): Promise<ESPCDFPaginatedAPIResponse<ESPCDFGroup[]>>

  Fetches groups from all registered SDKs that support group fetching. This method mirrors the functionality of groupStore.syncGroupsList() but is accessible through the user entity and works through callback operations. Calls operations.getGroups() (implemented with access to rootStore), updates groupStore reactively through callbacks, and stores pagination context for on-demand loading.

  Returns Promise<ESPCDFPaginatedAPIResponse<ESPCDFGroup[]>>

  Promise resolving to batch operation result with successful and failed group fetches

getIssuedGroupSharingRequests

• getIssuedGroupSharingRequests(
      count?: number,
  ): Promise<ESPCDFPaginatedAPIResponse<ESPCDFGroupSharingRequest[]>>

  Parameters

  • Optionalcount: number

  Returns Promise<ESPCDFPaginatedAPIResponse<ESPCDFGroupSharingRequest[]>>

getNodeDetails

• getNodeDetails(nodeId: string): Promise<ESPCDFNode>

  Parameters

  • nodeId: string

  Returns Promise<ESPCDFNode>

getReceivedGroupSharingRequests

• getReceivedGroupSharingRequests(
      count?: number,
  ): Promise<ESPCDFPaginatedAPIResponse<ESPCDFGroupSharingRequest[]>>

  Parameters

  • Optionalcount: number

  Returns Promise<ESPCDFPaginatedAPIResponse<ESPCDFGroupSharingRequest[]>>

getUserInfo

• getUserInfo(): Promise<ESPCDFUserInfo>

  Returns Promise<ESPCDFUserInfo>

isUserNocAvailableForFabric

• isUserNocAvailableForFabric(fabricId: string): Promise<boolean>

  Returns whether a user NOC is already stored for the given fabric id.

  Parameters

  • fabricId: string

    Matter fabric id

  Returns Promise<boolean>

logout

• logout(): Promise<void>

  Returns Promise<void>

registerForNotification

• registerForNotification(
      platform: string,
      deviceToken: string,
  ): Promise<ESPCDFAPIDataResponse<any>>

  Parameters

  • platform: string
  • deviceToken: string

  Returns Promise<ESPCDFAPIDataResponse<any>>

requestAccountDeletion

• requestAccountDeletion(): Promise<ESPCDFAPIResponse<any>>

  Returns Promise<ESPCDFAPIResponse<any>>

searchESPBLEDevices

• searchESPBLEDevices(customerId: number): Promise<any[]>

  Parameters

  • customerId: number

  Returns Promise<any[]>

searchESPDevices

• searchESPDevices(devicePrefix: string, transport: string): Promise<any[]>

  Parameters

  • devicePrefix: string
  • transport: string

  Returns Promise<any[]>

setCurrentHome

• setCurrentHome(home: ESPCDFGroup): Promise<void>

  Parameters

  • home: ESPCDFGroup

  Returns Promise<void>

setCustomData

• setCustomData(customData: ESPCDFUserCustomDataRequest): Promise<void>

  Parameters

  • customData: ESPCDFUserCustomDataRequest

  Returns Promise<void>

setMultipleNodesParams

• setMultipleNodesParams(
      payload: { nodeId: string; payload: any }[],
  ): Promise<any>

  Parameters

  • payload: { nodeId: string; payload: any }[]

  Returns Promise<any>

setStoreCallbacks

• setStoreCallbacks(callbacks: GroupStoreCallbacks): void

  Parameters

  • callbacks: GroupStoreCallbacks

  Returns void

setTimeZone

• setTimeZone(timeZone: string): Promise<ESPCDFAPIResponse<any>>

  Parameters

  • timeZone: string

  Returns Promise<ESPCDFAPIResponse<any>>

storePrecommissionInfo

• storePrecommissionInfo(info: ESPCDFMatterPrecommissionInfo): Promise<void>

  Parameters

  • info: ESPCDFMatterPrecommissionInfo

  Returns Promise<void>

subscribe

• subscribe(
      listener: ESPCDFOperationListener<ESPCDFUser, ESPCDFUserOperationType>,
  ): () => void

  Subscribe to all operation events

  Parameters

  • listener: ESPCDFOperationListener<ESPCDFUser, ESPCDFUserOperationType>

    The callback function to register

  Returns () => void

  Unsubscribe function

subscribeToEvent

• subscribeToEvent(event: string, callback: (data: any) => void): Promise<any>

  Parameters

  • event: string
  • callback: (data: any) => void

  Returns Promise<any>

subscribeToNodeUpdates

• subscribeToNodeUpdates(
      params: ESPCDFSubscribeToNodeUpdatesRequestParams,
  ): Promise<void>

  Parameters

  • params: ESPCDFSubscribeToNodeUpdatesRequestParams

  Returns Promise<void>

syncHomeWithNodes

• syncHomeWithNodes(): Promise<ESPCDFGroup | null>

  Returns Promise<ESPCDFGroup | null>

unregisterForNotification

• unregisterForNotification(deviceToken: string): Promise<ESPCDFAPIResponse<any>>

  Parameters

  • deviceToken: string

  Returns Promise<ESPCDFAPIResponse<any>>

unsubscribeFromEvent

• unsubscribeFromEvent(event: string, callback: (data: any) => void): Promise<any>

  Parameters

  • event: string
  • callback: (data: any) => void

  Returns Promise<any>

unsubscribeFromNodeUpdates

• unsubscribeFromNodeUpdates(): Promise<void>

  Returns Promise<void>

updateName

• updateName(name: string): Promise<void>

  Parameters

  • name: string

  Returns Promise<void>

updateUserInfo

• updateUserInfo(userInfo: Partial<ESPCDFUserInfo>): Promise<void>

  Parameters

  • userInfo: Partial<ESPCDFUserInfo>

  Returns Promise<void>