Interface ScheduleCommandArgs

interface ScheduleCommandArgs {
    command: {
        commandTypeHashId: string;
        delay?: number;
        endAt?: null | Date;
        fields?: FieldsToServerFull;
        startAt?: null | Date;
    };
    markAsSent?: boolean;
}

Properties

command markAsSent?

Properties

command

command: {
    commandTypeHashId: string;
    delay?: number;
    endAt?: null | Date;
    fields?: FieldsToServerFull;
    startAt?: null | Date;
}

Type declaration

  • commandTypeHashId: string

    The hashId of the command type to parse the payload into.

  • Optional delay?: number

    In seconds. Only relevant when startAt is null. The command should then be executed by the device at time of receival + delay

  • Optional endAt?: null | Date

    Timestamp the device should stop execution of the command.

  • Optional fields?: FieldsToServerFull
  • Optional startAt?: null | Date

    Timestamp the device should execute the command. The system tries to share the command with the device before that time. If null, the device should execute it at time of receival + command.delay

Optional markAsSent

markAsSent?: boolean

If true, you do not need to call exec.markCommandAsSent for this command anymore. Default is false

Settings

Member Visibility

Theme

On This Page

commandmarkAsSent