Class EpSdkApplicationDomainTask

Hierarchy

EpSdkTask
- EpSdkApplicationDomainTask

Constructors

constructor

new EpSdkApplicationDomainTask(taskConfig: IEpSdkApplicationDomainTask_Config): EpSdkApplicationDomainTask
Parameters
- taskConfig: IEpSdkApplicationDomainTask_Config
Returns EpSdkApplicationDomainTask
Overrides EpSdkTask.constructor
- Defined in packages/ep-sdk/src/tasks/EpSdkApplicationDomainTask.ts:132

Properties

`Private` `Readonly` Default_TEpSdkApplicationDomainTask_Settings

Default_TEpSdkApplicationDomainTask_Settings: TEpSdkApplicationDomainTask_Settings = ...

`Private` `Readonly` Empty_IEpSdkApplicationDomainTask_GetFuncReturn

Empty_IEpSdkApplicationDomainTask_GetFuncReturn: IEpSdkApplicationDomainTask_GetFuncReturn = ...

`Protected` epSdkTask_Config

epSdkTask_Config: IEpSdkTask_Config

`Protected` epSdkTask_TransactionLog

epSdkTask_TransactionLog: EpSdkTask_TransactionLog

`Protected` `Optional` xContextId

xContextId?: string

Methods

`Private` createEpTopicDomainsFromTopicDomainSettings

createEpTopicDomainsFromTopicDomainSettings(__namedParameters: {
applicationDomainId: string;
}): Promise<TopicDomain[]>
Parameters
- __namedParameters: {
  applicationDomainId: string;
  }
  - applicationDomainId: string
Returns Promise<TopicDomain[]>
- Defined in packages/ep-sdk/src/tasks/EpSdkApplicationDomainTask.ts:203

`Private` createTopicDomains

createTopicDomains(__namedParameters: {
applicationDomainId: string;
}): Promise<TopicDomain[]>
Parameters
- __namedParameters: {
  applicationDomainId: string;
  }
  - applicationDomainId: string
Returns Promise<TopicDomain[]>
- Defined in packages/ep-sdk/src/tasks/EpSdkApplicationDomainTask.ts:300

`Private` createWouldBeTopicDomains

createWouldBeTopicDomains(__namedParameters: {
applicationDomainId: string;
}): Promise<TopicDomain[]>
Parameters
- __namedParameters: {
  applicationDomainId: string;
  }
  - applicationDomainId: string
Returns Promise<TopicDomain[]>
- Defined in packages/ep-sdk/src/tasks/EpSdkApplicationDomainTask.ts:278

`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` deleteFunc

deleteFunc(epSdkApplicationDomainTask_GetFuncReturn: IEpSdkApplicationDomainTask_GetFuncReturn): Promise<IEpSdkApplicationDomainTask_DeleteFuncReturn>
Parameters
- epSdkApplicationDomainTask_GetFuncReturn: IEpSdkApplicationDomainTask_GetFuncReturn
Returns Promise<IEpSdkApplicationDomainTask_DeleteFuncReturn>
Overrides EpSdkTask.deleteFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkApplicationDomainTask.ts:589

`Private` deleteTopicDomains

deleteTopicDomains(__namedParameters: {
applicationDomainId: string;
topicDomains?: TopicDomain[];
}): Promise<TopicDomain[]>
Parameters
- __namedParameters: {
  applicationDomainId: string;
  topicDomains?: TopicDomain[];
  }
  - applicationDomainId: string
  - Optional topicDomains?: TopicDomain[]
Returns Promise<TopicDomain[]>
- Defined in packages/ep-sdk/src/tasks/EpSdkApplicationDomainTask.ts:349

`Private` disassociateFromRuntimeManager

disassociateFromRuntimeManager(__namedParameters: {
applicationDomainId: string;
}): Promise<EpSdkApplicationVersion[]>
Parameters
- __namedParameters: {
  applicationDomainId: string;
  }
  - applicationDomainId: string
Returns Promise<EpSdkApplicationVersion[]>
- Defined in packages/ep-sdk/src/tasks/EpSdkApplicationDomainTask.ts:325

execute

execute(xContextId?: string): Promise<IEpSdkApplicationDomainTask_ExecuteReturn>
Parameters
- Optional xContextId: string
Returns Promise<IEpSdkApplicationDomainTask_ExecuteReturn>
Overrides EpSdkTask.execute
- Defined in packages/ep-sdk/src/tasks/EpSdkApplicationDomainTask.ts:635

`Protected` getCreateFuncAction

getCreateFuncAction(): EEpSdkTask_Action
Returns EEpSdkTask_Action
Inherited from EpSdkTask.getCreateFuncAction
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:186

`Protected` getDefaultEpObjectKeys

getDefaultEpObjectKeys(): IEpSdkTask_EpObjectKeys
Returns IEpSdkTask_EpObjectKeys
Overrides EpSdkTask.getDefaultEpObjectKeys
- Defined in packages/ep-sdk/src/tasks/EpSdkApplicationDomainTask.ts:136

`Protected` getDeleteFuncAction

getDeleteFuncAction(): EEpSdkTask_Action
Returns EEpSdkTask_Action
Inherited from EpSdkTask.getDeleteFuncAction
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:213

`Protected` getEpObjectKeys

getEpObjectKeys(epObject: ApplicationDomain): IEpSdkTask_EpObjectKeys
Parameters
- epObject: ApplicationDomain
Returns IEpSdkTask_EpObjectKeys
Overrides EpSdkTask.getEpObjectKeys
- Defined in packages/ep-sdk/src/tasks/EpSdkApplicationDomainTask.ts:143

`Protected` getFunc

getFunc(epSdkApplicationDomainTask_Keys: IEpSdkApplicationDomainTask_Keys): Promise<IEpSdkApplicationDomainTask_GetFuncReturn>
Parameters
- epSdkApplicationDomainTask_Keys: IEpSdkApplicationDomainTask_Keys
Returns Promise<IEpSdkApplicationDomainTask_GetFuncReturn>
Overrides EpSdkTask.getFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkApplicationDomainTask.ts:161

`Private` getTaskConfig

getTaskConfig(): IEpSdkApplicationDomainTask_Config
Returns IEpSdkApplicationDomainTask_Config
- Defined in packages/ep-sdk/src/tasks/EpSdkApplicationDomainTask.ts:120

`Protected` getTaskKeys

getTaskKeys(): IEpSdkApplicationDomainTask_Keys
Returns IEpSdkApplicationDomainTask_Keys
Overrides EpSdkTask.getTaskKeys
- Defined in packages/ep-sdk/src/tasks/EpSdkApplicationDomainTask.ts:155

`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(epSdkApplicationDomainTask_GetFuncReturn: IEpSdkApplicationDomainTask_GetFuncReturn): Promise<IEpSdkTask_IsUpdateRequiredFuncReturn>
Parameters
- epSdkApplicationDomainTask_GetFuncReturn: IEpSdkApplicationDomainTask_GetFuncReturn
Returns Promise<IEpSdkTask_IsUpdateRequiredFuncReturn>
Overrides EpSdkTask.isUpdateRequiredFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkApplicationDomainTask.ts:225

`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

`Private` sortTopicDomains

sortTopicDomains(__namedParameters: {
topicDomains: TopicDomain[];
}): TopicDomain[]
Parameters
- __namedParameters: {
  topicDomains: TopicDomain[];
  }
  - topicDomains: TopicDomain[]
Returns TopicDomain[]
- Defined in packages/ep-sdk/src/tasks/EpSdkApplicationDomainTask.ts:191

`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(epSdkApplicationDomainTask_GetFuncReturn: IEpSdkApplicationDomainTask_GetFuncReturn): Promise<IEpSdkApplicationDomainTask_UpdateFuncReturn>
Parameters
- epSdkApplicationDomainTask_GetFuncReturn: IEpSdkApplicationDomainTask_GetFuncReturn
Returns Promise<IEpSdkApplicationDomainTask_UpdateFuncReturn>
Overrides EpSdkTask.updateFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkApplicationDomainTask.ts:519

`Protected` validateTaskConfig

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

Class EpSdkApplicationDomainTask

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

taskConfig: IEpSdkApplicationDomainTask_Config

Returns EpSdkApplicationDomainTask

Properties

Private Readonly Default_TEpSdkApplicationDomainTask_Settings

Private Readonly Empty_IEpSdkApplicationDomainTask_GetFuncReturn

Protected epSdkTask_Config

Protected epSdkTask_TransactionLog

Protected Optional xContextId

Methods

Private createEpTopicDomainsFromTopicDomainSettings

Parameters

__namedParameters: { applicationDomainId: string; }

applicationDomainId: string

Returns Promise<TopicDomain[]>

Protected createFunc

Returns Promise<IEpSdkApplicationDomainTask_CreateFuncReturn>

Private createObjectSettings

Returns Partial<ApplicationDomain>

Protected createReturn4UpdateFunc

Parameters

__namedParameters: { epSdkTask_UpdateFuncReturn: IEpSdkApplicationDomainTask_UpdateFuncReturn; }

epSdkTask_UpdateFuncReturn: IEpSdkApplicationDomainTask_UpdateFuncReturn

Returns IEpSdkApplicationDomainTask_ExecuteReturn

Private createTopicDomains

Parameters

__namedParameters: { applicationDomainId: string; }

applicationDomainId: string

Returns Promise<TopicDomain[]>

Private createWouldBeTopicDomains

Parameters

__namedParameters: { applicationDomainId: string; }

applicationDomainId: string

Returns Promise<TopicDomain[]>

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

epSdkApplicationDomainTask_GetFuncReturn: IEpSdkApplicationDomainTask_GetFuncReturn

Returns Promise<IEpSdkApplicationDomainTask_DeleteFuncReturn>

Private deleteTopicDomains

Parameters

__namedParameters: { applicationDomainId: string; topicDomains?: TopicDomain[]; }

applicationDomainId: string

Optional topicDomains?: TopicDomain[]

Returns Promise<TopicDomain[]>

Private disassociateFromRuntimeManager

Parameters

__namedParameters: { applicationDomainId: string; }

applicationDomainId: string

Returns Promise<EpSdkApplicationVersion[]>

execute

Parameters

Optional xContextId: string

Returns Promise<IEpSdkApplicationDomainTask_ExecuteReturn>

Protected getCreateFuncAction

Returns EEpSdkTask_Action

Protected getDefaultEpObjectKeys

Returns IEpSdkTask_EpObjectKeys

Protected getDeleteFuncAction

Returns EEpSdkTask_Action

Protected getEpObjectKeys

`Private` `Readonly` Default_TEpSdkApplicationDomainTask_Settings

`Private` `Readonly` Empty_IEpSdkApplicationDomainTask_GetFuncReturn

`Protected` epSdkTask_Config

`Protected` epSdkTask_TransactionLog

`Protected` `Optional` xContextId

`Private` createEpTopicDomainsFromTopicDomainSettings

__namedParameters: {
applicationDomainId: string;
}

`Protected` createFunc

`Private` createObjectSettings

`Protected` createReturn4UpdateFunc

__namedParameters: {
epSdkTask_UpdateFuncReturn: IEpSdkApplicationDomainTask_UpdateFuncReturn;
}

`Private` createTopicDomains

__namedParameters: {
applicationDomainId: string;
}

`Private` createWouldBeTopicDomains

__namedParameters: {
applicationDomainId: string;
}

`Protected` create_IEpSdkTask_IsUpdateRequiredFuncReturn

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

`Protected` deepCompareObjects

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

`Protected` deleteFunc

`Private` deleteTopicDomains

__namedParameters: {
applicationDomainId: string;
topicDomains?: TopicDomain[];
}

`Optional` topicDomains?: TopicDomain[]

`Private` disassociateFromRuntimeManager

__namedParameters: {
applicationDomainId: string;
}

`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

`Private` sortTopicDomains

__namedParameters: {
topicDomains: TopicDomain[];
}

`Protected` transform_EpSdkTask_Config

`Protected` truncate

`Protected` updateFunc

`Protected` validateTaskConfig