Config1_Monitor

Represents the current state of the system. Instances of this class should be obtained using system.getMonitor().

Methods

MethodReturnsDescription
getAutoBans() Array.<Config1_AutoBan>

Returns an array of auto-ban entries for the given site.
getConnections() Array.<Config1_Connection>

Returns an array of Connection objects, each describing a single connection that currently connected to the system.
killSession() Array.<Config1_Connection>

Returns an array of Connection objects, each describing a single connection that currently connected to the system.
unbanAddress() void

Removes the auto-ban for a specific IP address on the given site.
unbanAll() void

Removes all auto-bans from the given site.

Method Details

getAutoBans(siteName) → {Array.<Config1_AutoBan>}

Description:

  • Returns an array of auto-ban entries for the given site.

Parameters:
Name Type Description
siteName String

Name of the site.
Returns:

Array of auto-ban entries.

Type
Array.<Config1_AutoBan>

getConnections() → {Array.<Config1_Connection>}

Description:

  • Returns an array of Connection objects, each describing a single connection that currently connected to the system.

Returns:

Array of Connection objects.

Type
Array.<Config1_Connection>

killSession(siteID, sessionID) → {Array.<Config1_Connection>}

Description:

  • Returns an array of Connection objects, each describing a single connection that currently connected to the system.

Parameters:
Name Type Description
siteID String

ID of site (from Connection object).
sessionID String

ID of session (from Connection object).
Returns:

Array of Connection objects.

Type
Array.<Config1_Connection>

unbanAddress(siteName, ipAddress)

Description:

  • Removes the auto-ban for a specific IP address on the given site.

Parameters:
Name Type Description
siteName String

Name of the site.
ipAddress String

IP address to unban.

unbanAll(siteName)

Description:

  • Removes all auto-bans from the given site.

Parameters:
Name Type Description
siteName String

Name of the site.