Class ESPRMUser

The ESPRMUser class serves as the central interface for managing user-related operations within the ESP RainMaker SDK. It provides a comprehensive set of methods for:

Account Management: Retrieve user information, request and confirm account deletion, update user details, and configure Multi-Factor Authentication (MFA).
Group Management: Create, retrieve, share, and transfer groups, as well as manage group sharing requests.
Node Management: Fetch user nodes, get node details, manage node mappings, and handle node sharing requests.
Notification Management: Create platform endpoints for push notifications and manage endpoints.
Event Handling: Subscribe to and manage global events shared across all ESPRMUser instances.

By utilizing the ESPRMUser class, developers can seamlessly manage user sessions, interact with backend APIs, and handle complex user-related workflows.

Index

Constructors

constructor

new ESPRMUser(tokens: UserTokensData): ESPRMUser
Initializes the ESPRMUser instance and stores tokens in local storage.
Parameters
- tokens: UserTokensData
  Object containing the access token, id token, and refresh token.
Returns ESPRMUser
- Defined in src/ESPRMUser.ts:51

Properties

`Static`eventCallbacks

eventCallbacks: EventCallbacks = {}

Global event callbacks shared across all ESPRMUser instances.

`Static`userId

userId: string

User ID of the current user.

Methods

addDaylightBasedAutomation

addDaylightBasedAutomation(
automationDetails: ESPDaylightAutomationDetails,
): Promise<ESPAutomation>
Adds a new daylight-based automation trigger for particular nodes.
Parameters
- automationDetails: ESPDaylightAutomationDetails
  The details of the daylight-based automation trigger and action to add.
Returns Promise<ESPAutomation>
A promise that resolves to an ESPAutomation instance containing details of the newly created automation.
- Defined in src/methods/ESPRMUser/AddDaylightBasedAutomation.ts:34

addTags

addTags(tags: string[]): Promise<ESPAPIResponse>
Adds tags to the current user.

This method sends a request to associate the provided tags with the currently logged-in user.
Parameters
- tags: string[]
  An array of strings representing the tags to be added.
Returns Promise<ESPAPIResponse>
A promise that resolves to an ESPAPIResponse containing the result of the operation.
- Defined in src/methods/ESPRMUser/AddTags.ts:29

addWeatherBasedAutomation

addWeatherBasedAutomation(
automationDetails: ESPWeatherAutomationDetails,
): Promise<ESPAutomation>
Adds a weather-based automation trigger for specific nodes.
Parameters
- automationDetails: ESPWeatherAutomationDetails
  The details of the automation to be added.
Returns Promise<ESPAutomation>
A promise that resolves to an ESPAutomation instance containing details of the newly created automation.
- Defined in src/methods/ESPRMUser/AddWeatherBasedAutomation.ts:34

assumeRole

assumeRole(request: AssumeRoleRequest): Promise<AssumeRoleResponse>
Assumes a user role and gets temporary security credentials for MQTT and other AWS services.
Parameters
- request: AssumeRoleRequest
  The assume role request containing optional userRole, groupIds, and/or nodeIds.
Returns Promise<AssumeRoleResponse>
A promise that resolves to an AssumeRoleResponse containing access credentials (accessKey, secretKey, sessionToken).
Remarks
- userRole is optional. If not provided or empty, it defaults to "mqtt". Only "mqtt" and "videostream" are supported.
- videostream requires nodeIds to generate credentials.
- mqtt works with groupIds and nodeIds.
- groupIds and nodeIds are both optional arrays (max AssumeRoleConstants.MAX_NODE_IDS nodeIds and max AssumeRoleConstants.MAX_GROUP_IDS groupIds). Only one of them can be non-empty in a request.
- If both groupIds and nodeIds are empty or omitted, credentials will be granted for all groups the user has access to.
Throws
If validation fails:
- More than AssumeRoleConstants.MAX_NODE_IDS nodeIds or AssumeRoleConstants.MAX_GROUP_IDS groupIds are provided
- Invalid userRole (not "mqtt" or "videostream")
- Both groupIds and nodeIds are provided
- videostream role is used without nodeIds
- Defined in src/methods/ESPRMUser/AssumeRole.ts:48

cancelCmdRespRequest

cancelCmdRespRequest(
params: ESPCmdRespCancelRequest,
): Promise<ESPCmdRespCancelResponse>
Cancels pending command-response request(s).

Can cancel:
- A specific request by requestId (across all nodes)
- All pending commands for a nodeId
- Pending commands for a nodeId with a specific cmdId
Parameters
- params: ESPCmdRespCancelRequest
  Cancellation parameters. At least requestId or nodeId is required.
Returns Promise<ESPCmdRespCancelResponse>
Cancellation status and count of removed requests.
- Defined in src/methods/ESPRMUser/CancelCmdRespRequest.ts:28

changePassword

changePassword(
oldPassword: string,
newPassword: string,
): Promise<ESPAPIResponse>
Changes the user's password by providing their old password and a new password.
Parameters
- oldPassword: string
  The user's current password.
- newPassword: string
  The new password to set for the user.
Returns Promise<ESPAPIResponse>
A promise that resolves to an ESPAPIResponse indicating the success of the password change.
- Defined in src/methods/ESPRMUser/ChangePassword.ts:30

cleanUpResources

cleanUpResources(): Promise<void>
Cleans up resources associated with the user.

This method retrieves the device token map from storage, deletes the endpoint associated with the user's device token, and clears all tokens from storage.

Returns Promise<void>
A promise that resolves when the resources are cleaned up.
- Defined in src/methods/ESPRMUser/CleanUpResources.ts:21

configureMFA

configureMFA(enabled: boolean): Promise<ESPAPIResponse>
Enables or disables multi-factor authentication (MFA) for the current user.
Parameters
- enabled: boolean
  A boolean indicating whether MFA should be enabled (true) or not (false).
Returns Promise<ESPAPIResponse>
A promise that resolves to an ESPAPIResponse object containing the result of the operation.
- Defined in src/methods/ESPRMUser/ConfigureMFA.ts:24

confirmAccountDeletion

confirmAccountDeletion(verificationCode: string): Promise<ESPAPIResponse>
Confirms the account deletion request by providing a verification code.
Parameters
- verificationCode: string
  The verification code sent to the user for account deletion confirmation.
Returns Promise<ESPAPIResponse>
A promise that resolves to an ESPAPIResponse indicating the success of the account deletion confirmation.
- Defined in src/methods/ESPRMUser/ConfirmAccountDeletion.ts:29

confirmPhoneNumber

confirmPhoneNumber(verificationCode: string): Promise<ESPAPIResponse>
Confirms the phone number associated with the user by providing a verification code.
Parameters
- verificationCode: string
  The verification code sent to the user for confirming the phone number.
Returns Promise<ESPAPIResponse>
A promise that resolves to an ESPAPIResponse indicating the success of the phone number confirmation.
- Defined in src/methods/ESPRMUser/ConfirmPhoneNumber.ts:24

confirmTagAssignment

confirmTagAssignment(verificationCode: string): Promise<ESPAPIResponse>
Confirms the assignment of tags to the user by providing a verification code.
Parameters
- verificationCode: string
  The verification code for confirming the tag assignment.
Returns Promise<ESPAPIResponse>
A promise that resolves to an ESPAPIResponse indicating the success of the tag assignment confirmation.
- Defined in src/methods/ESPRMUser/ConfirmTagAssignment.ts:23

createCmdRespRequest

createCmdRespRequest(
params: ESPCmdRespSendRequest,
): Promise<ESPCmdRespSendAPIResponse>
Adds a command-response request for up to 25 nodes in a single call.
Parameters
- params: ESPCmdRespSendRequest
  Target node ids, command id, payload, and optional options.
Returns Promise<ESPCmdRespSendAPIResponse>
A promise that resolves to the creation response (200 OK or 207 Multi-Status).
- Defined in src/methods/ESPRMUser/CreateCmdRespRequest.ts:23

createESPDevice

createESPDevice(
    name: string,
    transport: ESPTransport,
    security?: ESPSecurity,
    proofOfPossession?: string,
    softAPPassword?: string,
    username?: string,
): Promise<ESPDevice>
Creates an ESP device with the given parameters.
Parameters
- name: string
  The name of the device.
- transport: ESPTransport
  The transport type to use.
- Optionalsecurity: ESPSecurity
  The security type to use (optional).
- OptionalproofOfPossession: string
  The proof of possession string (optional).
- OptionalsoftAPPassword: string
  The SoftAP password (optional).
- Optionalusername: string
  The username (optional).
Returns Promise<ESPDevice>
A promise that resolves to an ESPDevice instance.
- Defined in src/methods/ESPRMUser/CreateESPDevice.ts:34

createFileUploadRequest

createFileUploadRequest(
params: ESPFileUploadParams,
): Promise<ESPFileUploadRequest>
Creates a file upload request and stores confirm metadata on the result.
Parameters
- params: ESPFileUploadParams
  Upload and confirm fields for the file.
Returns Promise<ESPFileUploadRequest>
A promise that resolves to the upload request instance.
- Defined in src/methods/ESPRMUser/CreateFileUploadRequest.ts:23

createGroup

createGroup(groupInfo: CreateGroupRequest): Promise<ESPRMGroup>
Creates a new group with the specified parameters.
Parameters
- groupInfo: CreateGroupRequest
  The details of the group to be created, including name, node IDs, description, and other optional fields.
Returns Promise<ESPRMGroup>
A promise that resolves to an instance of the newly created ESPRMGroup.
- Defined in src/methods/ESPRMUser/CreateGroup.ts:25

createPlatformEndpoint

createPlatformEndpoint(
createPlatformEndpointRequestParams: CreatePlatformEndpointRequest,
): Promise<string>
Creates a platform endpoint for push notifications.
Parameters
- createPlatformEndpointRequestParams: CreatePlatformEndpointRequest
  The parameters required to create the platform endpoint.
Returns Promise<string>
A promise resolving to the platform endpoint.
- Defined in src/methods/ESPRMUser/CreatePlatformEndpoint.ts:33

deleteCustomData

deleteCustomData(forKey: string): Promise<ESPAPIResponse>
Deletes the custom data value associated with the specified key for the current user. This method sends a request to delete the custom data value for the given key associated with the currently logged-in user.
Parameters
- forKey: string
  The key for which the custom data value is to be deleted.
Returns Promise<ESPAPIResponse>
A promise that resolves to a success response upon deleting the custom data.
- Defined in src/methods/ESPRMUser/DeleteCustomData.ts:28

deleteCustomDataKey

deleteCustomDataKey(name: string): Promise<ESPAPIResponse>
Deletes the custom data entry associated with the specified key for the current user. This method sends a request to delete the custom data entry for the specified key associated with the currently logged-in user.
Parameters
- name: string
  The key of the custom data entry to be deleted.
Returns Promise<ESPAPIResponse>
A promise that resolves to an ESPAPIResponse indicating the success or failure of the operation.
- Defined in src/methods/ESPRMUser/DeleteCustomDataKey.ts:28

deleteCustomDataPermissions

deleteCustomDataPermissions(forKey: string): Promise<ESPAPIResponse>
Deletes the custom data pemissions associated with the specified key for the current user. This method sends a request to delete the custom data permissions for the given key associated with the currently logged-in user.
Parameters
- forKey: string
  The key for which the custom data permissions is to be deleted.
Returns Promise<ESPAPIResponse>
A promise that resolves to a success response upon deleting the custom data permissions.
- Defined in src/methods/ESPRMUser/DeleteCustomDataPermissions.ts:28

deleteEndpoint

deleteEndpoint(deviceToken?: string, endpoint?: string): Promise<ESPAPIResponse>
Deletes a platform endpoint associated with the specified device token or endpoint.
Parameters
- OptionaldeviceToken: string
  The mobile device token used for identifying the platform endpoint.
- Optionalendpoint: string
  The unique endpoint identifier to delete.
Returns Promise<ESPAPIResponse>
A promise resolving to the API response, indicating success or failure.

Throws
ESPAPICallValidationError - Throws an error if both deviceToken and endpoint are missing.
- Defined in src/methods/ESPRMUser/DeleteEndpoint.ts:31

downloadFile

downloadFile(
fileId: string,
params?: ESPFileDownloadParams,
): Promise<ESPFileDownloadResult>
Downloads an uploaded file by id.
Parameters
- fileId: string
  The file id to download.
- Optionalparams: ESPFileDownloadParams
  Optional lookup scope and download options.
Returns Promise<ESPFileDownloadResult>
File bytes in the requested format.

Throws
ESPFileError When the file record does not exist (label ESPFileNotFoundError).
- Defined in src/methods/ESPRMUser/DownloadFile.ts:26

getAutomationDetail

getAutomationDetail(automationId: string): Promise<ESPAutomation>
Retrieves an automation based on the provided automation ID.
Parameters
- automationId: string
  The ID of the automation to be fetched.
Returns Promise<ESPAutomation>
A promise that resolves to an ESPAutomation instance containing the automation details.
- Defined in src/methods/ESPRMUser/GetAutomationDetail.ts:26

getAutomations

getAutomations(): Promise<ESPPaginatedAutomationsResponse>
Retrieves a list of all automations with optional pagination.

Returns Promise<ESPPaginatedAutomationsResponse>
A promise that resolves to a paginated response containing automation data.
- Defined in src/methods/ESPRMUser/GetAutomations.ts:20

getCmdRespRequestById

getCmdRespRequestById(
requestId: string,
nodeId?: string,
): Promise<ESPCmdRespRequest[]>
Fetches command-response request(s) by id previously created via createCmdRespRequest.

When nodeId is omitted the lookup uses requestId alone and may return multiple records (one per node for a multi-node send). Pass nodeId to scope the query to a specific node.
Parameters
- requestId: string
  The request id returned by createCmdRespRequest.
- OptionalnodeId: string
  Optional node id to scope the lookup.
Returns Promise<ESPCmdRespRequest[]>
A promise that resolves to matching request records (empty when the backend has no record for the id).
- Defined in src/methods/ESPRMUser/GetCmdRespRequestById.ts:29

getCmdRespRequestList

getCmdRespRequestList(
params: ESPCmdRespListParams,
): Promise<ESPCmdRespPaginatedResult>
Fetches command-response requests for the current user using optional filters.

Supported query shapes (see RainMaker API docs):
- requestId — single record
- requestId + nodeId — single record
- nodeId + startTime + endTime — history
- nodeId with optional cmdId or status — paginated list
- status alone — all requests for the current user with that status
Parameters
- params: ESPCmdRespListParams
  Filter and pagination options.
Returns Promise<ESPCmdRespPaginatedResult>
Paginated command-response request records.
- Defined in src/methods/ESPRMUser/GetCmdRespRequestList.ts:30

getCustomData

getCustomData(): Promise<UserCustomDataResponse>
Fetches custom data associated with the current user. This method sends a request to fetch custom data associated with the currently logged-in user.

Returns Promise<UserCustomDataResponse>
A promise that resolves with the custom data associated with the user.
- Defined in src/methods/ESPRMUser/GetCustomData.ts:22

getFileById

getFileById(
fileId: string,
params?: ESPFileGetByIdParams,
): Promise<null | ESPFile>
Fetches a single uploaded file by id.
Parameters
- fileId: string
  The file id to look up.
- Optionalparams: ESPFileGetByIdParams
  Optional lookup scope such as userName for public files.
Returns Promise<null | ESPFile>
The file record, or null when not found.
- Defined in src/methods/ESPRMUser/GetFileById.ts:24

getFiles

getFiles(params?: ESPFileListParams): Promise<ESPFilePaginatedResult>
Fetches uploaded files for the current user with optional filters.
Parameters
- Optionalparams: ESPFileListParams
  Filter and pagination options.
Returns Promise<ESPFilePaginatedResult>
Paginated file records.
- Defined in src/methods/ESPRMUser/GetFiles.ts:25

getGeoCoordinates

getGeoCoordinates(): Promise<ESPGeoCoordinates>
Retrieves the user's geographical coordinates from the custom data.

Returns Promise<ESPGeoCoordinates>
A promise that resolves to an ESPGeoCoordinates object containing the latitude and longitude.

Throws
If the coordinates are not found in the custom data.
- Defined in src/methods/ESPRMUser/GetGeoCoordinates.ts:22

getGroupById

getGroupById(
getGroupByIdRequestParams: GetGroupByIdRequestParams,
): Promise<ESPRMGroup>
Retrieves a group by its ID.
Parameters
- getGroupByIdRequestParams: GetGroupByIdRequestParams
  Parameters to filter the group data by ID.
Returns Promise<ESPRMGroup>
A promise that resolves to an instance of ESPRMGroup.

Throws
ESPAPICallValidationError if the group ID is missing in the request parameters.
- Defined in src/methods/ESPRMUser/GetGroupById.ts:30

getGroupByName

getGroupByName(
getGroupByNameRequestParams: GetGroupByNameRequestParams,
): Promise<ESPRMGroup>
Retrieves a group by its name.
Parameters
- getGroupByNameRequestParams: GetGroupByNameRequestParams
  Parameters to filter the group data by name.
Returns Promise<ESPRMGroup>
A promise that resolves to an instance of ESPRMGroup.

Throws
ESPAPICallValidationError if the group name is missing in the request parameters.
- Defined in src/methods/ESPRMUser/GetGroupByName.ts:30

getGroups

getGroups(
getGroupsRequestParams: GetGroupsRequestParams,
): Promise<ESPPaginatedGroupsResponse>
Retrieves a list of groups with optional filters and pagination.
Parameters
- getGroupsRequestParams: GetGroupsRequestParams
  Parameters to filter and paginate the group data.
Returns Promise<ESPPaginatedGroupsResponse>
A promise that resolves to a paginated response containing group data.
- Defined in src/methods/ESPRMUser/GetGroups.ts:28

getIssuedGroupSharingRequests

getIssuedGroupSharingRequests(count?: number): Promise<ESPGroupSharingResponse>
Parameters
- Optionalcount: number
Returns Promise<ESPGroupSharingResponse>
- Defined in src/methods/ESPRMUser/GetIssuedGroupSharingRequests.ts:21

getIssuedNodeSharingRequests

getIssuedNodeSharingRequests(
pageCount?: number,
): Promise<ESPNodeSharingResponse>
Fetches node sharing requests for the user with optional pagination.
Parameters
- OptionalpageCount: number
  The number of results to fetch per request. If not provided, the default value is used.
Returns Promise<ESPNodeSharingResponse>
A promise that resolves to a paginated response containing node sharing requests.
- Defined in src/methods/ESPRMUser/GetIssuedNodeSharingRequests.ts:24

getNodeDetails

getNodeDetails(nodeId: string): Promise<ESPRMNode>
Parameters
- nodeId: string
Returns Promise<ESPRMNode>
- Defined in src/methods/ESPRMUser/GetNodeDetails.ts:21

getPlatformEndpoints

getPlatformEndpoints(): Promise<ESPPlatformEndpoint[]>
Fetches a list of registered platform endpoints associated with the user.

Returns Promise<ESPPlatformEndpoint[]>
A promise that resolves to an array of ESPPlatformEndpoint instances.
- Defined in src/methods/ESPRMUser/GetPlatformEndpoints.ts:25

getReceivedGroupSharingRequests

getReceivedGroupSharingRequests(
count?: number,
): Promise<ESPGroupSharingResponse>
Parameters
- Optionalcount: number
Returns Promise<ESPGroupSharingResponse>
- Defined in src/methods/ESPRMUser/GetReceivedGroupSharingRequests.ts:21

getReceivedNodeSharingRequests

getReceivedNodeSharingRequests(
resultCount?: number,
): Promise<ESPNodeSharingResponse>
Fetches node sharing invitations for the user with optional pagination.
Parameters
- OptionalresultCount: number
  The number of results to fetch per request. If not provided, the default value is used.
Returns Promise<ESPNodeSharingResponse>
A promise that resolves to a paginated response containing node sharing invitations.
- Defined in src/methods/ESPRMUser/GetReceivedNodeSharingRequests.ts:24

getUserInfo

getUserInfo(withCustomData?: boolean): Promise<ESPRMUserInfo>
Retrieves user information, optionally including custom data.
Parameters
- OptionalwithCustomData: boolean
  Optional flag indicating whether to include custom data in the response. Defaults to false.
Returns Promise<ESPRMUserInfo>
A promise that resolves to an ESPRMUserInfo object containing the user information.
- Defined in src/methods/ESPRMUser/GetUserInfo.ts:27

getUserNodes

getUserNodes(resultCount?: number): Promise<ESPPaginatedNodesResponse>
Fetches user nodes with optional pagination.
Parameters
- OptionalresultCount: number
  An optional parameter to specify the number of results to retrieve. If not provided, all available results will be fetched.
Returns Promise<ESPPaginatedNodesResponse>
A promise that resolves to a paginated response containing the user nodes.
- Defined in src/methods/ESPRMUser/GetUserNodes.ts:24

getUserNodesWith

getUserNodesWith(
getUserNodesWithRequestParams: GetUserNodesRequestParams,
): Promise<ESPPaginatedNodesResponse>
Retrieves user nodes based on the provided request parameters.
Parameters
- getUserNodesWithRequestParams: GetUserNodesRequestParams
  The parameters for the request to get user nodes.
Returns Promise<ESPPaginatedNodesResponse>
A promise that resolves to a paginated response containing the user nodes.
- Defined in src/methods/ESPRMUser/GetUserNodesWith.ts:31

logout

logout(shouldLogoutFromAllSessions?: boolean): Promise<ESPAPIResponse>
Logs out the current user, with an option to log out from all sessions.
Parameters
- OptionalshouldLogoutFromAllSessions: boolean
  Optional flag indicating whether to log out from all sessions. Defaults to false.
Returns Promise<ESPAPIResponse>
A promise that resolves to an ESPAPIResponse object containing the result of the logout operation.
- Defined in src/methods/ESPRMUser/Logout.ts:29

removeAllCallbacks

removeAllCallbacks(event?: string): void
Removes all callbacks for a specified event or all events.
Parameters
- Optionalevent: string
  (Optional) The event for which to remove callbacks. If omitted, all callbacks for all events are removed.
Returns void
- Defined in src/methods/ESPRMUser/EventSubscriptionModel.ts:55

removeTags

removeTags(tags: string[]): Promise<ESPAPIResponse>
Removes tags to the current user.

This method sends a request to remove the provided tags with the currently logged-in user.
Parameters
- tags: string[]
  An array of strings representing the tags to be removed.
Returns Promise<ESPAPIResponse>
A promise that resolves to an ESPAPIResponse containing the result of the operation.
- Defined in src/methods/ESPRMUser/RemoveTags.ts:29

requestAccountDeletion

requestAccountDeletion(): Promise<ESPAPIResponse>
Sends a request to initiate the account deletion process.

Returns Promise<ESPAPIResponse>
A promise that resolves to an ESPAPIResponse indicating the success of the account deletion request.
- Defined in src/methods/ESPRMUser/RequestAccountDeletion.ts:23

searchESPBLEDevices

searchESPBLEDevices(customerId: number): Promise<ESPDevice[]>
Searches for ESP BLE devices with the given customer ID.
Parameters
- customerId: number
  The customer ID to search for.
Returns Promise<ESPDevice[]>
A promise that resolves to an array of ESPDevice instances.
- Defined in src/methods/ESPRMUser/SearchESPBLEDevices.ts:21

searchESPDevices

searchESPDevices(
devicePrefix: string,
transport: ESPTransport,
): Promise<ESPDevice[]>
Searches for ESP devices with the given prefix.
Parameters
- devicePrefix: string
  The prefix of the device name to search for.
- transport: ESPTransport
Returns Promise<ESPDevice[]>
A promise that resolves to an array of ESPDevice instances.
- Defined in src/methods/ESPRMUser/SearchESPDevices.ts:25

setCustomData

setCustomData(data: UserCustomDataRequest): Promise<ESPAPIResponse>
Sets custom data associated with the current user. This method sends a request to set custom data for the currently logged-in user.
Parameters
- data: UserCustomDataRequest
  The custom data to be set for the user.
Returns Promise<ESPAPIResponse>
A promise that resolves to an ESPAPIResponse indicating the success of the operation.
- Defined in src/methods/ESPRMUser/SetCustomData.ts:28

setGeoCoordinates

setGeoCoordinates(geoCoordinates: ESPGeoCoordinates): Promise<ESPAPIResponse>
Stores the user's geographical coordinates in the custom data.
Parameters
- geoCoordinates: ESPGeoCoordinates
  An object containing the latitude and longitude to be stored.
Returns Promise<ESPAPIResponse>
A promise that resolves to an ESPAPIResponse indicating the success of the operation.
- Defined in src/methods/ESPRMUser/SetGeoCoordinates.ts:25

setMultipleNodesParams

setMultipleNodesParams(payload: MultipleNodePayload[]): Promise<ESPAPIResponse>
Sets multiple parameters for the nodes.
Parameters
- payload: MultipleNodePayload[]
  The payload containing the parameters to be set for multiple nodes.
Returns Promise<ESPAPIResponse>
A promise that resolves to the API response.
- Defined in src/methods/ESPRMUser/SetMultipleNodesParams.ts:21

setPhoneNumber

setPhoneNumber(phoneNumber: string): Promise<ESPAPIResponse>
Updates the phone number associated with the current user.
Parameters
- phoneNumber: string
  The new phone number to be set for the user.
Returns Promise<ESPAPIResponse>
A promise that resolves to an ESPAPIResponse object containing the result of the operation.
- Defined in src/methods/ESPRMUser/SetPhoneNumber.ts:24

setTimeZone

setTimeZone(timeZoneString: string): Promise<ESPAPIResponse>
Set the timeZone for the user in the user's custom data.
Parameters
- timeZoneString: string
  The timeZone string to set.
Returns Promise<ESPAPIResponse>
A promise that resolves to an ESPAPIResponse indicating the success of the operation.
- Defined in src/methods/ESPRMUser/SetTimeZone.ts:28

shareGroups

shareGroups(shareGroupsRequestParams: ShareGroupsRequest): Promise<string>
Shares the specified groups with a user.
Parameters
- shareGroupsRequestParams: ShareGroupsRequest
  The parameters needed for sharing groups.
Returns Promise<string>
A promise that resolves to the request ID from the API.
- Defined in src/methods/ESPRMUser/ShareGroups.ts:23

stopESPDevicesSearch

stopESPDevicesSearch(): Promise<void>
Stop the search for ESP devices.

Returns Promise<void>
- Defined in src/methods/ESPRMUser/StopESPDevicesSearch.ts:20

subscribe(
    event: string,
    callback: Function | Function[],
    discoveryConfig?: DiscoveryParamsInterface,
): void
Subscribes a callback function or an array of callback functions to a specified event.
Parameters
- event: string
  The event to subscribe to, represented by ESPRMEventType or string.
- callback: Function | Function[]
  The callback function or an array of callback functions to execute when the event is triggered.
- OptionaldiscoveryConfig: DiscoveryParamsInterface
  The discovery configuration to use for the custom discovery protocol.
Returns void
Throws
An error if the event type is invalid.
- Defined in src/methods/ESPRMUser/EventSubscriptionModel.ts:28

transferGroups

transferGroups(
transferGroupsRequestParams: TransferGroupsRequest,
): Promise<string>
Transfers the specified groups to another user.
Parameters
- transferGroupsRequestParams: TransferGroupsRequest
  The parameters needed for transferring groups.
Returns Promise<string>
A promise that resolves to the request ID from the API.
- Defined in src/methods/ESPRMUser/TransferGroups.ts:23

trigger

trigger(event: string, arg: any): void
Triggers an event and executes all associated callback functions with the provided argument.
Parameters
- event: string
  The event to trigger, represented by ESPRMEventType or string.
- arg: any
  The argument to pass to the callback functions.
Returns void
- Defined in src/methods/ESPRMUser/EventSubscriptionModel.ts:48

unsubscribe

unsubscribe(event: string, callback: Function): void
Unsubscribes a specific callback function from a specified event.
Parameters
- event: string
  The event to unsubscribe from, represented by ESPRMEventType or string.
- callback: Function
  The callback function to remove.
Returns void
- Defined in src/methods/ESPRMUser/EventSubscriptionModel.ts:40

updateName

updateName(newName: string): Promise<ESPAPIResponse>
Updates the name associated with the current user.
Parameters
- newName: string
  The new name to be set for the user.
Returns Promise<ESPAPIResponse>
A promise that resolves to an ESPAPIResponse object containing the result of the operation.
- Defined in src/methods/ESPRMUser/UpdateName.ts:24

uploadFile

uploadFile(
    content: ArrayBuffer | Blob | Uint8Array<ArrayBufferLike>,
    params: ESPFileUploadParams,
    onProgress?: ESPFileUploadProgressCallback,
): Promise<ESPFile>
Uploads a file in one call: create upload request, PUT to S3, and confirm.
Parameters
- content: ArrayBuffer | Blob | Uint8Array<ArrayBufferLike>
  File bytes to upload.
- params: ESPFileUploadParams
  Upload and confirm fields for the file.
- OptionalonProgress: ESPFileUploadProgressCallback
  Optional phase progress callback.
Returns Promise<ESPFile>
A promise that resolves to the confirmed file record.

Throws
ESPFileError When the S3 upload request fails.
- Defined in src/methods/ESPRMUser/UploadFile.ts:30

`Static`clearAllTokens

clearAllTokens(): void
Clears all tokens from memory and local storage.

Returns void
- Defined in src/ESPRMUser.ts:120

`Static`extendSession

extendSession(refreshToken: string): Promise<string>
Extends the session by exchanging the refresh token for a new access token and id token.
Parameters
- refreshToken: string
  The refresh token used to extend the session.
Returns Promise<string>
A promise that resolves to the new access token.

Throws
Error if session extension fails.
- Defined in src/ESPRMUser.ts:92

`Static`getAccessToken

getAccessToken(): Promise<string>
Retrieves the current access token. If the access token is expired, it attempts to extend the session using the refresh token.

Returns Promise<string>
A promise that resolves to the access token or an empty string if no valid token is available.
- Defined in src/ESPRMUser.ts:64

Class ESPRMUser

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ESPRMUser

Properties

StaticeventCallbacks

StaticuserId

Methods

addDaylightBasedAutomation

Parameters

Returns Promise<ESPAutomation>

addTags

Parameters

Returns Promise<ESPAPIResponse>

addWeatherBasedAutomation

Parameters

Returns Promise<ESPAutomation>

assumeRole

Parameters

Returns Promise<AssumeRoleResponse>

Remarks

Throws

cancelCmdRespRequest

Parameters

Returns Promise<ESPCmdRespCancelResponse>

changePassword

Parameters

Returns Promise<ESPAPIResponse>

cleanUpResources

Returns Promise<void>

configureMFA

Parameters

Returns Promise<ESPAPIResponse>

confirmAccountDeletion

Parameters

Returns Promise<ESPAPIResponse>

confirmPhoneNumber

Parameters

Returns Promise<ESPAPIResponse>

confirmTagAssignment

Parameters

Returns Promise<ESPAPIResponse>

createCmdRespRequest

Parameters

Returns Promise<ESPCmdRespSendAPIResponse>

createESPDevice

Parameters

Returns Promise<ESPDevice>

createFileUploadRequest

Parameters

Returns Promise<ESPFileUploadRequest>

createGroup

Parameters

Returns Promise<ESPRMGroup>

createPlatformEndpoint

Parameters

Returns Promise<string>

deleteCustomData

Parameters

Returns Promise<ESPAPIResponse>

deleteCustomDataKey

Parameters

Returns Promise<ESPAPIResponse>

deleteCustomDataPermissions

Parameters

Returns Promise<ESPAPIResponse>

deleteEndpoint

Parameters

Returns Promise<ESPAPIResponse>

Throws

downloadFile

Parameters

Returns Promise<ESPFileDownloadResult>

Throws

getAutomationDetail

`Static`eventCallbacks

`Static`userId