Class EpSdkEpEventTask

Hierarchy

EpSdkTask
- EpSdkEpEventTask

Constructors

constructor

new EpSdkEpEventTask(taskConfig: IEpSdkEpEventTask_Config): EpSdkEpEventTask
Parameters
- taskConfig: IEpSdkEpEventTask_Config
Returns EpSdkEpEventTask
Overrides EpSdkTask.constructor
- Defined in packages/ep-sdk/src/tasks/EpSdkEpEventTask.ts:104

Properties

`Private` `Readonly` Default_TEpSdkEpEventTask_Settings

Default_TEpSdkEpEventTask_Settings: Partial<Pick<EpSdkEvent, "brokerType" | "shared">> = ...

`Private` `Readonly` Empty_IEpSdkEpEventTask_GetFuncReturn

Empty_IEpSdkEpEventTask_GetFuncReturn: IEpSdkEpEventTask_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<IEpSdkEpEventTask_CreateFuncReturn>
Returns Promise<IEpSdkEpEventTask_CreateFuncReturn>
Overrides EpSdkTask.createFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkEpEventTask.ts:197

`Private` createObjectSettings

createObjectSettings(): Partial<EpSdkEvent>
Returns Partial<EpSdkEvent>
- Defined in packages/ep-sdk/src/tasks/EpSdkEpEventTask.ts:89

`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(epSdkEpEventTask_GetFuncReturn: IEpSdkEpEventTask_GetFuncReturn): Promise<IEpSdkTask_IsUpdateRequiredFuncReturn>
Parameters
- epSdkEpEventTask_GetFuncReturn: IEpSdkEpEventTask_GetFuncReturn
Returns Promise<IEpSdkTask_IsUpdateRequiredFuncReturn>
Overrides EpSdkTask.isUpdateRequiredFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkEpEventTask.ts:166

`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(epSdkEpEventTask_GetFuncReturn: IEpSdkEpEventTask_GetFuncReturn): Promise<IEpSdkEpEventTask_UpdateFuncReturn>
Parameters
- epSdkEpEventTask_GetFuncReturn: IEpSdkEpEventTask_GetFuncReturn
Returns Promise<IEpSdkEpEventTask_UpdateFuncReturn>
Overrides EpSdkTask.updateFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkEpEventTask.ts:252

`Private` updateObjectSettings

updateObjectSettings(): Partial<EpSdkEventUpdate>
Returns Partial<EpSdkEventUpdate>
- Defined in packages/ep-sdk/src/tasks/EpSdkEpEventTask.ts:95

`Protected` validateTaskConfig

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

Class EpSdkEpEventTask

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

taskConfig: IEpSdkEpEventTask_Config

Returns EpSdkEpEventTask

Properties

Private Readonly Default_TEpSdkEpEventTask_Settings

Private Readonly Empty_IEpSdkEpEventTask_GetFuncReturn

Protected epSdkTask_Config

Protected epSdkTask_TransactionLog

Protected Optional xContextId

Methods

Protected createFunc

Returns Promise<IEpSdkEpEventTask_CreateFuncReturn>

Private createObjectSettings

Returns Partial<EpSdkEvent>

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

epSdkEpEventTask_GetFuncReturn: IEpSdkEpEventTask_GetFuncReturn

Returns Promise<IEpSdkEpEventTask_DeleteFuncReturn>

execute

Parameters

Optional xContextId: string

Returns Promise<IEpSdkEpEventTask_ExecuteReturn>

Protected getCreateFuncAction

Returns EEpSdkTask_Action

Protected getDefaultEpObjectKeys

Returns IEpSdkTask_EpObjectKeys

Protected getDeleteFuncAction

Returns EEpSdkTask_Action

Protected getEpObjectKeys

Parameters

epObject: EpSdkEvent

Returns IEpSdkTask_EpObjectKeys

Protected getFunc

Parameters

epSdkEpEventTask_Keys: IEpSdkEpEventTask_Keys

Returns Promise<IEpSdkEpEventTask_GetFuncReturn>

Private getTaskConfig

Returns IEpSdkEpEventTask_Config

Protected getTaskKeys

Returns IEpSdkEpEventTask_Keys

Protected getUpdateFuncAction

Parameters

wouldFail: boolean = false

Returns EEpSdkTask_Action

Protected initializeTask

Returns Promise<void>

Protected isCheckmode

Returns boolean

Protected isUpdateRequiredFunc

Parameters

epSdkEpEventTask_GetFuncReturn: IEpSdkEpEventTask_GetFuncReturn

Returns Promise<IEpSdkTask_IsUpdateRequiredFuncReturn>

Protected prepareCompareObject4Output

Parameters

obj: any

`Private` `Readonly` Default_TEpSdkEpEventTask_Settings

`Private` `Readonly` Empty_IEpSdkEpEventTask_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

`Private` updateObjectSettings

`Protected` validateTaskConfig