getPanelAgentSoulRecallEntryStatus(params: GetPanelAgentSoulRecallEntryStatusParams)

Requires:
@tuya-miniapp/cloud-api≥1.x.x

Description

Query the Memory Recall entry status.

Parameters

ParameterTypeRequiredDescription
YesRequest parameters

Return Value

Type: Promise<GetPanelAgentSoulRecallEntryStatusResult>
GetPanelAgentSoulRecallEntryStatusResult (see type definitions and minituya return parameters for field meanings)

Referenced Types

interfaceGetPanelAgentSoulRecallEntryStatusResult
PropertyTypeDescription
action"GO_MAIN" | "IN_PROGRESS" | "SHOW_RECALL"Entry action: GO_MAIN (no migration required) / IN_PROGRESS (migration in progress) / SHOW_RECALL (migration available)
inProgressTaskIdstringID of the migration task in progress (when action=IN_PROGRESS)
hasMigrablebooleanWhether any devices are available for migration (when action=SHOW_RECALL)
deviceCountnumberNumber of devices available for migration

Valid Values

GetPanelAgentSoulRecallEntryStatusResult.action
ValueDescriptionSince
GO_MAIN--
IN_PROGRESS--
SHOW_RECALL--

Examples

Request example

import { getPanelAgentSoulRecallEntryStatus } from '@tuya-miniapp/cloud-api';

const params = {
  devId: 'your_device_id',
};

getPanelAgentSoulRecallEntryStatus(params)
  .then(result => {
    console.log('Soul Recall entry status:', result);
  })
  .catch(error => {
    console.error('Failed to query Soul Recall entry status:', error);
  });

Response example

{
  "action": "SHOW_RECALL",
  "hasMigrable": true,
  "deviceCount": 2
}