API Docs for: 0.9.1
Show:

ServiceEndPoint Class

Extends ServiceObject
Defined in: lib/service/endPoint.js:9

Methods

_getChildOptions

() Object private

Defined in lib/service/endPoint.js:122

Gets the options for children

Returns:

Object:

getAllItems

(
  • [options]
)
Promise

Defined in lib/service/endPoint.js:152

Gets a list of items

Parameters:

Returns:

Promise:

With {ServiceList}

getFieldInfo

(
  • field
)
Object

Defined in lib/service/endPoint.js:60

Gets details field information

Parameters:

Returns:

Object:

getFields

() String[]

Defined in lib/service/endPoint.js:39

Gets a list of fields available

Returns:

String[]:

getItem

(
  • id
)
Promise

Defined in lib/service/endPoint.js:184

Gets an item

Parameters:

Returns:

Promise:

With {ServiceEntry}

getOptions

() Object

Inherited from ServiceBaseObject: lib/service/abstract/object.js:35

Gets all options supplied when created

Returns:

Object:

getPluralModuleName

() String

Defined in lib/service/endPoint.js:28

Gets the plural module identifier

Returns:

String:

getRequest

() ServiceRequest

Inherited from ServiceBaseObject: lib/service/abstract/object.js:45

Gets the request object

Returns:

ServiceRequest:

getService

() ServiceLookup

Inherited from ServiceObject: lib/service/abstract/serviceObject.js:19

Gets the service object

Returns:

ServiceLookup:

getSingularModuleName

() String

Defined in lib/service/endPoint.js:18

Gets the singular module identifier

Returns:

String:

hasField

(
  • field
)
Boolean

Defined in lib/service/endPoint.js:49

Checks if a field is available

Parameters:

Returns:

Boolean:

initialize

()

Inherited from ServiceBaseObject: lib/service/abstract/object.js:25

Initializes the data-object

loadEntry

(
  • entry
  • [options]
)
ServiceEntry

Defined in lib/service/endPoint.js:105

Retrieves an entry object

Parameters:

Returns:

ServiceEntry:

loadList

(
  • items
  • [options]
)
ServiceList

Defined in lib/service/endPoint.js:89

Retrieves a list object

Parameters:

Returns:

ServiceList:

newEntry

(
  • [entry]
)
ServiceEntry

Defined in lib/service/endPoint.js:77

Retrieves a new entry object

Parameters:

Returns:

ServiceEntry:

queryItems

(
  • query
  • [options]
)
Promise

Defined in lib/service/endPoint.js:203

Queries a list of items

Parameters:

Returns:

Promise:

With {ServiceList}

removeItem

(
  • id
)
Promise

Defined in lib/service/endPoint.js:138

Removes an item

Parameters:

Returns:

Promise:

With {string} id

Properties

TYPE

String static

Defined in lib/service/endPoint.js:237