Interface MozNetworkStatsManager

Manages network statistics. Requires "networkstats-manage" permission. Requires "dom.mozNetworkStats.enabled" system preference.

interface MozNetworkStatsManager {
    maxStorageAge: number;
    MOBILE: 1;
    sampleRate: number;
    WIFI: 0;
    addAlarm(
        network: MozNetworkStatsInterface,
        threshold: number,
        options?: NetworkStatsAlarmOptions,
    ): DOMRequest;
    clearAllStats(): DOMRequest;
    clearStats(network: MozNetworkStatsInterface): DOMRequest;
    getAllAlarms(network?: MozNetworkStatsInterface): DOMRequest;
    getAvailableNetworks(): DOMRequest;
    getAvailableServiceTypes(): DOMRequest;
    getSamples(
        network: MozNetworkStatsInterface,
        start: Date,
        end: Date,
        options?: NetworkStatsGetOptions,
    ): DOMRequest;
    removeAlarms(alarmId?: number): DOMRequest;
}

Index

Properties

maxStorageAge MOBILE sampleRate WIFI

Methods

addAlarm clearAllStats clearStats getAllAlarms getAvailableNetworks getAvailableServiceTypes getSamples removeAlarms

Properties

`Readonly`maxStorageAge

maxStorageAge: number

The maximum age of stored statistics in milliseconds.

`Readonly`MOBILE

MOBILE: 1

Constant for Mobile network type.

`Readonly`sampleRate

sampleRate: number

The sampling rate for statistics in seconds.

`Readonly`WIFI

WIFI: 0

Constant for Wi-Fi network type.

Methods

addAlarm

addAlarm(
    network: MozNetworkStatsInterface,
    threshold: number,
    options?: NetworkStatsAlarmOptions,
): DOMRequest
Adds an alarm for network usage.
Parameters
- network: MozNetworkStatsInterface
  The network interface to monitor.
- threshold: number
  The usage threshold in bytes.
- Optionaloptions: NetworkStatsAlarmOptions
  Options for the alarm.
Returns DOMRequest
- Defined in network/moz-network-stats-manager.d.ts:48

clearAllStats

clearAllStats(): DOMRequest
Clears all network statistics.

Returns DOMRequest
- Defined in network/moz-network-stats-manager.d.ts:75

clearStats

clearStats(network: MozNetworkStatsInterface): DOMRequest
Clears statistics for a specific network.
Parameters
- network: MozNetworkStatsInterface
  The network interface to clear.
Returns DOMRequest
- Defined in network/moz-network-stats-manager.d.ts:70

getAllAlarms

getAllAlarms(network?: MozNetworkStatsInterface): DOMRequest
Retrieves all configured alarms.
Parameters
- Optionalnetwork: MozNetworkStatsInterface
  Optional network interface to filter by.
Returns DOMRequest
- Defined in network/moz-network-stats-manager.d.ts:58

getAvailableNetworks

getAvailableNetworks(): DOMRequest
Retrieves available network interfaces.

Returns DOMRequest
DOMRequest returning an array of MozNetworkStatsInterface.
- Defined in network/moz-network-stats-manager.d.ts:81

getAvailableServiceTypes

getAvailableServiceTypes(): DOMRequest
Retrieves available service types.

Returns DOMRequest
DOMRequest returning an array of strings.
- Defined in network/moz-network-stats-manager.d.ts:87

getSamples

getSamples(
    network: MozNetworkStatsInterface,
    start: Date,
    end: Date,
    options?: NetworkStatsGetOptions,
): DOMRequest
Retrieves network statistics samples.
Parameters
- network: MozNetworkStatsInterface
  The network interface to query.
- start: Date
  The start date for the statistics.
- end: Date
  The end date for the statistics.
- Optionaloptions: NetworkStatsGetOptions
  Options for filtering the statistics.
Returns DOMRequest
- Defined in network/moz-network-stats-manager.d.ts:35

removeAlarms

removeAlarms(alarmId?: number): DOMRequest
Removes alarms.
Parameters
- OptionalalarmId: number
  The ID of the alarm to remove. If not specified, removes all? (Check docs if available, but "removeAlarms" implies plural).
Returns DOMRequest
- Defined in network/moz-network-stats-manager.d.ts:64