DeleteBrowsingHistory

Will delete browsing history on all profiles for a given browser.

Syntax

Method ID

#define WAAPI_MID_DELETE_BROWSING_HISTORY 70005

JSON Input Structure

{
  "input": {
    "method": 70005,
    "signature": number,
    "filter": {
      "start_time": string,
      "end_time": string
    },
    "delete_all": boolean,
    "secure_delete": boolean
  }
}

Input Properties

Parameter	Type	Description
`filter`	object	A filter object for deleting browser history.
`filter.start_time`	string	The filter starting time in unix time (GMT). Browser history after this time, but before 'end_time' will be deleted.
`filter.end_time`	string	The filter ending time in unix time (GMT). Browser history before this time, but after 'start_time' will be deleted.
`delete_all`	boolean	If true, will delete all the browser history for all profiles. This has highest priority if set.
`secure_delete`	boolean	If true, will securely delete the browser history for all profiles. This key can be used in combination with other input parameters.

JSON Output Structure

{
  "result": {
    "method": 70005,
    "code": number,
    "timing": number,
    "timestamp": string,
    "synced_profiles": string
  }
}

Output Properties

Property	Type	Description
`result.method`	number	The method ID that generated this result.
`result.code`	number	The result code. See Result Codes.
`result.timing`	number	The measured time for the method call in milliseconds.
`result.timestamp`	string	The timestamp in seconds of when the call was made.
`result.synced_profiles`	string	(optional) List the profiles with sync mode enabled. Deleting browsing history does not affect synced history data.

Result Codes

Code	Name	Description
0	`WAAPI_OK`	The operation completed successfully.

note

Other codes may be returned. See the full Result Codes reference for the complete list.

Remarks

Error Handling

The results of this function are determined by the error code returned by the call. If successful, WAAPI_OK or a special success code will be returned. Always check both the function return value and the result.code field in the output JSON.

Examples

Examples will be added here demonstrating the usage of this method.

Syntax​

Method ID​

JSON Input Structure​

Input Properties​

JSON Output Structure​

Output Properties​

Result Codes​

Remarks​

Error Handling​

Examples​

See Also​