StructureJS
0.15.2A class based utility library for building modular and scalable web platform applications. Features opt-in classes and utilities which provide a solid foundation and toolset to build your next project.
NetworkMonitor Class
A helper class to detect network changes.
Index
Show:
Properties
- _eventDispatcher static
- _initialized
Methods
- NetworkMonitor constructor static
- _dispatchEvent static
- _onNetworkMonitorEvent static
- _start static
- addEventListener static
- connected static
- getStatus static
- removeEventListener static
Properties
_eventDispatcher
EventDispatcher
private
static
A reference to the EventDispatcher object.
_initialized
Boolean
private
A flag to determine if this class has already been initialized.
Methods
_dispatchEvent
(
-
event
)
private
static
-
event
Dispatches an event within the NetworkMonitorEvent object.
Parameters:
-
eventNetworkMonitorEventThe Event object that is dispatched into the event flow. You can create custom events, the only requirement is all events must extend the NetworkMonitorEvent.
_onNetworkMonitorEvent
(
-
event
)
private
static
-
event
An event handler method when the native Window 'online' and 'offline' events are triggered.
Parameters:
-
eventObject
_start
()
private
static
Adds the necessary event listeners to listen for the 'online' and 'offline' events.
addEventListener
(
-
type
-
callback
-
scope
-
[priority=0]
)
public
static
-
type -
callback -
scope -
[priority=0]
Registers an event listener object with an NetworkMonitor object so that the listener receives notification of an event.
Parameters:
-
typeStringThe type of event.
-
callbackFunctionThe listener function that processes the event. This function must accept an Event object as its only parameter and must return nothing, as this example shows.
-
scopeAnyBinds the scope to a particular object (scope is basically what "this" refers to in your function). This can be very useful in JavaScript because scope isn't generally maintained.
-
[priority=0]Int optionalInfluences the order in which the listeners are called. Listeners with lower priorities are called after ones with higher priorities.
Example:
NetworkMonitor.addEventListener(NetworkMonitorEvent.STATUS, this._handlerMethod, this);
_handlerMethod(event) {
console.log(event.status, event.connected);
}connected
()
Boolean
public
static
Returns the online status of the browser. The property returns a boolean value, with true for being online and false for being offline.
Returns:
Example:
NetworkMonitor.connected();getStatus
()
String
public
static
Returns if the status type ('online' or 'offline') if computer or device is connected to the internet.
Returns:
String:
Returns 'online' or 'offline'.
Example:
NetworkMonitor.getStatus();removeEventListener
(
-
type
-
callback
-
scope
)
public
static
-
type -
callback -
scope
Removes a specified listener from the NetworkMonitor object.
Parameters:
Example:
NetworkMonitor.removeEventListener(NetworkMonitorEvent.STATUS, this._handlerMethod, this);
_handlerMethod(event) {
console.log(event.status, event.connected);
}