Class Model

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

Hierarchy

  • default
    • Model

Constructors

constructor

Properties

appConfig auth webContextId?

Methods

_buildRecordIds _generateRecordActionRequest _generateRecordUpdateRequest _generateRequestOptions _generateRequestUrl _send _setWebContextId addRecord createRecord deleteRecord getRecord Init performAction removeRecord updateRecord

Constructors

constructor

Properties

appConfig

appConfig: AppConfig

auth

auth: Auth

OptionalwebContextId

webContextId?: string

Methods

Protected_buildRecordIds

  • _buildRecordIds(recordIds: string | string[]): null | object | object[]

    Parameters

    • recordIds: string | string[]

    Returns null | object | object[]

Protected_generateRecordActionRequest

  • _generateRecordActionRequest<T = BaseRecord>(
        context: string,
        recordIds: string | string[],
        method: string,
        type: string,
        query?: null | Query,
        refresh?: null | boolean,
        actionGroup?: null | string,
        action?: null | string,
        wfParametersMap?: null | object,
    ): [RequestInit, URL]

    Type Parameters

    Parameters

    • context: string
    • recordIds: string | string[]
    • method: string
    • type: string
    • Optionalquery: null | Query
    • Optionalrefresh: null | boolean
    • OptionalactionGroup: null | string
    • Optionalaction: null | string
    • OptionalwfParametersMap: null | object

    Returns [RequestInit, URL]

Protected_generateRecordUpdateRequest

  • _generateRecordUpdateRequest<T = BaseRecord>(
        context: string,
        data: T | T[],
        method: string,
        type: string,
        query?: null | Query,
        refresh?: null | boolean,
        actionGroup?: null | string,
        action?: null | string,
        wfParametersMap?: null | object,
    ): [RequestInit, URL]

    Type Parameters

    Parameters

    • context: string
    • data: T | T[]
    • method: string
    • type: string
    • Optionalquery: null | Query
    • Optionalrefresh: null | boolean
    • OptionalactionGroup: null | string
    • Optionalaction: null | string
    • OptionalwfParametersMap: null | object

    Returns [RequestInit, URL]

Protected_generateRequestOptions

Protected_generateRequestUrl

  • _generateRequestUrl(
        context: string,
        type: string,
        actionGroup?: null | string,
        action?: null | string,
        query?: null | Query,
        multiContextIds?: null | string[],
        refresh?: null | boolean,
        countOnly?: null | boolean,
        reserveIncludeUnavailable?: null | boolean,
    ): URL

    Parameters

    • context: string
    • type: string
    • OptionalactionGroup: null | string
    • Optionalaction: null | string
    • Optionalquery: null | Query
    • OptionalmultiContextIds: null | string[]
    • Optionalrefresh: null | boolean
    • OptionalcountOnly: null | boolean
    • OptionalreserveIncludeUnavailable: null | boolean

    Returns URL

Protected_send

  • _send<T = unknown>(requestUrl: URL, requestOptions: RequestInit): Promise<T>

    Type Parameters

    • T = unknown

    Parameters

    • requestUrl: URL
    • requestOptions: RequestInit

    Returns Promise<T>

Protected_setWebContextId

addRecord

  • addRecord<T = BaseRecord>(
        context: string,
        recordIds: string | string[],
        actionGroup?: null | string,
        action?: null | string,
        query?: null | Query,
        refresh?: null | boolean,
        wfParametersMap?: null | object,
    ): Promise<UpdateRecordResponse<T>>

    Type Parameters

    Parameters

    • context: string
    • recordIds: string | string[]
    • OptionalactionGroup: null | string
    • Optionalaction: null | string
    • Optionalquery: null | Query
    • Optionalrefresh: null | boolean
    • OptionalwfParametersMap: null | object

    Returns Promise<UpdateRecordResponse<T>>

createRecord

  • createRecord<T = BaseRecord>(
        context: string,
        data: T | T[],
        actionGroup: string,
        action: string,
        query?: null | Query,
        refresh?: null | boolean,
        wfParametersMap?: null | object,
    ): Promise<CreateRecordResponse<T>>

    Type Parameters

    Parameters

    • context: string
    • data: T | T[]
    • actionGroup: string
    • action: string
    • Optionalquery: null | Query
    • Optionalrefresh: null | boolean
    • OptionalwfParametersMap: null | object

    Returns Promise<CreateRecordResponse<T>>

deleteRecord

  • deleteRecord<T = BaseRecord>(
        context: string,
        recordIds: string | string[],
        actionGroup?: null | string,
        action?: null | string,
        query?: null | Query,
        refresh?: null | boolean,
        wfParametersMap?: null | object,
    ): Promise<UpdateRecordResponse<T>>

    Type Parameters

    Parameters

    • context: string
    • recordIds: string | string[]
    • OptionalactionGroup: null | string
    • Optionalaction: null | string
    • Optionalquery: null | Query
    • Optionalrefresh: null | boolean
    • OptionalwfParametersMap: null | object

    Returns Promise<UpdateRecordResponse<T>>

getRecord

  • getRecord<T = BaseRecord>(
        context: string,
        query?: Query,
        multiContextIds?: string[],
        countOnly?: boolean,
        reserveIncludeUnavailable?: boolean,
    ): Promise<ModelResultList<T>>

    Type Parameters

    Parameters

    • context: string
    • Optionalquery: Query
    • OptionalmultiContextIds: string[]
    • OptionalcountOnly: boolean
    • OptionalreserveIncludeUnavailable: boolean

    Returns Promise<ModelResultList<T>>

Init

performAction

  • performAction<T = BaseRecord>(
        context: string,
        recordIds: string | string[],
        actionGroup?: null | string,
        action?: null | string,
        query?: null | Query,
        refresh?: null | boolean,
        wfParametersMap?: null | object,
    ): Promise<UpdateRecordResponse<T>>

    Type Parameters

    Parameters

    • context: string
    • recordIds: string | string[]
    • OptionalactionGroup: null | string
    • Optionalaction: null | string
    • Optionalquery: null | Query
    • Optionalrefresh: null | boolean
    • OptionalwfParametersMap: null | object

    Returns Promise<UpdateRecordResponse<T>>

removeRecord

  • removeRecord<T = BaseRecord>(
        context: string,
        recordIds: string | string[],
        actionGroup?: null | string,
        action?: null | string,
        query?: null | Query,
        refresh?: null | boolean,
        wfParametersMap?: null | object,
    ): Promise<UpdateRecordResponse<T>>

    Type Parameters

    Parameters

    • context: string
    • recordIds: string | string[]
    • OptionalactionGroup: null | string
    • Optionalaction: null | string
    • Optionalquery: null | Query
    • Optionalrefresh: null | boolean
    • OptionalwfParametersMap: null | object

    Returns Promise<UpdateRecordResponse<T>>

updateRecord

  • updateRecord<T = BaseRecord>(
        context: string,
        data: T | T[],
        actionGroup?: null | string,
        action?: null | string,
        query?: null | Query,
        refresh?: null | boolean,
        wfParametersMap?: null | object,
    ): Promise<UpdateRecordResponse<T>>

    Type Parameters

    Parameters

    • context: string
    • data: T | T[]
    • OptionalactionGroup: null | string
    • Optionalaction: null | string
    • Optionalquery: null | Query
    • Optionalrefresh: null | boolean
    • OptionalwfParametersMap: null | object

    Returns Promise<UpdateRecordResponse<T>>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods