Class EpSdkEnumVersionsServiceClass

Hierarchy

EpSdkVersionServiceClass
- EpSdkEnumVersionsServiceClass

Index

Constructors

Methods

copyLastestVersionById_IfNotExists createEnumVersion getEpObjectVersionFromList getLatestEpObjectVersionFromList getLatestVersionForEnumId getLatestVersionForEnumName getLatestVersionString getVersionByVersion getVersionsForEnumId getVersionsForEnumName setCustomAttributes sortEpObjectVersionListByVersion updateEnumVersion

Constructors

constructor

new EpSdkEnumVersionsServiceClass(): EpSdkEnumVersionsServiceClass
Returns EpSdkEnumVersionsServiceClass

Inherited from EpSdkVersionServiceClass.constructor

Methods

copyLastestVersionById_IfNotExists

copyLastestVersionById_IfNotExists(__namedParameters: {
    enumVersionId: string;
    toApplicationDomainId: string;
    xContextId?: string;
}): Promise<TopicAddressEnumVersion>
Parameters
- __namedParameters: {
      enumVersionId: string;
      toApplicationDomainId: string;
      xContextId?: string;
  }
  - enumVersionId: string
  - toApplicationDomainId: string
  - Optional xContextId?: string
Returns Promise<TopicAddressEnumVersion>
- Defined in packages/ep-sdk/src/services/EpSdkEnumVersionsService.ts:272

createEnumVersion

createEnumVersion(__namedParameters: {
    enumId: string;
    targetLifecycleStateId: string;
    topicAddressEnumVersion: TopicAddressEnumVersion;
    xContextId?: string;
}): Promise<TopicAddressEnumVersion>
Parameters
- __namedParameters: {
      enumId: string;
      targetLifecycleStateId: string;
      topicAddressEnumVersion: TopicAddressEnumVersion;
      xContextId?: string;
  }
  - enumId: string
  - targetLifecycleStateId: string
  - topicAddressEnumVersion: TopicAddressEnumVersion
  - Optional xContextId?: string
Returns Promise<TopicAddressEnumVersion>
- Defined in packages/ep-sdk/src/services/EpSdkEnumVersionsService.ts:216

`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

getLatestVersionForEnumId

getLatestVersionForEnumId(__namedParameters: {
    applicationDomainId: string;
    enumId: string;
    xContextId?: string;
}): Promise<TopicAddressEnumVersion>
Parameters
- __namedParameters: {
      applicationDomainId: string;
      enumId: string;
      xContextId?: string;
  }
  - applicationDomainId: string
  - enumId: string
  - Optional xContextId?: string
Returns Promise<TopicAddressEnumVersion>
- Defined in packages/ep-sdk/src/services/EpSdkEnumVersionsService.ts:188

getLatestVersionForEnumName

getLatestVersionForEnumName(__namedParameters: {
    applicationDomainId: string;
    enumName: string;
    xContextId?: string;
}): Promise<TopicAddressEnumVersion>
Parameters
- __namedParameters: {
      applicationDomainId: string;
      enumName: string;
      xContextId?: string;
  }
  - applicationDomainId: string
  - enumName: string
  - Optional xContextId?: string
Returns Promise<TopicAddressEnumVersion>
- Defined in packages/ep-sdk/src/services/EpSdkEnumVersionsService.ts:202

getLatestVersionString

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

getVersionByVersion

getVersionByVersion(__namedParameters: {
    enumId: string;
    enumVersionString: string;
    xContextId?: string;
}): Promise<TopicAddressEnumVersion>
Parameters
- __namedParameters: {
      enumId: string;
      enumVersionString: string;
      xContextId?: string;
  }
  - enumId: string
  - enumVersionString: string
  - Optional xContextId?: string
Returns Promise<TopicAddressEnumVersion>
- Defined in packages/ep-sdk/src/services/EpSdkEnumVersionsService.ts:91

getVersionsForEnumId

getVersionsForEnumId(__namedParameters: {
    enumId: string;
    pageSize?: number;
    xContextId?: string;
}): Promise<TopicAddressEnumVersion[]>
Parameters
- __namedParameters: {
      enumId: string;
      pageSize?: number;
      xContextId?: string;
  }
  - enumId: string
  - Optional pageSize?: number
  - Optional xContextId?: string
Returns Promise<TopicAddressEnumVersion[]>
- Defined in packages/ep-sdk/src/services/EpSdkEnumVersionsService.ts:105

getVersionsForEnumName

getVersionsForEnumName(__namedParameters: {
    applicationDomainId: string;
    enumName: string;
    xContextId?: string;
}): Promise<TopicAddressEnumVersion[]>
Parameters
- __namedParameters: {
      applicationDomainId: string;
      enumName: string;
      xContextId?: string;
  }
  - applicationDomainId: string
  - enumName: string
  - Optional xContextId?: string
Returns Promise<TopicAddressEnumVersion[]>
- Defined in packages/ep-sdk/src/services/EpSdkEnumVersionsService.ts:146

setCustomAttributes

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

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

updateEnumVersion(__namedParameters: {
update: TopicAddressEnumVersion;
xContextId?: string;
}): Promise<TopicAddressEnumVersion>
Parameters
- __namedParameters: {
  update: TopicAddressEnumVersion;
  xContextId?: string;
  }
  - update: TopicAddressEnumVersion
  - Optional xContextId?: string
Returns Promise<TopicAddressEnumVersion>
- Defined in packages/ep-sdk/src/services/EpSdkEnumVersionsService.ts:41

Class EpSdkEnumVersionsServiceClass

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns EpSdkEnumVersionsServiceClass

Methods

copyLastestVersionById_IfNotExists

Parameters

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

enumVersionId: string

toApplicationDomainId: string

Optional xContextId?: string

Returns Promise<TopicAddressEnumVersion>

createEnumVersion

Parameters

__namedParameters: { enumId: string; targetLifecycleStateId: string; topicAddressEnumVersion: TopicAddressEnumVersion; xContextId?: string; }

enumId: string

targetLifecycleStateId: string

topicAddressEnumVersion: TopicAddressEnumVersion

Optional xContextId?: string

Returns Promise<TopicAddressEnumVersion>

Protected getEpObjectVersionFromList

Parameters

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

epObjectVersionList: any[]

versionString: string

Returns any

getLatestEpObjectVersionFromList

Parameters

__namedParameters: { epObjectVersionList: any[]; }

epObjectVersionList: any[]

Returns any

getLatestVersionForEnumId

Parameters

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

applicationDomainId: string

enumId: string

Optional xContextId?: string

Returns Promise<TopicAddressEnumVersion>

getLatestVersionForEnumName

Parameters

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

applicationDomainId: string

enumName: string

Optional xContextId?: string

Returns Promise<TopicAddressEnumVersion>

getLatestVersionString

Parameters

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

enumId: string

Optional xContextId?: string

Returns Promise<string>

getVersionByVersion

Parameters

__namedParameters: { enumId: string; enumVersionString: string; xContextId?: string; }

enumId: string

enumVersionString: string

Optional xContextId?: string

Returns Promise<TopicAddressEnumVersion>

getVersionsForEnumId

Parameters

__namedParameters: { enumId: string; pageSize?: number; xContextId?: string; }

enumId: string

Optional pageSize?: number

Optional xContextId?: string

Returns Promise<TopicAddressEnumVersion[]>

getVersionsForEnumName

Parameters

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

applicationDomainId: string

enumName: string

Optional xContextId?: string

Returns Promise<TopicAddressEnumVersion[]>

setCustomAttributes

Parameters

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

enumVersionId: string

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

`Optional` xContextId?: string

__namedParameters: {
enumId: string;
targetLifecycleStateId: string;
topicAddressEnumVersion: TopicAddressEnumVersion;
xContextId?: string;
}

`Optional` xContextId?: string

`Protected` getEpObjectVersionFromList

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

__namedParameters: {
epObjectVersionList: any[];
}

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

`Optional` xContextId?: string

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

`Optional` xContextId?: string

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

`Optional` xContextId?: string

__namedParameters: {
enumId: string;
enumVersionString: string;
xContextId?: string;
}

`Optional` xContextId?: string

__namedParameters: {
enumId: string;
pageSize?: number;
xContextId?: string;
}

`Optional` pageSize?: number

`Optional` xContextId?: string

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

`Optional` xContextId?: string

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

`Optional` xContextId?: string

__namedParameters: {
epObjectVersionList: any[];
}

`Private` updateEnumVersion

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

`Optional` xContextId?: string