Class: Module

Request~Module(clientnullable)

Handles API Request Module. Scope: Store.

Constructor

new Module(clientnullable)

Module Constructor.

Module Constructor.

Parameters:
Name Type Attributes Description
client Client <nullable>
Source:
See:

Methods

createResponse() → {Response}

Create a response object from the response data.

Create a response object from the response data.

Source:
Returns:
Type
Response

getModuleCode() → {string}

Get Module_Code.

Get Module_Code.

Source:
Returns:
Type
string

getModuleFields() → {Object}

Get Module_Fields.

Get Module_Fields.

Source:
Returns:
Type
Object

getModuleFunction() → {string}

Get Module_Function.

Get Module_Function.

Source:
Returns:
Type
string

setModuleCode(moduleCode) → {Module}

Set Module_Code.

Set Module_Code.

Parameters:
Name Type Description
moduleCode string
Source:
Returns:
Type
Module

setModuleField(field, value) → {Module}

Add custom data to the request.

Add custom data to the request.

Parameters:
Name Type Description
field string
value *
Source:
Returns:
Type
Module

setModuleFields(moduleFields) → {Module}

Set Module_Fields.

Set Module_Fields.

Parameters:
Name Type Description
moduleFields Object
Source:
Returns:
Type
Module

setModuleFunction(moduleFunction) → {Module}

Set Module_Function.

Set Module_Function.

Parameters:
Name Type Description
moduleFunction string
Source:
Returns:
Type
Module

toObject() → {Object}

Reduce the request to a an object.

Reduce the request to a an object.

Source:
Returns:
Type
Object