Class Away

constructor

• new Away(device, apiModuleName, childId?): Away

• Parameters

  • device: Plug

  • apiModuleName: string

  • childId: undefined | string = undefined

  Returns Away

Readonly apiModuleName

Readonly childId

Readonly device

addRule

• addRule(rule, sendOptions?): Promise<unknown>

• Adds Away Rule.

  Sends anti_theft.add_rule command and returns rule id. Support childId.

  Parameters

  • rule: AwayRuleInput

  • Optional sendOptions: SendOptions

  Returns Promise<unknown>

  parsed JSON response

  Throws

  ResponseError

deleteAllRules

• deleteAllRules(sendOptions?): Promise<unknown>

• Deletes All Away Rules.

  Sends anti_theft.delete_all_rules command. Support childId.

  Parameters

  • Optional sendOptions: SendOptions

  Returns Promise<unknown>

  parsed JSON response

  Throws

  ResponseError

deleteRule

• deleteRule(id, sendOptions?): Promise<unknown>

• Deletes Away Rule.

  Sends anti_theft.delete_rule command. Support childId.

  Parameters

  • id: string

  • Optional sendOptions: SendOptions

  Returns Promise<unknown>

  parsed JSON response

  Throws

  ResponseError

editRule

• editRule(rule, sendOptions?): Promise<unknown>

• Edits Away rule.

  Sends anti_theft.edit_rule command and returns rule id. Support childId.

  Parameters

  • rule: AwayRuleInput & {
        id: string;
    }

  • Optional sendOptions: SendOptions

  Returns Promise<unknown>

  parsed JSON response

  Throws

  ResponseError

getRule

• getRule(id, sendOptions?): Promise<{
      id: string;
  } & HasErrCode>

• Gets Away Rule.

  Requests anti_theft.get_rules and return rule matching Id. Support childId.

  Parameters

  • id: string

  • Optional sendOptions: SendOptions

  Returns Promise<{
      id: string;
  } & HasErrCode>

  Throws

  ResponseError

getRules

• getRules(sendOptions?): Promise<HasRuleListWithRuleIds & HasErrCode>

• Gets Away Rules.

  Requests anti_theft.get_rules. Support childId.

  Parameters

  • Optional sendOptions: SendOptions

  Returns Promise<HasRuleListWithRuleIds & HasErrCode>

  Throws

  ResponseError

setOverallEnable

• setOverallEnable(enable, sendOptions?): Promise<unknown>

• Enables or Disables Away Rules.

  Sends anti_theft.set_overall_enable command. Support childId.

  Parameters

  • enable: boolean | 0 | 1

  • Optional sendOptions: SendOptions

  Returns Promise<unknown>

  parsed JSON response

  Throws

  ResponseError