Home Reference Source
public class | source

Browser

Extends:

Queueable → Browser

Example:

//

Method Summary

Public Methods
public

addHistory(pid: number, json: object)

Add a history entry

public

backHistory(pid: *, json: *)

public

closeEvent(pid: number, json: object)

Toggle a close page trap on and off

public

forwardHistory(pid: *, json: *)

public

initHistory(pid: number, json: object)

Start the history monitor.

public

redirect(pid: number, json: object)

Redirect browser to a new page

public

resizeMonitor(pid: number, json: object)

Add a resize monitor that runs a queue on resize

public

setTitle(pid: number, json: object)

Set page title

Inherited Summary

From class Queueable
public

queue: *

public
public

finished(pid: *, mode: *)

Call this method after you command has finished.

public

init(queue: *)

init, override this for any promise based inits setting the self.ready=true after the promise

public

set(pid: *, value: *)

public

start(pid: *, command: *, json: *)

Called from queue, starts running the actual command

Public Methods

public addHistory(pid: number, json: object) source

Add a history entry

Params:

NameTypeAttributeDescription
pid number

Process ID

json object

queue arguments

json.history string

history name to add

json.force string

force history on same url

public backHistory(pid: *, json: *) source

Params:

NameTypeAttributeDescription
pid *
json *

public closeEvent(pid: number, json: object) source

Toggle a close page trap on and off

Params:

NameTypeAttributeDescription
pid number

Process ID

json object

queue arguments

json.mode string

on|off

public forwardHistory(pid: *, json: *) source

Params:

NameTypeAttributeDescription
pid *
json *

public initHistory(pid: number, json: object) source

Start the history monitor.

Detects when the user navigates via back / forward button and runs queue based on history item added via addHistory

Params:

NameTypeAttributeDescription
pid number

Process ID

json object

queue arguments

public redirect(pid: number, json: object) source

Redirect browser to a new page

Params:

NameTypeAttributeDescription
pid number

Process ID

json object

queue arguments

json.location string

Dom location to direct to

public resizeMonitor(pid: number, json: object) source

Add a resize monitor that runs a queue on resize

Params:

NameTypeAttributeDescription
pid number

Process ID

json object

queue arguments

json.name string

queue to run on resize

public setTitle(pid: number, json: object) source

Set page title

Params:

NameTypeAttributeDescription
pid number

Process ID

json object

queue arguments

json.title string

new page title