Class EpSdkEpEventVersionsServiceClass

Hierarchy

EpSdkVersionServiceClass
- EpSdkEpEventVersionsServiceClass

Index

Constructors

Methods

createEventVersion createTopicStringFromAddress deepCopyAddress deepCopyLastestVersionById_IfNotExists getEpObjectVersionFromList getLatestEpObjectVersionFromList getLatestVersionForEventId getLatestVersionForEventName getLatestVersionString getObjectAndVersionForEventId getVersionByVersion getVersionsForEventId getVersionsForEventName listLatestVersions setCustomAttributes sortEpObjectVersionListByVersion updateEventVersion

Constructors

constructor

new EpSdkEpEventVersionsServiceClass(): EpSdkEpEventVersionsServiceClass
Returns EpSdkEpEventVersionsServiceClass

Inherited from EpSdkVersionServiceClass.constructor

Methods

createEventVersion

createEventVersion(__namedParameters: {
    applicationDomainId: string;
    eventId: string;
    eventVersion: EventVersion;
    targetLifecycleStateId: string;
    xContextId?: string;
}): Promise<EventVersion>
Parameters
- __namedParameters: {
      applicationDomainId: string;
      eventId: string;
      eventVersion: EventVersion;
      targetLifecycleStateId: string;
      xContextId?: string;
  }
  - applicationDomainId: string
  - eventId: string
  - eventVersion: EventVersion
  - targetLifecycleStateId: string
  - Optional xContextId?: string
Returns Promise<EventVersion>
- Defined in packages/ep-sdk/src/services/EpSdkEpEventVersionsService.ts:324

createTopicStringFromAddress

createTopicStringFromAddress(__namedParameters: {
address: Address;
}): string
Parameters
- __namedParameters: {
  address: Address;
  }
  - address: Address
Returns string
- Defined in packages/ep-sdk/src/services/EpSdkEpEventVersionsService.ts:383

deepCopyAddress

deepCopyAddress(__namedParameters: {
    address: Address;
    toApplicationDomainId: string;
    xContextId?: string;
}): Promise<Address>
Parameters
- __namedParameters: {
      address: Address;
      toApplicationDomainId: string;
      xContextId?: string;
  }
  - address: Address
  - toApplicationDomainId: string
  - Optional xContextId?: string
Returns Promise<Address>
- Defined in packages/ep-sdk/src/services/EpSdkEpEventVersionsService.ts:409

deepCopyLastestVersionById_IfNotExists

deepCopyLastestVersionById_IfNotExists(__namedParameters: {
    eventVersionId: string;
    toApplicationDomainId: string;
    xContextId?: string;
}): Promise<EventVersion>
Conditional deep copy of event version from 'fromApplicationDomain' to 'toApplicationDomain'.
- copies all schemas and enums first
If an event version with the id already exists, returns that version. It still copies all schemas / enums.

Returns
existing or created event version
Parameters
- __namedParameters: {
      eventVersionId: string;
      toApplicationDomainId: string;
      xContextId?: string;
  }
  - eventVersionId: string
  - toApplicationDomainId: string
  - Optional xContextId?: string
Returns Promise<EventVersion>
- Defined in packages/ep-sdk/src/services/EpSdkEpEventVersionsService.ts:454

`Protected` getEpObjectVersionFromList

getEpObjectVersionFromList(__namedParameters: {
epObjectVersionList: any[];
versionString: string;
}): any
Parameters
- __namedParameters: {
  epObjectVersionList: any[];
  versionString: string;
  }
  - epObjectVersionList: any[]
  - versionString: string
Returns any
Inherited from EpSdkVersionServiceClass.getEpObjectVersionFromList
- Defined in packages/ep-sdk/src/services/EpSdkVersionService.ts:44

getLatestEpObjectVersionFromList

getLatestEpObjectVersionFromList(__namedParameters: {
epObjectVersionList: any[];
}): any
Parameters
- __namedParameters: {
  epObjectVersionList: any[];
  }
  - epObjectVersionList: any[]
Returns any
Inherited from EpSdkVersionServiceClass.getLatestEpObjectVersionFromList
- Defined in packages/ep-sdk/src/services/EpSdkVersionService.ts:10

getLatestVersionForEventId

getLatestVersionForEventId(__namedParameters: {
    applicationDomainId?: string;
    eventId: string;
    stateIds?: string[];
    xContextId?: string;
}): Promise<EventVersion>
Parameters
- __namedParameters: {
      applicationDomainId?: string;
      eventId: string;
      stateIds?: string[];
      xContextId?: string;
  }
  - Optional applicationDomainId?: string
  - eventId: string
  - Optional stateIds?: string[]
  - Optional xContextId?: string
Returns Promise<EventVersion>
- Defined in packages/ep-sdk/src/services/EpSdkEpEventVersionsService.ts:294

getLatestVersionForEventName

getLatestVersionForEventName(__namedParameters: {
    applicationDomainId: string;
    eventName: string;
    xContextId?: string;
}): Promise<EventVersion>
Parameters
- __namedParameters: {
      applicationDomainId: string;
      eventName: string;
      xContextId?: string;
  }
  - applicationDomainId: string
  - eventName: string
  - Optional xContextId?: string
Returns Promise<EventVersion>
- Defined in packages/ep-sdk/src/services/EpSdkEpEventVersionsService.ts:310

getLatestVersionString

getLatestVersionString(__namedParameters: {
eventId: string;
xContextId?: string;
}): Promise<string>
Parameters
- __namedParameters: {
  eventId: string;
  xContextId?: string;
  }
  - eventId: string
  - Optional xContextId?: string
Returns Promise<string>
- Defined in packages/ep-sdk/src/services/EpSdkEpEventVersionsService.ts:274

getObjectAndVersionForEventId

getObjectAndVersionForEventId(__namedParameters: {
    eventId: string;
    stateIds?: string[];
    versionString?: string;
    xContextId?: string;
}): Promise<EpSdkEpEventAndVersionResponse>
Parameters
- __namedParameters: {
      eventId: string;
      stateIds?: string[];
      versionString?: string;
      xContextId?: string;
  }
  - eventId: string
  - Optional stateIds?: string[]
  - Optional versionString?: string
  - Optional xContextId?: string
Returns Promise<EpSdkEpEventAndVersionResponse>
- Defined in packages/ep-sdk/src/services/EpSdkEpEventVersionsService.ts:126

getVersionByVersion

getVersionByVersion(__namedParameters: {
    eventId: string;
    eventVersionString: string;
    xContextId?: string;
}): Promise<EventVersion>
Parameters
- __namedParameters: {
      eventId: string;
      eventVersionString: string;
      xContextId?: string;
  }
  - eventId: string
  - eventVersionString: string
  - Optional xContextId?: string
Returns Promise<EventVersion>
- Defined in packages/ep-sdk/src/services/EpSdkEpEventVersionsService.ts:182

getVersionsForEventId

getVersionsForEventId(__namedParameters: {
    eventId: string;
    pageSize?: number;
    stateIds?: string[];
    xContextId?: string;
}): Promise<EventVersion[]>
Parameters
- __namedParameters: {
      eventId: string;
      pageSize?: number;
      stateIds?: string[];
      xContextId?: string;
  }
  - eventId: string
  - Optional pageSize?: number
  - Optional stateIds?: string[]
  - Optional xContextId?: string
Returns Promise<EventVersion[]>
- Defined in packages/ep-sdk/src/services/EpSdkEpEventVersionsService.ts:201

getVersionsForEventName

getVersionsForEventName(__namedParameters: {
    applicationDomainId: string;
    eventName: string;
    xContextId?: string;
}): Promise<EventVersion[]>
Parameters
- __namedParameters: {
      applicationDomainId: string;
      eventName: string;
      xContextId?: string;
  }
  - applicationDomainId: string
  - eventName: string
  - Optional xContextId?: string
Returns Promise<EventVersion[]>
- Defined in packages/ep-sdk/src/services/EpSdkEpEventVersionsService.ts:251

listLatestVersions

listLatestVersions(__namedParameters: {
    applicationDomainIds?: string[];
    pageNumber?: number;
    pageSize?: number;
    shared: boolean;
    sortFieldName?: string;
    stateIds?: string[];
    xContextId?: string;
}): Promise<EpSdkEpEventAndVersionListResponse>
Parameters
- __namedParameters: {
      applicationDomainIds?: string[];
      pageNumber?: number;
      pageSize?: number;
      shared: boolean;
      sortFieldName?: string;
      stateIds?: string[];
      xContextId?: string;
  }
  - Optional applicationDomainIds?: string[]
  - Optional pageNumber?: number
  - Optional pageSize?: number
  - shared: boolean
  - Optional sortFieldName?: string
  - Optional stateIds?: string[]
  - Optional xContextId?: string
Returns Promise<EpSdkEpEventAndVersionListResponse>
- Defined in packages/ep-sdk/src/services/EpSdkEpEventVersionsService.ts:555

setCustomAttributes

setCustomAttributes(__namedParameters: {
    epSdkCustomAttributes: TEpSdkCustomAttribute[];
    eventVersionId: string;
    xContextId?: string;
}): Promise<EventVersion>
Sets the custom attributes in the list on the Event Version object. Creates attribute definitions / adds entity type 'eventVersion' if it doesn't exist.
Parameters
- __namedParameters: {
      epSdkCustomAttributes: TEpSdkCustomAttribute[];
      eventVersionId: string;
      xContextId?: string;
  }
  - epSdkCustomAttributes: TEpSdkCustomAttribute[]
  - eventVersionId: string
  - Optional xContextId?: string
Returns Promise<EventVersion>
- Defined in packages/ep-sdk/src/services/EpSdkEpEventVersionsService.ts:98

sortEpObjectVersionListByVersion

sortEpObjectVersionListByVersion(__namedParameters: {
epObjectVersionList: any[];
}): any
Returns sorted list by version in semVer format. Sorts descending, i.e. latest version is the first element in the returned list.
Parameters
- __namedParameters: {
  epObjectVersionList: any[];
  }
  - epObjectVersionList: any[]
Returns any
Inherited from EpSdkVersionServiceClass.sortEpObjectVersionListByVersion
- Defined in packages/ep-sdk/src/services/EpSdkVersionService.ts:24

`Private` updateEventVersion

updateEventVersion(__namedParameters: {
update: EventVersion;
xContextId?: string;
}): Promise<EventVersion>
Parameters
- __namedParameters: {
  update: EventVersion;
  xContextId?: string;
  }
  - update: EventVersion
  - Optional xContextId?: string
Returns Promise<EventVersion>
- Defined in packages/ep-sdk/src/services/EpSdkEpEventVersionsService.ts:76

Class EpSdkEpEventVersionsServiceClass

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns EpSdkEpEventVersionsServiceClass

Methods

createEventVersion

Parameters

__namedParameters: { applicationDomainId: string; eventId: string; eventVersion: EventVersion; targetLifecycleStateId: string; xContextId?: string; }

applicationDomainId: string

eventId: string

eventVersion: EventVersion

targetLifecycleStateId: string

Optional xContextId?: string

Returns Promise<EventVersion>

createTopicStringFromAddress

Parameters

__namedParameters: { address: Address; }

address: Address

Returns string

deepCopyAddress

Parameters

__namedParameters: { address: Address; toApplicationDomainId: string; xContextId?: string; }

address: Address

toApplicationDomainId: string

Optional xContextId?: string

Returns Promise<Address>

deepCopyLastestVersionById_IfNotExists

Returns

Parameters

__namedParameters: { eventVersionId: string; toApplicationDomainId: string; xContextId?: string; }

eventVersionId: string

toApplicationDomainId: string

Optional xContextId?: string

Returns Promise<EventVersion>

Protected getEpObjectVersionFromList

Parameters

__namedParameters: { epObjectVersionList: any[]; versionString: string; }

epObjectVersionList: any[]

versionString: string

Returns any

getLatestEpObjectVersionFromList

Parameters

__namedParameters: { epObjectVersionList: any[]; }

epObjectVersionList: any[]

Returns any

getLatestVersionForEventId

Parameters

__namedParameters: { applicationDomainId?: string; eventId: string; stateIds?: string[]; xContextId?: string; }

Optional applicationDomainId?: string

eventId: string

Optional stateIds?: string[]

Optional xContextId?: string

Returns Promise<EventVersion>

getLatestVersionForEventName

Parameters

__namedParameters: { applicationDomainId: string; eventName: string; xContextId?: string; }

applicationDomainId: string

eventName: string

Optional xContextId?: string

Returns Promise<EventVersion>

getLatestVersionString

Parameters

__namedParameters: { eventId: string; xContextId?: string; }

eventId: string

Optional xContextId?: string

Returns Promise<string>

getObjectAndVersionForEventId

Parameters

__namedParameters: { eventId: string; stateIds?: string[]; versionString?: string; xContextId?: string; }

eventId: string

Optional stateIds?: string[]

Optional versionString?: string

Optional xContextId?: string

Returns Promise<EpSdkEpEventAndVersionResponse>

getVersionByVersion

Parameters

__namedParameters: {
applicationDomainId: string;
eventId: string;
eventVersion: EventVersion;
targetLifecycleStateId: string;
xContextId?: string;
}

`Optional` xContextId?: string

__namedParameters: {
address: Address;
}

__namedParameters: {
address: Address;
toApplicationDomainId: string;
xContextId?: string;
}

`Optional` xContextId?: string

__namedParameters: {
eventVersionId: string;
toApplicationDomainId: string;
xContextId?: string;
}

`Optional` xContextId?: string

`Protected` getEpObjectVersionFromList

__namedParameters: {
epObjectVersionList: any[];
versionString: string;
}

__namedParameters: {
epObjectVersionList: any[];
}

__namedParameters: {
applicationDomainId?: string;
eventId: string;
stateIds?: string[];
xContextId?: string;
}

`Optional` applicationDomainId?: string

`Optional` stateIds?: string[]

`Optional` xContextId?: string

__namedParameters: {
applicationDomainId: string;
eventName: string;
xContextId?: string;
}

`Optional` xContextId?: string

__namedParameters: {
eventId: string;
xContextId?: string;
}

`Optional` xContextId?: string

__namedParameters: {
eventId: string;
stateIds?: string[];
versionString?: string;
xContextId?: string;
}

`Optional` stateIds?: string[]

`Optional` versionString?: string

`Optional` xContextId?: string

__namedParameters: {
eventId: string;
eventVersionString: string;
xContextId?: string;
}

`Optional` xContextId?: string

__namedParameters: {
eventId: string;
pageSize?: number;
stateIds?: string[];
xContextId?: string;
}

`Optional` pageSize?: number

`Optional` stateIds?: string[]

`Optional` xContextId?: string

__namedParameters: {
applicationDomainId: string;
eventName: string;
xContextId?: string;
}

`Optional` xContextId?: string

__namedParameters: {
applicationDomainIds?: string[];
pageNumber?: number;
pageSize?: number;
shared: boolean;
sortFieldName?: string;
stateIds?: string[];
xContextId?: string;
}

`Optional` applicationDomainIds?: string[]

`Optional` pageNumber?: number

`Optional` pageSize?: number

`Optional` sortFieldName?: string

`Optional` stateIds?: string[]

`Optional` xContextId?: string

__namedParameters: {
epSdkCustomAttributes: TEpSdkCustomAttribute[];
eventVersionId: string;
xContextId?: string;
}

`Optional` xContextId?: string

__namedParameters: {
epObjectVersionList: any[];
}

`Private` updateEventVersion

__namedParameters: {
update: EventVersion;
xContextId?: string;
}

`Optional` xContextId?: string