Command

import type { Command } from "https://googleapis.deno.dev/v1/androidmanagement:v1.ts";

A command.

interface Command {

addEsimParams?: AddEsimParams;

clearAppsDataParams?: ClearAppsDataParams;

readonly clearAppsDataStatus?: ClearAppsDataStatus;

createTime?: Date;

duration?: number;

errorCode?:

| "COMMAND_ERROR_CODE_UNSPECIFIED"

| "UNKNOWN"

| "API_LEVEL"

| "MANAGEMENT_MODE"

| "INVALID_VALUE"

| "UNSUPPORTED";

readonly esimStatus?: EsimCommandStatus;

newPassword?: string;

removeEsimParams?: RemoveEsimParams;

requestDeviceInfoParams?: RequestDeviceInfoParams;

readonly requestDeviceInfoStatus?: RequestDeviceInfoStatus;

resetPasswordFlags?:

| "RESET_PASSWORD_FLAG_UNSPECIFIED"

| "REQUIRE_ENTRY"

| "DO_NOT_ASK_CREDENTIALS_ON_BOOT"

| "LOCK_NOW"[];

startLostModeParams?: StartLostModeParams;

readonly startLostModeStatus?: StartLostModeStatus;

stopLostModeParams?: StopLostModeParams;

readonly stopLostModeStatus?: StopLostModeStatus;

type?:

| "COMMAND_TYPE_UNSPECIFIED"

| "LOCK"

| "RESET_PASSWORD"

| "REBOOT"

| "RELINQUISH_OWNERSHIP"

| "CLEAR_APP_DATA"

| "START_LOST_MODE"

| "STOP_LOST_MODE"

| "ADD_ESIM"

| "REMOVE_ESIM"

| "REQUEST_DEVICE_INFO"

| "WIPE";

userName?: string;

wipeParams?: WipeParams;

}

§Properties

addEsimParams?: AddEsimParams

[src]

Optional. Parameters for the ADD_ESIM command to add an eSIM profile to the device. If this is set, then it is suggested that type should not be set. In this case, the server automatically sets it to ADD_ESIM. It is also acceptable to explicitly set type to ADD_ESIM.

clearAppsDataParams?: ClearAppsDataParams

[src]

Parameters for the CLEAR_APP_DATA command to clear the data of specified apps from the device. See ClearAppsDataParams. If this is set, then it is suggested that type should not be set. In this case, the server automatically sets it to CLEAR_APP_DATA. It is also acceptable to explicitly set type to CLEAR_APP_DATA.

readonly clearAppsDataStatus?: ClearAppsDataStatus

[src]

Output only. Status of the CLEAR_APP_DATA command to clear the data of specified apps from the device. See ClearAppsDataStatus.

createTime?: Date

[src]

The timestamp at which the command was created. The timestamp is automatically generated by the server.

duration?: number

[src]

The duration for which the command is valid. The command will expire if not executed by the device during this time. The default duration if unspecified is ten minutes. There is no maximum duration.

[src]

If the command failed, an error code explaining the failure. This is not set when the command is cancelled by the caller. For reasoning about command errors, prefer fields in the following order (most preferred first): 1. Command-specific fields like clearAppsDataStatus, startLostModeStatus, or similar, if they exist. 2. This field, if set. 3. The generic error field in the Operation that wraps the command.

readonly esimStatus?: EsimCommandStatus

[src]

Output only. Status of an ADD_ESIM or REMOVE_ESIM command.

newPassword?: string

[src]

For commands of type RESET_PASSWORD, optionally specifies the new password. Note: The new password must be at least 6 characters long if it is numeric in case of Android 14 devices. Else the command will fail with INVALID_VALUE.

removeEsimParams?: RemoveEsimParams

[src]

Optional. Parameters for the REMOVE_ESIM command to remove an eSIM profile from the device. If this is set, then it is suggested that type should not be set. In this case, the server automatically sets it to REMOVE_ESIM. It is also acceptable to explicitly set type to REMOVE_ESIM.

requestDeviceInfoParams?: RequestDeviceInfoParams

[src]

Optional. Parameters for the REQUEST_DEVICE_INFO command to get device related information. If this is set, then it is suggested that type should not be set. In this case, the server automatically sets it to REQUEST_DEVICE_INFO . It is also acceptable to explicitly set type to REQUEST_DEVICE_INFO.

readonly requestDeviceInfoStatus?: RequestDeviceInfoStatus

[src]

Output only. Status of the REQUEST_DEVICE_INFO command.

resetPasswordFlags?: "RESET_PASSWORD_FLAG_UNSPECIFIED" | "REQUIRE_ENTRY" | "DO_NOT_ASK_CREDENTIALS_ON_BOOT" | "LOCK_NOW"[]

[src]

For commands of type RESET_PASSWORD, optionally specifies flags.

startLostModeParams?: StartLostModeParams

[src]

Parameters for the START_LOST_MODE command to put the device into lost mode. See StartLostModeParams. If this is set, then it is suggested that type should not be set. In this case, the server automatically sets it to START_LOST_MODE. It is also acceptable to explicitly set type to START_LOST_MODE.

readonly startLostModeStatus?: StartLostModeStatus

[src]

Output only. Status of the START_LOST_MODE command to put the device into lost mode. See StartLostModeStatus.

stopLostModeParams?: StopLostModeParams

[src]

Parameters for the STOP_LOST_MODE command to take the device out of lost mode. See StopLostModeParams. If this is set, then it is suggested that type should not be set. In this case, the server automatically sets it to STOP_LOST_MODE. It is also acceptable to explicitly set type to STOP_LOST_MODE.

readonly stopLostModeStatus?: StopLostModeStatus

[src]

Output only. Status of the STOP_LOST_MODE command to take the device out of lost mode. See StopLostModeStatus.

[src]

The type of the command.

userName?: string

[src]

The resource name of the user that owns the device in the form enterprises/{enterpriseId}/users/{userId}. This is automatically generated by the server based on the device the command is sent to.

wipeParams?: WipeParams

[src]

Optional. Parameters for the WIPE command to wipe the device. If this is set, then it is suggested that type should not be set. In this case, the server automatically sets it to WIPE. It is also acceptable to explicitly set type to WIPE.