MozNetworkStatsManager.getAllAlarms()

This article needs a technical review. How you can help.

This API is available on Firefox OS for internal applications only.

Summary

The getAllAlarms method obtains all alarms for those networks returned by MozNetworkStatsManager.getAvailableNetworks. If a network is provided, it only retrieves the alarms for that network.

Syntax

var alarms = getAllAlarms(network);

Parameters

network Optional
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.getAvailableNetworks method returns an Array of interfaces.

Return

An Alarm object with the same fields as that in the system message: alarmId, network, threshold, and data.

Exceptions

InvalidNetwork
The network must be in the return of MozNetworkStatsManager.getAvailableNetworks.

Specifications

Not part of any specification.

See also

Document Tags and Contributors

 Last updated by: chrisdavidmills,