ManageLabels

Gets the labels for the product.

Syntax

Method ID

#define WAAPI_MID_COMMON_MANAGE_LABELS 107

JSON Input Structure

{
  "input": {
    "method": 107,
    "signature": number,
    "labels": {
      "<name>": number
    },
    "reset": boolean
  }
}

Input Properties

Parameter	Type	Description
`labels`	object	(optional) The labels to configure on the endpoint. It is important to note that these changes will only exist on the client endpoint.
`labels.<name>`	number	(optional) The name of the label is the object key. The value is an enumeration for the action to take on the label: 0 = remove, 1 = add, 2 = restore default
`reset`	boolean	(optional) If true, all the products default labels will be restored. The labels input will be ignored in this case.

JSON Output Structure

{
  "result": {
    "method": 107,
    "code": number,
    "timing": number,
    "timestamp": string,
    "labels": {
      "pua": boolean,
      "toolbar": boolean,
      "bloatware": boolean,
      "adware": boolean
    }
  }
}

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.labels`	object	The labels for the product. Defined labels will ALWAYS exist, but additional labels may also be present.
`result.labels.pua`	boolean	Boolean value which is true if the product is classified as a potentially unwanted application.
`result.labels.toolbar`	boolean	Boolean value which is true if the product is classified as a toolbar application.
`result.labels.bloatware`	boolean	Boolean value which is true if the product is classified as a bloatware application.
`result.labels.adware`	boolean	Boolean value which is true if the product is classified as an adware application.

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​