Class EpSdkApplicationsServiceClass

Hierarchy

EpSdkServiceClass
- EpSdkApplicationsServiceClass

Index

Constructors

Methods

deleteById deleteByName getById getByName listAll listAllForApplicationDomainId removeAssociatedEntityTypeFromCustomAttributeDefinitions setCustomAttributes unsetCustomAttributes updateApplication

Constructors

constructor

new EpSdkApplicationsServiceClass(): EpSdkApplicationsServiceClass
Returns EpSdkApplicationsServiceClass

Inherited from EpSdkServiceClass.constructor

Methods

deleteById

deleteById(__namedParameters: {
    applicationDomainId?: string;
    applicationId: string;
    xContextId?: string;
}): Promise<Application>
Parameters
- __namedParameters: {
      applicationDomainId?: string;
      applicationId: string;
      xContextId?: string;
  }
  - Optional applicationDomainId?: string
  - applicationId: string
  - Optional xContextId?: string
Returns Promise<Application>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationsService.ts:250

deleteByName

deleteByName(__namedParameters: {
    applicationDomainId: string;
    applicationName: string;
    xContextId?: string;
}): Promise<Application>
Parameters
- __namedParameters: {
      applicationDomainId: string;
      applicationName: string;
      xContextId?: string;
  }
  - applicationDomainId: string
  - applicationName: string
  - Optional xContextId?: string
Returns Promise<Application>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationsService.ts:268

getById

getById(__namedParameters: {
    applicationDomainId?: string;
    applicationId: string;
    xContextId?: string;
}): Promise<Application>
Parameters
- __namedParameters: {
      applicationDomainId?: string;
      applicationId: string;
      xContextId?: string;
  }
  - Optional applicationDomainId?: string
  - applicationId: string
  - Optional xContextId?: string
Returns Promise<Application>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationsService.ts:223

getByName

getByName(__namedParameters: {
    applicationDomainId: string;
    applicationName: string;
    xContextId?: string;
}): Promise<Application>
Parameters
- __namedParameters: {
      applicationDomainId: string;
      applicationName: string;
      xContextId?: string;
  }
  - applicationDomainId: string
  - applicationName: string
  - Optional xContextId?: string
Returns Promise<Application>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationsService.ts:197

listAll

listAll(param0: {
    applicationDomainIds?: string[];
    sortFieldName?: string;
    xContextId?: string;
}): Promise<ApplicationsResponse>
Retrieves a list of all Applications without paging.
Parameters
- param0: {
      applicationDomainIds?: string[];
      sortFieldName?: string;
      xContextId?: string;
  }
  - Optional applicationDomainIds?: string[]
  - Optional sortFieldName?: string
  - Optional xContextId?: string
Returns Promise<ApplicationsResponse>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationsService.ts:166

`Private` listAllForApplicationDomainId

listAllForApplicationDomainId(__namedParameters: {
applicationDomainId?: string;
xContextId?: string;
}): Promise<ApplicationsResponse>
Parameters
- __namedParameters: {
  applicationDomainId?: string;
  xContextId?: string;
  }
  - Optional applicationDomainId?: string
  - Optional xContextId?: string
Returns Promise<ApplicationsResponse>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationsService.ts:31

removeAssociatedEntityTypeFromCustomAttributeDefinitions

removeAssociatedEntityTypeFromCustomAttributeDefinitions(__namedParameters: {
customAttributeNames: string[];
xContextId?: string;
}): Promise<void>
Parameters
- __namedParameters: {
  customAttributeNames: string[];
  xContextId?: string;
  }
  - customAttributeNames: string[]
  - Optional xContextId?: string
Returns Promise<void>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationsService.ts:149

setCustomAttributes

setCustomAttributes(param0: {
    applicationId: string;
    epSdkCustomAttributes: TEpSdkCustomAttribute[];
    xContextId?: string;
}): Promise<Application>
Sets the custom attributes in the list on the application. Creates attribute definitions / adds entity type 'application' if it doesn't exist.

Returns
Parameters
- param0: {
      applicationId: string;
      epSdkCustomAttributes: TEpSdkCustomAttribute[];
      xContextId?: string;
  }
  - applicationId: string
  - epSdkCustomAttributes: TEpSdkCustomAttribute[]
  - Optional xContextId?: string
Returns Promise<Application>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationsService.ts:105

unsetCustomAttributes

unsetCustomAttributes(__namedParameters: {
    applicationId: string;
    epSdkCustomAttributes: TEpSdkCustomAttribute[];
    xContextId?: string;
}): Promise<Application>
Unsets the custom attributes in the list on the application. Leaves attibute definitions as-is.
Parameters
- __namedParameters: {
      applicationId: string;
      epSdkCustomAttributes: TEpSdkCustomAttribute[];
      xContextId?: string;
  }
  - applicationId: string
  - epSdkCustomAttributes: TEpSdkCustomAttribute[]
  - Optional xContextId?: string
Returns Promise<Application>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationsService.ts:130

`Private` updateApplication

updateApplication(__namedParameters: {
update: Application;
xContextId?: string;
}): Promise<Application>
Parameters
- __namedParameters: {
  update: Application;
  xContextId?: string;
  }
  - update: Application
  - Optional xContextId?: string
Returns Promise<Application>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationsService.ts:75

Class EpSdkApplicationsServiceClass

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns EpSdkApplicationsServiceClass

Methods

deleteById

Parameters

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

Optional applicationDomainId?: string

applicationId: string

Optional xContextId?: string

Returns Promise<Application>

deleteByName

Parameters

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

applicationDomainId: string

applicationName: string

Optional xContextId?: string

Returns Promise<Application>

getById

Parameters

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

Optional applicationDomainId?: string

applicationId: string

Optional xContextId?: string

Returns Promise<Application>

getByName

Parameters

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

applicationDomainId: string

applicationName: string

Optional xContextId?: string

Returns Promise<Application>

listAll

Parameters

param0: { applicationDomainIds?: string[]; sortFieldName?: string; xContextId?: string; }

Optional applicationDomainIds?: string[]

Optional sortFieldName?: string

Optional xContextId?: string

Returns Promise<ApplicationsResponse>

Private listAllForApplicationDomainId

Parameters

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

Optional applicationDomainId?: string

Optional xContextId?: string

Returns Promise<ApplicationsResponse>

removeAssociatedEntityTypeFromCustomAttributeDefinitions

Parameters

__namedParameters: { customAttributeNames: string[]; xContextId?: string; }

customAttributeNames: string[]

Optional xContextId?: string

Returns Promise<void>

setCustomAttributes

Returns

Parameters

param0: { applicationId: string; epSdkCustomAttributes: TEpSdkCustomAttribute[]; xContextId?: string; }

applicationId: string

epSdkCustomAttributes: TEpSdkCustomAttribute[]

Optional xContextId?: string

Returns Promise<Application>

unsetCustomAttributes

Parameters

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

applicationId: string

epSdkCustomAttributes: TEpSdkCustomAttribute[]

Optional xContextId?: string

Returns Promise<Application>

Private updateApplication

Parameters

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

update: Application

Optional xContextId?: string

Returns Promise<Application>

Settings

Member Visibility

Theme

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

`Optional` applicationDomainId?: string

`Optional` xContextId?: string

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

`Optional` xContextId?: string

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

`Optional` applicationDomainId?: string

`Optional` xContextId?: string

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

`Optional` xContextId?: string

param0: {
applicationDomainIds?: string[];
sortFieldName?: string;
xContextId?: string;
}

`Optional` applicationDomainIds?: string[]

`Optional` sortFieldName?: string

`Optional` xContextId?: string

`Private` listAllForApplicationDomainId

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

`Optional` applicationDomainId?: string

`Optional` xContextId?: string

__namedParameters: {
customAttributeNames: string[];
xContextId?: string;
}

`Optional` xContextId?: string

param0: {
applicationId: string;
epSdkCustomAttributes: TEpSdkCustomAttribute[];
xContextId?: string;
}

`Optional` xContextId?: string

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

`Optional` xContextId?: string

`Private` updateApplication

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

`Optional` xContextId?: string