Class EFMControllerFactory

Hierarchy

GenericControllerFactory
- EFMControllerFactory

Constructors

constructor

new EFMControllerFactory(deviceaddress: string): EFMControllerFactory

Overrides GenericControllerFactory.constructor
- Defined in src/driver/efm/lib.ts:34
EFMControllerFactory constructor

Parameters
- deviceaddress: string
  
  Target device address (e.g. http://192.168.0.1/)
Returns EFMControllerFactory

Properties

Protected api

api: AxiosInstance

Protected credential

credential: any

Protected deviceaddress

deviceaddress: string

Protected login

login: null | EFMCredential = null

Accessors

authCookie

get authCookie(): string
set authCookie(cookie: string): void

- Defined in src/driver/efm/lib.ts:133
Retreve authenticaion session cookie.

Returns string
- Defined in src/driver/efm/lib.ts:125
Set credential using EFM ipTIME auth cookie.

Parameters
- cookie: string
Returns void

Methods

authenticate

authenticate(credential: EFMCredential, captcha?: null | EFMCaptcha): Promise<void>

Overrides GenericControllerFactory.authenticate
- Defined in src/driver/efm/lib.ts:75
Log-in ipTIME router with given credential and get session cookie from the result.

Parameters
- credential: EFMCredential
  
  authentication credential of ipTIME router
- captcha: null | EFMCaptcha = null
  
  CAPTCHA login support. You must supply captcha filename and challenge response
Returns Promise<void>

getAuthConfigurator

getAuthConfigurator(): GenericAuthConfigurator

Overrides GenericControllerFactory.getAuthConfigurator
- Defined in src/driver/efm/lib.ts:196
Returns GenericAuthConfigurator

getCaptchaChallenge

getCaptchaChallenge(): Promise<{ data: Buffer; name: string }>

- Defined in src/driver/efm/lib.ts:50
Get CAPTCHA challenge from router

Returns Promise<{ data: Buffer; name: string }>
Captcha image(gif) with its name

getFirewallConfigurator

getFirewallConfigurator(): FirewallConfigurator

Overrides GenericControllerFactory.getFirewallConfigurator
- Defined in src/driver/efm/lib.ts:180
Get firewall configurator object

Returns FirewallConfigurator

getLogman

getLogman(): Logman

Overrides GenericControllerFactory.getLogman
- Defined in src/driver/efm/lib.ts:173
Get log manager object

Returns Logman
Logman object with auth cookie.

getNetTester

getNetTester(): NetTester

Overrides GenericControllerFactory.getNetTester
- Defined in src/driver/efm/lib.ts:184
Returns NetTester

getProfileManager

getProfileManager(): GenericProfileManager

Overrides GenericControllerFactory.getProfileManager
- Defined in src/driver/efm/lib.ts:204
Returns GenericProfileManager

getRouteConfigurator

getRouteConfigurator(): RouteConfigurator

Overrides GenericControllerFactory.getRouteConfigurator
- Defined in src/driver/efm/lib.ts:188
Returns RouteConfigurator

getSwitchConfigurator

getSwitchConfigurator(): SwitchConfigurator

Overrides GenericControllerFactory.getSwitchConfigurator
- Defined in src/driver/efm/lib.ts:160
Get SwitchConfigurator object

Returns SwitchConfigurator
SwitchConfigurator object with auth cookie.

getSwitchQoS

getSwitchQoS(): SwitchQoS

Overrides GenericControllerFactory.getSwitchQoS
- Defined in src/driver/efm/lib.ts:164
Returns SwitchQoS

getTrafficStatMonitor

getTrafficStatMonitor(): TrafficStatMonitor

Overrides GenericControllerFactory.getTrafficStatMonitor
- Defined in src/driver/efm/lib.ts:192
Returns TrafficStatMonitor

getVPNConfigurator

getVPNConfigurator(): VPNConfigurator

Overrides GenericControllerFactory.getVPNConfigurator
- Defined in src/driver/efm/lib.ts:200
Returns VPNConfigurator

getWLANConfigurator

getWLANConfigurator(): WLANConfigurator

Overrides GenericControllerFactory.getWLANConfigurator
- Defined in src/driver/efm/lib.ts:142
Get EFMWLANConfigurator object.

Returns WLANConfigurator
EFMWLANConfiguratior object with authentication cookie

getWLANUserDeviceStat

getWLANUserDeviceStat(): WLANUserDeviceStat

Overrides GenericControllerFactory.getWLANUserDeviceStat
- Defined in src/driver/efm/lib.ts:151
Get WLANUserDeviceStat object.

Returns WLANUserDeviceStat
WLANUserDeviceStat object with authentication cookie

init

init(): Promise<void>

Inherited from GenericControllerFactory.init
- Defined in src/driver/generic/lib.ts:30
Dummy function (placeholder for children)

Returns Promise<void>

refreshAuth

refreshAuth(): Promise<void>

Overrides GenericControllerFactory.refreshAuth
- Defined in src/driver/efm/lib.ts:114
Returns Promise<void>

Protected updateCredential

updateCredential(cred: any): void

Inherited from GenericControllerFactory.updateCredential
- Defined in src/driver/generic/lib.ts:23
Parameters
- cred: any
Returns void

Generated using TypeDoc