Class EpSdkApplicationVersionsServiceClass

Hierarchy

EpSdkVersionServiceClass
- EpSdkApplicationVersionsServiceClass

Index

Constructors

Methods

createApplicationVersion deepCopyLastestVersionById_IfNotExists getEpObjectVersionFromList getLatestEpObjectVersionFromList getLatestVersionForApplicationId getLatestVersionForApplicationName getLatestVersionString getObjectAndVersionForApplicationId getVersionByVersion getVersionsForApplicationId getVersionsForApplicationName listLatestVersions setCustomAttributes sortEpObjectVersionListByVersion updateApplicationVersion

Constructors

constructor

new EpSdkApplicationVersionsServiceClass(): EpSdkApplicationVersionsServiceClass
Returns EpSdkApplicationVersionsServiceClass

Inherited from EpSdkVersionServiceClass.constructor

Methods

createApplicationVersion

createApplicationVersion(__namedParameters: {
    applicationDomainId: string;
    applicationId: string;
    applicationVersion: ApplicationVersion;
    targetLifecycleStateId: string;
    xContextId?: string;
}): Promise<ApplicationVersion>
Parameters
- __namedParameters: {
      applicationDomainId: string;
      applicationId: string;
      applicationVersion: ApplicationVersion;
      targetLifecycleStateId: string;
      xContextId?: string;
  }
  - applicationDomainId: string
  - applicationId: string
  - applicationVersion: ApplicationVersion
  - targetLifecycleStateId: string
  - Optional xContextId?: string
Returns Promise<ApplicationVersion>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationVersionsService.ts:318

deepCopyLastestVersionById_IfNotExists

deepCopyLastestVersionById_IfNotExists(__namedParameters: {
    applicationName: string;
    fromApplicationDomainId: string;
    fromAssetsApplicationDomainId?: string;
    toApplicationDomainId: string;
    toAssetsApplicationDomainId?: string;
    xContextId?: string;
}): Promise<ApplicationVersion>
Parameters
- __namedParameters: {
      applicationName: string;
      fromApplicationDomainId: string;
      fromAssetsApplicationDomainId?: string;
      toApplicationDomainId: string;
      toAssetsApplicationDomainId?: string;
      xContextId?: string;
  }
  - applicationName: string
  - fromApplicationDomainId: string
  - Optional fromAssetsApplicationDomainId?: string
  - toApplicationDomainId: string
  - Optional toAssetsApplicationDomainId?: string
  - Optional xContextId?: string
Returns Promise<ApplicationVersion>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationVersionsService.ts:433

`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

getLatestVersionForApplicationId

getLatestVersionForApplicationId(__namedParameters: {
    applicationDomainId?: string;
    applicationId: string;
    stateId?: string;
    xContextId?: string;
}): Promise<ApplicationVersion>
Parameters
- __namedParameters: {
      applicationDomainId?: string;
      applicationId: string;
      stateId?: string;
      xContextId?: string;
  }
  - Optional applicationDomainId?: string
  - applicationId: string
  - Optional stateId?: string
  - Optional xContextId?: string
Returns Promise<ApplicationVersion>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationVersionsService.ts:288

getLatestVersionForApplicationName

getLatestVersionForApplicationName(__namedParameters: {
    applicationDomainId: string;
    applicationName: string;
    xContextId?: string;
}): Promise<ApplicationVersion>
Parameters
- __namedParameters: {
      applicationDomainId: string;
      applicationName: string;
      xContextId?: string;
  }
  - applicationDomainId: string
  - applicationName: string
  - Optional xContextId?: string
Returns Promise<ApplicationVersion>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationVersionsService.ts:304

getLatestVersionString

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

getObjectAndVersionForApplicationId

getObjectAndVersionForApplicationId(__namedParameters: {
    applicationId: string;
    stateId?: string;
    versionString?: string;
    xContextId?: string;
}): Promise<EpSdkApplicationAndVersionResponse>
Parameters
- __namedParameters: {
      applicationId: string;
      stateId?: string;
      versionString?: string;
      xContextId?: string;
  }
  - applicationId: string
  - Optional stateId?: string
  - Optional versionString?: string
  - Optional xContextId?: string
Returns Promise<EpSdkApplicationAndVersionResponse>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationVersionsService.ts:121

getVersionByVersion

getVersionByVersion(__namedParameters: {
    applicationId: string;
    applicationVersionString: string;
    xContextId?: string;
}): Promise<ApplicationVersion>
Parameters
- __namedParameters: {
      applicationId: string;
      applicationVersionString: string;
      xContextId?: string;
  }
  - applicationId: string
  - applicationVersionString: string
  - Optional xContextId?: string
Returns Promise<ApplicationVersion>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationVersionsService.ts:177

getVersionsForApplicationId

getVersionsForApplicationId(__namedParameters: {
    applicationId: string;
    pageSize?: number;
    stateId?: string;
    xContextId?: string;
}): Promise<ApplicationVersion[]>
Parameters
- __namedParameters: {
      applicationId: string;
      pageSize?: number;
      stateId?: string;
      xContextId?: string;
  }
  - applicationId: string
  - Optional pageSize?: number
  - Optional stateId?: string
  - Optional xContextId?: string
Returns Promise<ApplicationVersion[]>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationVersionsService.ts:191

getVersionsForApplicationName

getVersionsForApplicationName(__namedParameters: {
    applicationDomainId: string;
    applicationName: string;
    xContextId?: string;
}): Promise<ApplicationVersion[]>
Parameters
- __namedParameters: {
      applicationDomainId: string;
      applicationName: string;
      xContextId?: string;
  }
  - applicationDomainId: string
  - applicationName: string
  - Optional xContextId?: string
Returns Promise<ApplicationVersion[]>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationVersionsService.ts:246

listLatestVersions

listLatestVersions(__namedParameters: {
    applicationDomainIds?: string[];
    pageNumber?: number;
    pageSize?: number;
    sortFieldName?: string;
    stateId?: string;
    xContextId?: string;
}): Promise<EpSdkApplicationAndVersionListResponse>
Parameters
- __namedParameters: {
      applicationDomainIds?: string[];
      pageNumber?: number;
      pageSize?: number;
      sortFieldName?: string;
      stateId?: string;
      xContextId?: string;
  }
  - Optional applicationDomainIds?: string[]
  - Optional pageNumber?: number
  - Optional pageSize?: number
  - Optional sortFieldName?: string
  - Optional stateId?: string
  - Optional xContextId?: string
Returns Promise<EpSdkApplicationAndVersionListResponse>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationVersionsService.ts:377

setCustomAttributes

setCustomAttributes(__namedParameters: {
    applicationVersionId: string;
    epSdkCustomAttributes: TEpSdkCustomAttribute[];
    xContextId?: string;
}): Promise<ApplicationVersion>
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: {
      applicationVersionId: string;
      epSdkCustomAttributes: TEpSdkCustomAttribute[];
      xContextId?: string;
  }
  - applicationVersionId: string
  - epSdkCustomAttributes: TEpSdkCustomAttribute[]
  - Optional xContextId?: string
Returns Promise<ApplicationVersion>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationVersionsService.ts:93

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

updateApplicationVersion(__namedParameters: {
update: ApplicationVersion;
xContextId?: string;
}): Promise<ApplicationVersion>
Parameters
- __namedParameters: {
  update: ApplicationVersion;
  xContextId?: string;
  }
  - update: ApplicationVersion
  - Optional xContextId?: string
Returns Promise<ApplicationVersion>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationVersionsService.ts:71

Class EpSdkApplicationVersionsServiceClass

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns EpSdkApplicationVersionsServiceClass

Methods

createApplicationVersion

Parameters

__namedParameters: { applicationDomainId: string; applicationId: string; applicationVersion: ApplicationVersion; targetLifecycleStateId: string; xContextId?: string; }

applicationDomainId: string

applicationId: string

applicationVersion: ApplicationVersion

targetLifecycleStateId: string

Optional xContextId?: string

Returns Promise<ApplicationVersion>

deepCopyLastestVersionById_IfNotExists

Parameters

__namedParameters: { applicationName: string; fromApplicationDomainId: string; fromAssetsApplicationDomainId?: string; toApplicationDomainId: string; toAssetsApplicationDomainId?: string; xContextId?: string; }

applicationName: string

fromApplicationDomainId: string

Optional fromAssetsApplicationDomainId?: string

toApplicationDomainId: string

Optional toAssetsApplicationDomainId?: string

Optional xContextId?: string

Returns Promise<ApplicationVersion>

Protected getEpObjectVersionFromList

Parameters

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

epObjectVersionList: any[]

versionString: string

Returns any

getLatestEpObjectVersionFromList

Parameters

__namedParameters: { epObjectVersionList: any[]; }

epObjectVersionList: any[]

Returns any

getLatestVersionForApplicationId

Parameters

__namedParameters: { applicationDomainId?: string; applicationId: string; stateId?: string; xContextId?: string; }

Optional applicationDomainId?: string

applicationId: string

Optional stateId?: string

Optional xContextId?: string

Returns Promise<ApplicationVersion>

getLatestVersionForApplicationName

Parameters

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

applicationDomainId: string

applicationName: string

Optional xContextId?: string

Returns Promise<ApplicationVersion>

getLatestVersionString

Parameters

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

applicationId: string

Optional xContextId?: string

Returns Promise<string>

getObjectAndVersionForApplicationId

Parameters

__namedParameters: { applicationId: string; stateId?: string; versionString?: string; xContextId?: string; }

applicationId: string

Optional stateId?: string

Optional versionString?: string

Optional xContextId?: string

Returns Promise<EpSdkApplicationAndVersionResponse>

getVersionByVersion

Parameters

__namedParameters: { applicationId: string; applicationVersionString: string; xContextId?: string; }

applicationId: string

applicationVersionString: string

Optional xContextId?: string

Returns Promise<ApplicationVersion>

getVersionsForApplicationId

Parameters

__namedParameters: { applicationId: string; pageSize?: number; stateId?: string; xContextId?: string; }

applicationId: string

Optional pageSize?: number

__namedParameters: {
applicationDomainId: string;
applicationId: string;
applicationVersion: ApplicationVersion;
targetLifecycleStateId: string;
xContextId?: string;
}

`Optional` xContextId?: string

__namedParameters: {
applicationName: string;
fromApplicationDomainId: string;
fromAssetsApplicationDomainId?: string;
toApplicationDomainId: string;
toAssetsApplicationDomainId?: string;
xContextId?: string;
}

`Optional` fromAssetsApplicationDomainId?: string

`Optional` toAssetsApplicationDomainId?: string

`Optional` xContextId?: string

`Protected` getEpObjectVersionFromList

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

__namedParameters: {
epObjectVersionList: any[];
}

__namedParameters: {
applicationDomainId?: string;
applicationId: string;
stateId?: string;
xContextId?: string;
}

`Optional` applicationDomainId?: string

`Optional` stateId?: string

`Optional` xContextId?: string

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

`Optional` xContextId?: string

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

`Optional` xContextId?: string

__namedParameters: {
applicationId: string;
stateId?: string;
versionString?: string;
xContextId?: string;
}

`Optional` stateId?: string

`Optional` versionString?: string

`Optional` xContextId?: string

__namedParameters: {
applicationId: string;
applicationVersionString: string;
xContextId?: string;
}

`Optional` xContextId?: string

__namedParameters: {
applicationId: string;
pageSize?: number;
stateId?: string;
xContextId?: string;
}

`Optional` pageSize?: number

`Optional` stateId?: string

`Optional` xContextId?: string

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

`Optional` xContextId?: string

__namedParameters: {
applicationDomainIds?: string[];
pageNumber?: number;
pageSize?: number;
sortFieldName?: string;
stateId?: string;
xContextId?: string;
}

`Optional` applicationDomainIds?: string[]

`Optional` pageNumber?: number

`Optional` pageSize?: number

`Optional` sortFieldName?: string

`Optional` stateId?: string

`Optional` xContextId?: string

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

`Optional` xContextId?: string

__namedParameters: {
epObjectVersionList: any[];
}

`Private` updateApplicationVersion

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

`Optional` xContextId?: string