5.7.153. Bugzilla::Extension::ComponentWatching::WebService

5.7.153.1. NAME

Bugzilla::Extension::ComponentWatching::WebService - The API for managing Component Watching preferences.

5.7.153.2. DESCRIPTION

Component Watching allows you to get bug mail for products and components without having a role on bugs in those products or components.

5.7.153.3. METHODS

See Bugzilla::WebService for a description of how parameters are passed, and what STABLE, UNSTABLE and EXPERIMENTAL mean.

get

  • Description
Get your current watches.
  • Params
None.
  • Returns

This call returns an array of hashes. Each hash contains:

  • product - string
The name of the product.
  • components (array) - string (optional)
The name of any components in this product that are directly watched.
  • prefix (array) - string (optional)
The start string to match for components in this product.

Example:

Call:

{"method": "ComponentWatching.get"}

Returns:

{
  "watches": {
      "Bugzilla": {
        "components": [
            "__Any__"
        ]
      },
      "Fedora": {
        "components": [
            "fu",
            "bar"
        ]
      }
  }
}

add

  • Description
Add new watching rules.
  • Params

An array of hashes of rules. One hash entry for each product being modified.

Each hash contains:

  • product - string

The name of the product.

If this is the only entry then you will watch all components in the product.

  • components (array) - string (optional)
An array of component names to watch.
  • starts_with - string (optional)
A string to match the start of component names against. You will get bug mail for all components that start with this string.
  • Returns

The updated watch list.

Example:

Call:

{
  "method": "ComponentWatching.add",
  "params": [
    {
      "product" => "Bugzilla",
      "components" => ["Bugzilla General"]
    }
  ]
}

Returns:

{
  "watches": {
    "Bugzilla": {
      "components": [
          "Bugzilla General"
      ]
    }
  }
}

remove

  • Description
Remove watches.
  • Params
Same as add.
  • Returns

The updated watch list.

Example:

Call:

{
  "method": "ComponentWatching.remove",
  "params": [
    {
      "product" => "Bugzilla",
      "components" => ["Bugzilla General"]
    }
  ]
}

Returns:

{
  "watches": {}
}

This documentation undoubtedly has bugs; if you find some, please file them here.