Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIMetricsEventItem Interface Reference

This file defines the interfaces for the Metrics Service. More...

import "nsIMetricsService.idl";

Inheritance diagram for nsIMetricsEventItem:
Inheritance graph
[legend]
Collaboration diagram for nsIMetricsEventItem:
Collaboration graph
[legend]

List of all members.

Public Member Functions

nsIMetricsEventItem childAt (in long index)
 Returns the child event item at the given index.
long indexOf (in nsIMetricsEventItem item)
 Returns the first occurrence of the given item in the child list, or -1 if the item is not in the child list.
void appendChild (in nsIMetricsEventItem item)
 Appends a child event item to this item.
void insertChildAt (in nsIMetricsEventItem item, in long index)
 Inserts a child event item at a given index, moving later items up by one position.
void removeChildAt (in long index)
 Removes a child event item at the given index, moving all items stored at a higher position down one.
void replaceChildAt (in nsIMetricsEventItem newItem, in long index)
 Replaces a child event item at the given index.
void clearChildren ()
 Clears all of the child items.

Public Attributes

readonly attribute DOMString itemNamespace
 The namespace for this item, which must be a valid XML namespace URI.
readonly attribute DOMString itemName
 The name of this item, which must be a valid XML tag name.
attribute nsIPropertyBag properties
 A PropertyBag containing the key/value pairs to be included in the item.
readonly attribute long childCount
 The number of child event items.

Detailed Description

This file defines the interfaces for the Metrics Service.

This service allows arbitrary types of events to be logged and uploaded to a server, based on server-configured collection parameters. The nsIMetricsService API provides an abstraction for the underlying XML data format.

For more information about the data format and the built-in event collectors, see http://wiki.mozilla.org/Browser_Metrics. nsIMetricsEventItem represents a particular node of data to record in an event. Each item has a namespaced item name, a list of properties (key/value pairs), and an ordered list of child items. The child items need not be unique; an item may be repeated.

Definition at line 64 of file nsIMetricsService.idl.


Member Function Documentation

Appends a child event item to this item.

Returns the child event item at the given index.

Clears all of the child items.

Returns the first occurrence of the given item in the child list, or -1 if the item is not in the child list.

Inserts a child event item at a given index, moving later items up by one position.

Parameters:
itemThe new item to insert
indexThe position in the array. If the index is equal to childCount, the new item will be appended. The index may not be greater than childCount.

Removes a child event item at the given index, moving all items stored at a higher position down one.

Replaces a child event item at the given index.

Parameters:
newItemThe new item
indexThe position of the item to be replaced

Member Data Documentation

The number of child event items.

Definition at line 130 of file nsIMetricsService.idl.

The name of this item, which must be a valid XML tag name.

Definition at line 74 of file nsIMetricsService.idl.

The namespace for this item, which must be a valid XML namespace URI.

Definition at line 69 of file nsIMetricsService.idl.

A PropertyBag containing the key/value pairs to be included in the item.

JavaScript callers can simply set this to an object containing the key/value pairs as object properties.

Definition at line 81 of file nsIMetricsService.idl.


The documentation for this interface was generated from the following file: