This API is available on Firefox OS for internal applications only.
Summary
The addAlarm method installs an alarm on a network. When total data usage reaches threshold bytes, a "networkstats-alarm" system message is sent to the application, where the optional parameter data must be a cloneable object.
Syntax
var alarm = addAlarm(network, threshold, options);
Parameters
network- The origin of the data. It can specify wifi, mobile, or null. If null, data measurement from both origins are merged. To know in advance which kind of origin is available, the
MozNetworkStatsManager.getAvailableNetworksmethod returns an Array of interfaces. threshold- The total data usage threshold in bytes.
optionsOptional- Filtering options.
- NetworkStatsAlarmOptions is a dictionary object providing filtering options.
Return
A DOMRequest object. If successful, the result field of the DOMRequest keeps the alarm Id.
Exceptions
- InvalidNetwork
- The
networkmust be in the return ofMozNetworkStatsManager.getAvailableNetworks.
Specifications
Not part of any specification.