Class EpSdkEventApiTask

Hierarchy

EpSdkTask
- EpSdkEventApiTask

Constructors

constructor

new EpSdkEventApiTask(taskConfig: IEpSdkEventApiTask_Config): EpSdkEventApiTask
Parameters
- taskConfig: IEpSdkEventApiTask_Config
Returns EpSdkEventApiTask
Overrides EpSdkTask.constructor
- Defined in packages/ep-sdk/src/tasks/EpSdkEventApiTask.ts:92

Properties

`Private` `Readonly` Default_TEpSdkEventApiTask_Settings

Default_TEpSdkEventApiTask_Settings: Partial<Pick<EventApi, "brokerType" | "shared">> = ...

`Private` `Readonly` Empty_IEpSdkEventApiTask_GetFuncReturn

Empty_IEpSdkEventApiTask_GetFuncReturn: IEpSdkEventApiTask_GetFuncReturn = ...

`Protected` epSdkTask_Config

epSdkTask_Config: IEpSdkTask_Config

`Protected` epSdkTask_TransactionLog

epSdkTask_TransactionLog: EpSdkTask_TransactionLog

`Protected` `Optional` xContextId

xContextId?: string

Methods

`Protected` createFunc

createFunc(): Promise<IEpSdkEventApiTask_CreateFuncReturn>
Returns Promise<IEpSdkEventApiTask_CreateFuncReturn>
Overrides EpSdkTask.createFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkEventApiTask.ts:224

`Private` createObjectSettings

createObjectSettings(): Partial<EventApi>
Returns Partial<EventApi>
- Defined in packages/ep-sdk/src/tasks/EpSdkEventApiTask.ts:85

`Protected` createReturn4UpdateFunc

createReturn4UpdateFunc(__namedParameters: {
epSdkTask_UpdateFuncReturn: IEpSdkTask_UpdateFuncReturn;
}): IEpSdkTask_ExecuteReturn
Parameters
- __namedParameters: {
  epSdkTask_UpdateFuncReturn: IEpSdkTask_UpdateFuncReturn;
  }
  - epSdkTask_UpdateFuncReturn: IEpSdkTask_UpdateFuncReturn
Returns IEpSdkTask_ExecuteReturn
Inherited from EpSdkTask.createReturn4UpdateFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:224

`Protected` create_IEpSdkTask_IsUpdateRequiredFuncReturn

create_IEpSdkTask_IsUpdateRequiredFuncReturn(__namedParameters: {
existingObject: any;
requestedObject: any;
}): IEpSdkTask_IsUpdateRequiredFuncReturn
Parameters
- __namedParameters: {
  existingObject: any;
  requestedObject: any;
  }
  - existingObject: any
  - requestedObject: any
Returns IEpSdkTask_IsUpdateRequiredFuncReturn
Inherited from EpSdkTask.create_IEpSdkTask_IsUpdateRequiredFuncReturn
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:119

`Protected` deepCompareObjects

deepCompareObjects(__namedParameters: {
existingObject: any;
requestedObject: any;
}): IEpSdkDeepCompareResult
Parameters
- __namedParameters: {
  existingObject: any;
  requestedObject: any;
  }
  - existingObject: any
  - requestedObject: any
Returns IEpSdkDeepCompareResult
Inherited from EpSdkTask.deepCompareObjects
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:106

`Protected` getUpdateFuncAction

getUpdateFuncAction(wouldFail?: boolean): EEpSdkTask_Action
Parameters
- wouldFail: boolean = false
Returns EEpSdkTask_Action
Inherited from EpSdkTask.getUpdateFuncAction
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:198

`Protected` initializeTask

initializeTask(): Promise<void>
Allows for async init of task

Returns Promise<void>
Inherited from EpSdkTask.initializeTask
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:308

`Protected` isCheckmode

isCheckmode(): boolean
Returns boolean
Inherited from EpSdkTask.isCheckmode
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:97

`Protected` isUpdateRequiredFunc

isUpdateRequiredFunc(epSdkEventApiTask_GetFuncReturn: IEpSdkEventApiTask_GetFuncReturn): Promise<IEpSdkTask_IsUpdateRequiredFuncReturn>
Parameters
- epSdkEventApiTask_GetFuncReturn: IEpSdkEventApiTask_GetFuncReturn
Returns Promise<IEpSdkTask_IsUpdateRequiredFuncReturn>
Overrides EpSdkTask.isUpdateRequiredFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkEventApiTask.ts:177

`Protected` prepareCompareObject4Output

prepareCompareObject4Output(obj: any): any
Parameters
- obj: any
Returns any
Inherited from EpSdkTask.prepareCompareObject4Output
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:102

`Protected` transform_EpSdkTask_Config

transform_EpSdkTask_Config(epSdkTask_Config: IEpSdkTask_Config): IEpSdkTask_Config
Parameters
- epSdkTask_Config: IEpSdkTask_Config
Returns IEpSdkTask_Config
Inherited from EpSdkTask.transform_EpSdkTask_Config
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:136

`Protected` truncate

truncate(str: string, maxLength: number): string
Parameters
- str: string
- maxLength: number
Returns string
Inherited from EpSdkTask.truncate
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:140

`Protected` updateFunc

updateFunc(epSdkEventApiTask_GetFuncReturn: IEpSdkEventApiTask_GetFuncReturn): Promise<IEpSdkEventApiTask_UpdateFuncReturn>
Parameters
- epSdkEventApiTask_GetFuncReturn: IEpSdkEventApiTask_GetFuncReturn
Returns Promise<IEpSdkEventApiTask_UpdateFuncReturn>
Overrides EpSdkTask.updateFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkEventApiTask.ts:302

`Protected` validateTaskConfig

validateTaskConfig(): Promise<void>
Returns Promise<void>
Inherited from EpSdkTask.validateTaskConfig
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:312

Class EpSdkEventApiTask

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

taskConfig: IEpSdkEventApiTask_Config

Returns EpSdkEventApiTask

Properties

Private Readonly Default_TEpSdkEventApiTask_Settings

Private Readonly Empty_IEpSdkEventApiTask_GetFuncReturn

Protected epSdkTask_Config

Protected epSdkTask_TransactionLog

Protected Optional xContextId

Methods

Protected createFunc

Returns Promise<IEpSdkEventApiTask_CreateFuncReturn>

Private createObjectSettings

Returns Partial<EventApi>

Protected createReturn4UpdateFunc

Parameters

__namedParameters: { epSdkTask_UpdateFuncReturn: IEpSdkTask_UpdateFuncReturn; }

epSdkTask_UpdateFuncReturn: IEpSdkTask_UpdateFuncReturn

Returns IEpSdkTask_ExecuteReturn

Protected create_IEpSdkTask_IsUpdateRequiredFuncReturn

Parameters

__namedParameters: { existingObject: any; requestedObject: any; }

existingObject: any

requestedObject: any

Returns IEpSdkTask_IsUpdateRequiredFuncReturn

Protected deepCompareObjects

Parameters

__namedParameters: { existingObject: any; requestedObject: any; }

existingObject: any

requestedObject: any

Returns IEpSdkDeepCompareResult

Protected deleteFunc

Parameters

epSdkEventApiTask_GetFuncReturn: IEpSdkEventApiTask_GetFuncReturn

Returns Promise<IEpSdkEventApiTask_DeleteFuncReturn>

execute

Parameters

Optional xContextId: string

Returns Promise<IEpSdkEventApiTask_ExecuteReturn>

Protected getCreateFuncAction

Returns EEpSdkTask_Action

Protected getDefaultEpObjectKeys

Returns IEpSdkTask_EpObjectKeys

Protected getDeleteFuncAction

Returns EEpSdkTask_Action

Protected getEpObjectKeys

Parameters

epObject: EventApi

Returns IEpSdkTask_EpObjectKeys

Protected getFunc

Parameters

epSdkEventApiTask_Keys: IEpSdkEventApiTask_Keys

Returns Promise<IEpSdkEventApiTask_GetFuncReturn>

Private getTaskConfig

Returns IEpSdkEventApiTask_Config

Protected getTaskKeys

Returns IEpSdkEventApiTask_Keys

Protected getUpdateFuncAction

Parameters

wouldFail: boolean = false

Returns EEpSdkTask_Action

Protected initializeTask

Returns Promise<void>

Protected isCheckmode

Returns boolean

Protected isUpdateRequiredFunc

Parameters

epSdkEventApiTask_GetFuncReturn: IEpSdkEventApiTask_GetFuncReturn

Returns Promise<IEpSdkTask_IsUpdateRequiredFuncReturn>

Protected prepareCompareObject4Output

Parameters

obj: any

`Private` `Readonly` Default_TEpSdkEventApiTask_Settings

`Private` `Readonly` Empty_IEpSdkEventApiTask_GetFuncReturn

`Protected` epSdkTask_Config

`Protected` epSdkTask_TransactionLog

`Protected` `Optional` xContextId

`Protected` createFunc

`Private` createObjectSettings

`Protected` createReturn4UpdateFunc

__namedParameters: {
epSdkTask_UpdateFuncReturn: IEpSdkTask_UpdateFuncReturn;
}

`Protected` create_IEpSdkTask_IsUpdateRequiredFuncReturn

__namedParameters: {
existingObject: any;
requestedObject: any;
}

`Protected` deepCompareObjects

__namedParameters: {
existingObject: any;
requestedObject: any;
}

`Protected` deleteFunc

`Optional` xContextId: string

`Protected` getCreateFuncAction

`Protected` getDefaultEpObjectKeys

`Protected` getDeleteFuncAction

`Protected` getEpObjectKeys

`Protected` getFunc

`Private` getTaskConfig

`Protected` getTaskKeys

`Protected` getUpdateFuncAction

`Protected` initializeTask

`Protected` isCheckmode

`Protected` isUpdateRequiredFunc

`Protected` prepareCompareObject4Output

`Protected` transform_EpSdkTask_Config

`Protected` truncate

`Protected` updateFunc

`Protected` validateTaskConfig