CollectChanges

This call finds the difference between the current machine state, and the base collection. If this is a new install ('signature') type collection, there needs to be a collection of running applications. The running applications found will be returned in a list, with id's and names so that a client can provide the information back to the user, and use the id to reference the selection later, in the 'GetDifference' call. These ids are temporary references, and DO NOT correspond to v4 signature id's.

Syntax

Method ID

#define WAAPI_MID_COLLECT_CHANGES 60003

JSON Input Structure

{
  "input": {
    "method": 60003,
    "type": string,
    "from_cache": boolean
  }
}

Input Properties

Parameter	Type	Description
`type`	string	The type of collection: 'signature' (for new product installs), 'added' (to see what was added), 'modified' (to see what was changed)
`from_cache`	boolean	Specifies whether to use the cache on disk as a base collection.

JSON Output Structure

{
  "result": {
    "method": 60003,
    "code": number,
    "timing": number,
    "timestamp": string,
    "list_applications": [
      {
        "title": string,
        "id": number
      },
      ...
    ]
  }
}

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.list_applications`	array<object>	An array of active applications, used to select which application to associate with the collection
`result.list_applications.title`	string	The title of the application window.
`result.list_applications.id`	number	Relative index into list of found applications, which is stored until CollectChanges is run again.

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​