Class: WebAPI

WebAPI

The abstract class to use standardized webapi.

<abstract> new WebAPI(parameters)

Parameters:

Name Type Description

parameters

Object

An object containing all parameters to pass through the inheritance chain to initialize this instance

Properties

Name	Type	Argument	Default	Description
`allowAnyOrigins`	Boolean	<optional>	false	A boolean to allow or not any origins calls
`allowedOrigins`	Array.<AllowedOrigin>	<optional>	[]	An array containing configured allowed origins
`requestTimeout`	Number	<optional>	2000	The request timeout before throw an error

Source:

sources/webapis/WebAPI.js, line 40

Members

allowedOrigins

Source:

sources/webapis/WebAPI.js, line 103

allowedOrigins

Source:

sources/webapis/WebAPI.js, line 110

logger

Source:

sources/webapis/WebAPI.js, line 85

logger

Source:

sources/webapis/WebAPI.js, line 92

methods

Source:

sources/webapis/WebAPI.js, line 159

methods

Source:

sources/webapis/WebAPI.js, line 166

requestTimeout

Source:

sources/webapis/WebAPI.js, line 140

requestTimeout

Source:

sources/webapis/WebAPI.js, line 147

Methods

<private> _broadcastReadyMessage()

Source:

sources/webapis/WebAPI.js, line 356

<async, private> _dispatchMessageFrom(origin, message)

Parameters:

Name	Type	Description
`origin`
`message`

Source:

sources/webapis/WebAPI.js, line 440

<private> _getAllowedOriginBy(propertyName, value)

Parameters:

Name	Type	Description
`propertyName`
`value`

Source:

sources/webapis/WebAPI.js, line 303

Returns:

Type: WebAPIOrigin

<private> _getOriginWindow(originURI)

Parameters:

Name	Type	Description
`originURI`

Source:

sources/webapis/WebAPI.js, line 313

Returns:

Type: Window

<private> _isInIframe()

Source:

sources/webapis/WebAPI.js, line 217

Returns:

Type: boolean

<private> _isNotAllowedForAllMethods(origin)

Parameters:

Name	Type	Description
`origin`	WebAPIOrigin

Source:

sources/webapis/WebAPI.js, line 269

Returns:

Type: boolean

<private> _isNotAllowedForAllOrigins()

Source:

sources/webapis/WebAPI.js, line 232

Returns:

Type: boolean

<private> _isNotAllowedMethod(origin, methodName)

Parameters:

Name	Type	Description
`origin`	WebAPIOrigin
`methodName`	string

Source:

sources/webapis/WebAPI.js, line 280

Returns:

Type: boolean

<private> _isNotAllowedOrigin(originURI)

Parameters:

Name	Type	Description
`originURI`

Source:

sources/webapis/WebAPI.js, line 244

Returns:

Type: boolean

<private> _isSameOrigin(originURI)

Parameters:

Name	Type	Description
`originURI`

Source:

sources/webapis/WebAPI.js, line 259

Returns:

Type: boolean

<private> _methodNotExist(methodName)

Parameters:

Name	Type	Description
`methodName`

Source:

sources/webapis/WebAPI.js, line 290

Returns:

Type: boolean

<async, private> _onMessage(event)

Parameters:

Name	Type	Description
`event`

Source:

sources/webapis/WebAPI.js, line 388

Returns:

Type: Promise.<void>

_onReadyFrom(origin, message)

Parameters:

Name	Type	Description
`origin`
`message`

Source:

sources/webapis/WebAPI.js, line 478

<async> _onRequestFrom(origin, request)

Parameters:

Name	Type	Description
`origin`
`request`

Source:

sources/webapis/WebAPI.js, line 499

_onResponseFrom(origin, response)

Parameters:

Name	Type	Description
`origin`
`response`

Source:

sources/webapis/WebAPI.js, line 536

<private> _processMessageQueueOf(origin)

Parameters:

Name	Type	Description
`origin`	WebAPIOrigin

Source:

sources/webapis/WebAPI.js, line 343

onDataFrom(origin, message)

Parameters:

Name	Type	Description
`origin`
`message`

Source:

sources/webapis/WebAPI.js, line 581

<private> onErrorFrom(origin, message)

Parameters:

Name	Type	Description
`origin`
`message`

Source:

sources/webapis/WebAPI.js, line 570

onMessageFrom(origin, message)

Parameters:

Name	Type	Description
`origin`
`message`

Source:

sources/webapis/WebAPI.js, line 592

postDataTo(originId, data)

Parameters:

Name	Type	Description
`originId`
`data`

Source:

sources/webapis/WebAPI.js, line 679

postErrorTo(originId, error)

Parameters:

Name	Type	Description
`originId`
`error`	WebAPIMessageError \| String

Source:

sources/webapis/WebAPI.js, line 667

postMessageTo(originId, message, force)

Parameters:

Name	Type	Default	Description
`originId`
`message`
`force`		false

Source:

sources/webapis/WebAPI.js, line 692

postReadyTo(originId, ready)

Parameters:

Name	Type	Description
`originId`
`ready`

Source:

sources/webapis/WebAPI.js, line 604

postRequestTo(originId, request, params)

Parameters:

Name	Type	Argument	Description
`originId`
`request`
`params`		<repeatable>

Source:

sources/webapis/WebAPI.js, line 618

Returns:

Type: Promise.<unknown>

postResponseTo(originId, request, reponse)

Parameters:

Name	Type	Description
`originId`
`request`
`reponse`

Source:

sources/webapis/WebAPI.js, line 655

setAllowedOrigins(value)

Parameters:

Name	Type	Description
`value`	Array.<WebAPIOrigin>

Source:

sources/webapis/WebAPI.js, line 187

Returns:

Type: AbstractWebAPI

setLogger(value)

Parameters:

Name	Type	Description
`value`	TLogger

Source:

sources/webapis/WebAPI.js, line 178

Returns:

Type: AbstractWebAPI

setMethods(value)

Parameters:

Name	Type	Description
`value`		Array

Source:

sources/webapis/WebAPI.js, line 205

Returns:

Type: AbstractWebAPI

setRequestTimeout(value)

Parameters:

Name	Type	Description
`value`	Number

Source:

sources/webapis/WebAPI.js, line 196

Returns:

Type: AbstractWebAPI