Class Model

Platform 3.8+ The main class for interacting with UX data sources

Hierarchy

default
- Model

Index

Constructors

constructor

new Model(appConfig, auth): Model
Parameters
- appConfig: AppConfig
- auth: Auth
Returns Model
Overrides BaseModel.constructor
- Defined in services/Model.ts:17

Properties

appConfig

appConfig: AppConfig

auth

auth: Auth

`Optional` webContextId

webContextId?: string

Methods

Init

Init(): Promise<void>
Returns Promise<void>
Inherited from BaseModel.Init
- Defined in services/utils/base/BaseModel.ts:25

`Protected` _buildRecordIds

_buildRecordIds(recordIds): null | object | object[]
Parameters
- recordIds: string | string[]
Returns null | object | object[]
Inherited from BaseModel._buildRecordIds
- Defined in services/utils/base/BaseModel.ts:215

`Protected` _generateRecordActionRequest

_generateRecordActionRequest<T>(context, recordIds, method, type, query?, refresh?, actionGroup?, action?, wfParametersMap?): [RequestInit, URL]
Type Parameters
- T = BaseRecord
Parameters
- context: string
- recordIds: string | string[]
- method: string
- type: string
- Optional query: null | Query
- Optional refresh: null | boolean
- Optional actionGroup: null | string
- Optional action: null | string
- Optional wfParametersMap: null | object
Returns [RequestInit, URL]
Inherited from BaseModel._generateRecordActionRequest
- Defined in services/utils/base/BaseModel.ts:69

`Protected` _generateRecordUpdateRequest

_generateRecordUpdateRequest<T>(context, data, method, type, query?, refresh?, actionGroup?, action?, wfParametersMap?): [RequestInit, URL]
Type Parameters
- T = BaseRecord
Parameters
- context: string
- data: T | T[]
- method: string
- type: string
- Optional query: null | Query
- Optional refresh: null | boolean
- Optional actionGroup: null | string
- Optional action: null | string
- Optional wfParametersMap: null | object
Returns [RequestInit, URL]
Inherited from BaseModel._generateRecordUpdateRequest
- Defined in services/utils/base/BaseModel.ts:29

`Protected` _generateRequestOptions

_generateRequestOptions(): RequestInit
Returns RequestInit
Inherited from BaseModel._generateRequestOptions
- Defined in services/utils/base/BaseModel.ts:202

`Protected` _generateRequestUrl

_generateRequestUrl(context, type, actionGroup?, action?, query?, multiContextIds?, refresh?, countOnly?, reserveIncludeUnavailable?): URL
Parameters
- context: string
- type: string
- Optional actionGroup: null | string
- Optional action: null | string
- Optional query: null | Query
- Optional multiContextIds: null | string[]
- Optional refresh: null | boolean
- Optional countOnly: null | boolean
- Optional reserveIncludeUnavailable: null | boolean
Returns URL
Inherited from BaseModel._generateRequestUrl
- Defined in services/utils/base/BaseModel.ts:150

`Protected` _send

_send<T>(requestUrl, requestOptions): Promise<T>
Type Parameters
- T = unknown
Parameters
- requestUrl: URL
- requestOptions: RequestInit
Returns Promise<T>
Inherited from BaseModel._send
- Defined in services/utils/base/BaseModel.ts:130

`Protected` _setWebContextId

_setWebContextId(): Promise<void>
Returns Promise<void>
Inherited from BaseModel._setWebContextId
- Defined in services/utils/base/BaseModel.ts:112

addRecord

addRecord<T>(context, recordIds, actionGroup?, action?, query?, refresh?, wfParametersMap?): Promise<UpdateRecordResponse<T>>
Type Parameters
- T = BaseRecord
Parameters
- context: string
- recordIds: string | string[]
- Optional actionGroup: null | string
- Optional action: null | string
- Optional query: null | Query
- Optional refresh: null | boolean
- Optional wfParametersMap: null | object
Returns Promise<UpdateRecordResponse<T>>
- Defined in services/Model.ts:58

createRecord

createRecord<T>(context, data, actionGroup, action, query?, refresh?, wfParametersMap?): Promise<CreateRecordResponse<T>>
Type Parameters
- T = BaseRecord
Parameters
- context: string
- data: T | T[]
- actionGroup: string
- action: string
- Optional query: null | Query
- Optional refresh: null | boolean
- Optional wfParametersMap: null | object
Returns Promise<CreateRecordResponse<T>>
- Defined in services/Model.ts:86

deleteRecord

deleteRecord<T>(context, recordIds, actionGroup?, action?, query?, refresh?, wfParametersMap?): Promise<UpdateRecordResponse<T>>
Type Parameters
- T = BaseRecord
Parameters
- context: string
- recordIds: string | string[]
- Optional actionGroup: null | string
- Optional action: null | string
- Optional query: null | Query
- Optional refresh: null | boolean
- Optional wfParametersMap: null | object
Returns Promise<UpdateRecordResponse<T>>
- Defined in services/Model.ts:114

getRecord

getRecord<T>(context, query?, multiContextIds?, countOnly?, reserveIncludeUnavailable?): Promise<ModelResultList<T>>
Type Parameters
- T = BaseRecord
Parameters
- context: string
- Optional query: Query
- Optional multiContextIds: string[]
- Optional countOnly: boolean
- Optional reserveIncludeUnavailable: boolean
Returns Promise<ModelResultList<T>>
- Defined in services/Model.ts:21

performAction

performAction<T>(context, recordIds, actionGroup?, action?, query?, refresh?, wfParametersMap?): Promise<UpdateRecordResponse<T>>
Type Parameters
- T = BaseRecord
Parameters
- context: string
- recordIds: string | string[]
- Optional actionGroup: null | string
- Optional action: null | string
- Optional query: null | Query
- Optional refresh: null | boolean
- Optional wfParametersMap: null | object
Returns Promise<UpdateRecordResponse<T>>
- Defined in services/Model.ts:142

removeRecord

removeRecord<T>(context, recordIds, actionGroup?, action?, query?, refresh?, wfParametersMap?): Promise<UpdateRecordResponse<T>>
Type Parameters
- T = BaseRecord
Parameters
- context: string
- recordIds: string | string[]
- Optional actionGroup: null | string
- Optional action: null | string
- Optional query: null | Query
- Optional refresh: null | boolean
- Optional wfParametersMap: null | object
Returns Promise<UpdateRecordResponse<T>>
- Defined in services/Model.ts:170

updateRecord

updateRecord<T>(context, data, actionGroup?, action?, query?, refresh?, wfParametersMap?): Promise<UpdateRecordResponse<T>>
Type Parameters
- T = BaseRecord
Parameters
- context: string
- data: T | T[]
- Optional actionGroup: null | string
- Optional action: null | string
- Optional query: null | Query
- Optional refresh: null | boolean
- Optional wfParametersMap: null | object
Returns Promise<UpdateRecordResponse<T>>
- Defined in services/Model.ts:198

Class Model

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

appConfig: AppConfig

auth: Auth

Returns Model

Properties

appConfig

auth

Optional webContextId

Methods

Init

Returns Promise<void>

Protected _buildRecordIds

Parameters

recordIds: string | string[]

Returns null | object | object[]

Protected _generateRecordActionRequest

Type Parameters

T = BaseRecord

Parameters

context: string

recordIds: string | string[]

method: string

type: string

Optional query: null | Query

Optional refresh: null | boolean

Optional actionGroup: null | string

Optional action: null | string

Optional wfParametersMap: null | object

Returns [RequestInit, URL]

Protected _generateRecordUpdateRequest

Type Parameters

T = BaseRecord

Parameters

context: string

data: T | T[]

method: string

type: string

Optional query: null | Query

Optional refresh: null | boolean

Optional actionGroup: null | string

Optional action: null | string

Optional wfParametersMap: null | object

Returns [RequestInit, URL]

Protected _generateRequestOptions

Returns RequestInit

Protected _generateRequestUrl

Parameters

context: string

type: string

Optional actionGroup: null | string

Optional action: null | string

Optional query: null | Query

Optional multiContextIds: null | string[]

Optional refresh: null | boolean

Optional countOnly: null | boolean

Optional reserveIncludeUnavailable: null | boolean

Returns URL

Protected _send

Type Parameters

T = unknown

Parameters

requestUrl: URL

requestOptions: RequestInit

Returns Promise<T>

Protected _setWebContextId

Returns Promise<void>

addRecord

Type Parameters

T = BaseRecord

Parameters

context: string

recordIds: string | string[]

`Optional` webContextId

`Protected` _buildRecordIds

`Protected` _generateRecordActionRequest

`Optional` query: null | Query

`Optional` refresh: null | boolean

`Optional` actionGroup: null | string

`Optional` action: null | string

`Optional` wfParametersMap: null | object

`Protected` _generateRecordUpdateRequest

`Optional` query: null | Query

`Optional` refresh: null | boolean

`Optional` actionGroup: null | string

`Optional` action: null | string

`Optional` wfParametersMap: null | object

`Protected` _generateRequestOptions

`Protected` _generateRequestUrl

`Optional` actionGroup: null | string

`Optional` action: null | string

`Optional` query: null | Query

`Optional` multiContextIds: null | string[]

`Optional` refresh: null | boolean

`Optional` countOnly: null | boolean

`Optional` reserveIncludeUnavailable: null | boolean

`Protected` _send

`Protected` _setWebContextId

`Optional` actionGroup: null | string

`Optional` action: null | string

`Optional` query: null | Query

`Optional` refresh: null | boolean

`Optional` wfParametersMap: null | object

`Optional` query: null | Query

`Optional` refresh: null | boolean

`Optional` wfParametersMap: null | object

`Optional` actionGroup: null | string

`Optional` action: null | string

`Optional` query: null | Query

`Optional` refresh: null | boolean

`Optional` wfParametersMap: null | object

`Optional` query: Query

`Optional` multiContextIds: string[]

`Optional` countOnly: boolean

`Optional` reserveIncludeUnavailable: boolean

`Optional` actionGroup: null | string

`Optional` action: null | string

`Optional` query: null | Query

`Optional` refresh: null | boolean

`Optional` wfParametersMap: null | object

`Optional` actionGroup: null | string

`Optional` action: null | string

`Optional` query: null | Query

`Optional` refresh: null | boolean

`Optional` wfParametersMap: null | object