JSDoc: Global

Members

_stepReady :Boolean

Indicates if we had run the date-time step in ftu or not.

Type:

Boolean

Source:

js/time_core.js, line 22

active :Boolean

Indicates the emergency callback state

Type:

Boolean

Source:

js/emergency_callback_manager.js, line 39

connected :Boolean

Indicate there is active tethering client

Type:

Boolean

Source:

js/tethering_monitor.js, line 23

enabled :Boolean

Indicate if the tethering is enabled

Type:

Boolean

Source:

js/tethering_monitor.js, line 18

FxaModuleCoppa

This module allow the user to select her age from a date picker and checks that she is old enough to create a Firefox account.

This module allow the user to select her age from a date picker and checks that she is old enough to create a Firefox account. Otherwise, it shows an error.

Source:

fxa/js/screens/fxam_coppa.js, line 15

FxaModuleEnterEmail

This module checks the validity of an email address, and if valid, determines which screen to go next.

Source:

fxa/js/screens/fxam_enter_email.js, line 16

FxaModuleEnterPassword

This module checks the validity of password given email address, and if valid, determine which screen to go next.

Source:

fxa/js/screens/fxam_enter_password.js, line 15

FxaModuleSetPassword

Takes care of a new user's set password screen.

Takes care of a new user's set password screen. If password is valid, attempt to stage the user.

Source:

fxa/js/screens/fxam_set_password.js, line 14

FxaModuleSigninSuccess

Display the signup success message to the user.

Source:

fxa/js/screens/fxam_signin_success.js, line 12

FxaModuleSignupSuccess

Display the signup success message to the user.

Source:

fxa/js/screens/fxam_signup_success.js, line 12

idb

Support different browser versions of IndexedDB

Source:

js/migrators/browser_migrator.js, line 8

IGNORED_INPUT_TYPES

For some flow diagrams related to input management, please refer to https://wiki.mozilla.org/Gaia/System/InputManagement#Flow_Diagrams .

Source:

js/keyboard_manager.js, line 16

lockScreen

Source:

lockscreen/js/lockscreen.js, line 1158

PRIORITIES :Array

Predefined priorities per module by module name.

Type:

Array

Source:

js/hierarchy_manager.js, line 62

SpinDatePicker

SpinDatePicker is a html/js "widget" which enables users pick a specific date.

SpinDatePicker is a html/js "widget" which enables users pick a specific date. It display the date in the way based on the language setting.

The SpinDatePicker itself contains no UI for the controls.

Example usage:

// All necessary UI elements are contained in the root element. var picker = new SpinDatePicker(root); picker.value = new Date(); // after users pick a date var newDate = picker.value;

Source:

js/value_selector/spin_date_picker.js, line 20

ValuePicker

base widget used in ValueSelector and SpinDatePicker widget

Source:

js/value_selector/value_picker.js, line 7

Methods

"_observe_vibration.enabled"(value)

Observer the value of vibration.enabled settings.

Parameters:

Name	Type	Description
`value`	Boolean	The value of the settings.

Source:

js/audio_channel_policy.js, line 212

_choiceFromDefaultAction(defaultChoice) → {Integer}

This gets the index from the defaultChoice in the choices list.

Parameters:

Name	Type	Description
`defaultChoice`	Object	The default choice

Source:

js/activities.js, line 117

Returns:

The index where the default choice is located. -1 if it is not found

Type: Integer

_debug()

Debug method

Source:

js/ndef_utils.js, line 39

_deleteAudioChannelFromInterruptedAudioChannels(audioChannel)

Delete the audio channel from _interruptedAudioChannels array.

Parameters:

Name	Type	Description
`audioChannel`	AudioChannelController	The audio channel want to delete.

Source:

js/audio_channel_service.js, line 193

_fadeInFadedOutAudioChannels()

Fade in all faded out audio channels.

Source:

js/audio_channel_service.js, line 155

_getDefaultPreferredNetworkType()

Returns the default preferred network types based on the hardware supported network types.

Source:

js/telephony_settings.js, line 251

_getDefaultPreferredNetworkTypes()

Returns an array specifying the default preferred network types of all mobile connections.

Source:

js/telephony_settings.js, line 241

_handle_audiochanneldestroyed(evt)

Remove the window's audio channels from _activeAudioChannels and _interruptedAudioChannels when the window is terminated.

Parameters:

Name	Type	Description
`evt`	Event	The event to handle.

Source:

js/audio_channel_service.js, line 64

_handle_audiochannelstatechanged(evt)

Handle the audio chanel when it is active or in inactive.

Parameters:

Name	Type	Description
`evt`	Event	The event to handle.

Source:

js/audio_channel_service.js, line 51

_handle_hierarchytopmostwindowchanged()

Handle the audio chanel when the app is in foreground or background.

Source:

js/audio_channel_service.js, line 74

_handle_mozChromeEvent(evt)

Handle MozChromeEvent.

Parameters:

Name	Type	Description
`evt`	Event	The event to handle.

Source:

js/system_window.js, line 43

_handleAudioChannel(audioChannel)

Handle the audio channel and update _activeAudioChannels and _interruptedAudioChannels.

Parameters:

Name	Type	Description
`audioChannel`	AudioChannelController	The audio channel.

Source:

js/audio_channel_service.js, line 135

_isAudioChannelInBackground(audioChannel)

Check the audio channel is in background or not.

Parameters:

Name	Type	Description
`audioChannel`	AudioChannelController	The audio channel.

Source:

js/audio_channel_service.js, line 208

_isNeededToFadeOutForActiveAudioChannel(activeChannelName, newChannelName) → {Boolean}

Get the policy of fading out the active audio channel.

Parameters:

Name	Type	Description
`activeChannelName`	String	The active audio channel name.
`newChannelName`	String	The new audio channel name.

Source:

js/audio_channel_policy.js, line 244

Returns:

Type: Boolean

_isNeededToFadeOutForNewAudioChannel(activeChannelName, newChannelName) → {Boolean}

Get the policy of fading out the new audio channel.

Parameters:

Name	Type	Description
`activeChannelName`	String	The active audio channel name.
`newChannelName`	String	The new audio channel name.

Source:

js/audio_channel_policy.js, line 223

Returns:

Type: Boolean

_isNeededToResumeWhenOtherEndsForActiveAudioChannel(activeChannelName, newChannelName) → {Boolean}

Get the policy of resuming the active audio channel when any other audio channel ends.

Parameters:

Name	Type	Description
`activeChannelName`	String	The active audio channel name.
`newChannelName`	String	The new audio channel name.

Source:

js/audio_channel_policy.js, line 283

Returns:

Type: Boolean

_isNeededToVibrateForActiveAudioChannel(activeChannelName, newChannelName) → {Boolean}

Get the policy of vibrating for the active audio channel.

Parameters:

Name	Type	Description
`activeChannelName`	String	The active audio channel name.
`newChannelName`	String	The new audio channel name.

Source:

js/audio_channel_policy.js, line 270

Returns:

Type: Boolean

_manageAudioChannels(audioChannel)

Play or pause the new audio channel and the active audio channels.

Parameters:

Name	Type	Description
`audioChannel`	AudioChannelController	The new audio channel.

Source:

js/audio_channel_service.js, line 96

_resetAudioChannel(audioChannel)

Set the audio channel as default state as muted, and fade in the faded out audio channels.

Parameters:

Name	Type	Description
`audioChannel`	AudioChannelController	The audio channel.

Source:

js/audio_channel_service.js, line 122

_resumeAudioChannels(appopt)

Resume interrupted audio channels.

Parameters:

Name	Type	Attributes	Description
`app`	AppWindow	<optional>	The app window in foreground.

Source:

js/audio_channel_service.js, line 168

_sendContentEvent(detail)

Send MozContentEvent to control the audio chanenl in System app.

Parameters:

Name Type Description

detail

Object

The arguments for passing to Gecko.

Properties

Name	Type	Description
`type`	Object	The operation for the audio channel.

Source:

js/system_window.js, line 62

_start()

Initial the module.

Source:

js/system_window.js, line 31

_start()

Initial the module.

Source:

js/audio_channel_service.js, line 40

addObserver(name, context)

addObserver provides a "addEventListener"-like interface to observe settings change.

Parameters:

Name	Type	Description
`name`	String	The settings name
`context`	Object	The object which wants to observe the settings. It should have a method named for 'observe'.

Source:

js/settings_core.js, line 99

Example

var s = new SettingsCore();
s.start();
var MyModule = {
  init: function() {
    s.addObserver('lockscreen.enabled', this);
    s.addObserver('lockscreen.locked', this);
  },
  observe: function(name, value) {
    console.log('settings of ' + name + ' had changed to ' + value);
  }
};
MyModule.init();

applyPolicy(newAudioChannel, activeAudioChannels, optionsopt)

Get the policies of handling the new audio channel and active audio channels.

Parameters:

Name Type Attributes Description

newAudioChannel

AudioChannelController

A new audio channel you want to handle.

activeAudioChannels

Map

Active audio channels playing noew.

options

Object

Options.

Properties

Name	Type	Attributes	Description
`isNewAudioChannelInBackground`	Boolean	<optional>	Is the new audio channel in background.

Source:

js/audio_channel_policy.js, line 125

broadcast(evt)

Broadcast hierarchy based event until it's blocked

Parameters:

Name	Type	Description
`evt`	DOMEvent	Event to be broadcast

Source:

js/hierarchy_manager.js, line 186

checkTopSites()

Check if we need to render a screenshot of the current visit in the case that it is in the top most visited sites

Source:

js/places.js, line 282

destroy()

Remove all event listeners.

Remove all event listeners. This is mainly used in unit tests.

Source:

js/activities.js, line 40

DownloadNotification(download)

This is the constructor that will represent a download notification in the system

Parameters:

Name	Type	Description
`download`	Object	object provided by the API.

Source:

js/download/download_notification.js, line 12

encodeEmptyHandoverSelect() → {Array}

Returns an empty Handover Select NDEF message (i.e., a Hs message with no AC).

Source:

js/ndef_utils.js, line 429

Returns:

NDEF records for an empty handover select message.

Type: Array

encodeHandoverRequest(mac, cps) → {Array}

Returns a Bluetooth Handover Request message.

Returns a Bluetooth Handover Request message. This method DOES NOT implement a full set of arguments as defined in NFCForum-AD-BTSSP_1.0.1.

First record is a Handover Request Record (type="Hr"). It contains CPS and 2-byte random value used for collision detection (autogenerated).

Second record contains Bluetooth OOB data. For explanation,

Parameters:

Name	Type	Description
`mac`	String	MAC address, ie.: "01:23:45:67:89:AB".
`cps`	Integer	Carrier Power State.

Source:

js/ndef_utils.js, line 313

See:

encodeHandoverSelect() and specification.

Returns:

NDEF records for handover select message.

Type: Array

encodeHandoverSelect(mac, cps, btDeviceName) → {Array}

Returns a Bluetooth Handover Select message.

Returns a Bluetooth Handover Select message. This method DOES NOT implement the full spec as defined in NFCForum-AD-BTSSP_1.0.1. In particular, this method supports only Bluetooth device MAC address and Local Name in the Bluetooth Carrier Configuration Record.

First record is Handover Select Record (type="Hs"). It contains, among other things, the CPS (Carrier Power State).

Second record of this message contains Bluetooth Out of Band (OOB) data. It contains following fields:

[2 octets] OOB Data Length - Mandatory. Total length of OOB data,

                         including this field itself.

[6 octets] BT Device Address - Mandatory. BT device address (MAC).

[N octets] OOB Optional Data - The remaining data in EIR format.

                           This method supports only device name
                           here.

EIR data, as of this implementation, is optional. It will be ommited if you do not pass btDeviceName parameter. If you do, OOB Optional Data will be in a form:

[1 octet] EIR Data Length - Does not include this field.
[1 octet] EIR Data Type - only 0x09 (BT Local Name) supported.
[N octets] Contents - BT Local Name

Parameters:

Name	Type	Description
`mac`	String	MAC address, ie.: "01:23:45:67:89:AB".
`cps`	Integer	Carrier Power State.
`btDeviceName`	UInt8Array	Optional, user-friendly name of Bluetooth device.

Source:

js/ndef_utils.js, line 381

Returns:

NDEF records for handover select message.

Type: Array

ensureValueUnderKeyIsArray()

Helper function.

Helper function. Ensure the value stored under the specified key is an array.

Source:

js/operator_variant_manager.js, line 79

formatMAC(Array) → {String}

Formats MAC address as a MAC-48 string (colon-separated).

Parameters:

Name	Type	Description
`Array`	Array	of six numbers representing MAC.

Source:

js/ndef_utils.js, line 243

Returns:

MAC address.

Type: String

getTopMostWindow() → {AppWindow|undefined}

Provide the top most window information.

Provide the top most window information. Usually used by integration tests.

Source:

js/hierarchy_manager.js, line 40

Returns:

The top most window instance.

Type: AppWindow | undefined

hasActiveCall(index) → {Boolean}

Check if there is active call

Parameters:

Name	Type	Description
`index`	Number	If not specified, it means any active call; if specified, it means the active call at this SIM slot.

Source:

js/telephony_monitor.js, line 21

Returns:

There is active call or not.

Type: Boolean

initCallerIdPreference()

Initializes caller id restriction based on user setting.

CLIR_DEFAULT: 0 CLIR_INVOCATION: 1 CLIR_SUPPRESSION: 2

Source:

js/telephony_settings.js, line 86

initPreferredNetworkType()

Initialize preferred network type.

Initialize preferred network type. If the default value is null, we should use the option that makes the device able to connect all supported netwrok types.

Source:

js/telephony_settings.js, line 196

initRoaming()

Initializes roaming based on user setting.

Source:

js/telephony_settings.js, line 59

initVoicePrivacy()

Initializes voice privacy based on user setting.

Source:

js/telephony_settings.js, line 36

launch(manifestURL, openOnStart)

This service will be requested by Launcher.

Parameters:

Name	Type	Description
`manifestURL`	String	The manifest URL of homescreen
`openOnStart`	Boolean	If this is true, we will open the window right away

Source:

js/homescreen_launcher.js, line 135

launch(manifestURL)

The function will be requested by the global Launcher when it gets the ftu manifestURL.

Parameters:

Name	Type	Description
`manifestURL`	String	The manifest URL of ftu

Source:

js/ftu_launcher.js, line 138

parseBluetoothSSP(cdr) → {Object}

Parses a Carrier Data Record according to NFCForum-AD-BTSSP_1.0.

Parses a Carrier Data Record according to NFCForum-AD-BTSSP_1.0. This method will parse MAC address. In addition to that, it will parse, if found in EIR data, Bluetooth Local Name. Other EIR fields are currently unsupported.

Parameters:

Name	Type	Description
`cdr`	Object	Carrier Data Record. It's payload field should contain Bluetooth OOB data.

Source:

js/ndef_utils.js, line 191

Returns:

Parsed record. Will always contain 'mac' property. If BT local name was present in cdr, will also have 'localName' property. Null if cdr was invalid.

Type: Object

parseHandoverNDEF(ndefMsg) → {Object}

Parse Handover Request NDEF message.

Parse Handover Request NDEF message. Only 'Hr' and 'Hs' records are supported (NFCForum-TS-ConnectionHandover_1_2.doc).

Returns handover object similar to: { majorVersion: 1, minorVersion: 2, type: 'Hr' // or 'Hs' cr: 123 // 'Hr' only ac: [ // Array of BT OOB records { cps: 1, cdr: ... // MozNDEFRecord with details, i.e. }, // Bluetooth MAC address. ... ] }

Parameters:

Name	Type	Description
`ndefMsg`	Array	NDEF message (array of MozNDEFRecords)

Source:

js/ndef_utils.js, line 76

Returns:

Parsed handover request or null if ndefMsg was not valid or well formatted.

Type: Object

parseMAC(MAC) → {Array}

Parses Bluetooth MAC-48 address.

Parameters:

Name	Type	Description
`MAC`	String	address.

Source:

js/ndef_utils.js, line 264

Returns:

Array of six numbers representing MAC or null if it was not valid.

Type: Array

registerHierarchy()

This function is used for any UI module who wants to occupy the hierachy.

Source:

js/hierarchy_manager.js, line 207

searchForBluetoothAC(h) → {Object}

Returns first record from handover message which contains Bluetooth OOB (Out of Band) data.

Parameters:

Name	Type	Description
`h`	Array	Handover message (array of records).

Source:

js/ndef_utils.js, line 166

Returns:

MozNDEFRecord with Bluetooth OOB.

Type: Object

sendNDEFMessageToNFCPeer(message, nfcEvent)

Send NDEF message to NFC peer.

Parameters:

Name	Type	Description
`message`	MozNDEFRecord	non-null Array of NDEF records.
`nfcEvent`	Events	an event from mozNfc.onpeerready.

Source:

js/nfc_handler.js, line 35

setVisits()

Manually set the previous visits array of timestamps, used for migrations

Source:

js/places.js, line 235

unregisterHierarchy()

Remove the module reference from the living UI list.

Source:

js/hierarchy_manager.js, line 240

validateCPS() → {Boolean}

According to [CH] (Connection Handover Technical Specification), CPS can be one of the following:

0 - Inactive
1 - Active
2 - Activating
3 - Unknown

According to [CH] (Connection Handover Technical Specification), CPS can be one of the following:

0 - Inactive
1 - Active
2 - Activating
3 - Unknown

Source:

js/ndef_utils.js, line 290

Returns:

True when cps valid. False otherwise.

Type: Boolean

Type Definitions

ActivityConfig

Activity Config

Type:

Object

Properties:

Name	Type	Description
`manifestURL`	String	The manifestURL of the activity
`url`	String	The URL of the activity handling page
`isActivity`	Boolean
`inline`	Boolean	The disposition of the activty is inline or not

Source:

js/activity_window_manager.js, line 69

BrowserConfig

Browser Configuration

Type:

Object

Properties:

Name	Type	Description
`origin`	String	the same as appURL.
`manifestURL`	String	the same as manifestURL.
`manifest`	Object	the parsed manifest object. If the app is not an entry point app, the manifest would be the reference of application manifest stored in Applications module. But if the app is an entry point app, we will do deep clone to generate a new object and replace the properties of entry point to proper position.
`name`	String	the name of the app, retrieved from manifest.
`oop`	Boolean	Indicate it's running out of process or in process.

Source:

js/app_window_factory.js, line 154