Class EpSdkApplicationDomainsServiceClass

Hierarchy

EpSdkServiceClass
- EpSdkApplicationDomainsServiceClass

Index

Constructors

Methods

deleteById deleteByName getById getByName listAll removeAssociatedEntityTypeFromCustomAttributeDefinitions setCustomAttributes unsetCustomAttributes updateApplicationDomain

Constructors

constructor

new EpSdkApplicationDomainsServiceClass(): EpSdkApplicationDomainsServiceClass
Returns EpSdkApplicationDomainsServiceClass

Inherited from EpSdkServiceClass.constructor

Methods

deleteById

deleteById(object: {
applicationDomainId: string;
xContextId?: string;
}): Promise<ApplicationDomain>
Delete application domain object by id.

Returns
ApplicationDomain - the deleted application domain object
Parameters
- object: {
  applicationDomainId: string;
  xContextId?: string;
  }
  - applicationDomainId: string
  - Optional xContextId?: string
Returns Promise<ApplicationDomain>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationDomainsService.ts:228

deleteByName

deleteByName(object: {
applicationDomainName: string;
xContextId?: string;
}): Promise<ApplicationDomain>
Delete application domain object by name.

Returns
ApplicationDomain - the deleted application domain object

Throws
EpSdkServiceError - if application domain does not exist
Parameters
- object: {
  applicationDomainName: string;
  xContextId?: string;
  }
  - applicationDomainName: string
  - Optional xContextId?: string
Returns Promise<ApplicationDomain>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationDomainsService.ts:249

getById

getById(object: {
applicationDomainId: string;
xContextId?: string;
}): Promise<ApplicationDomain>
Get application domain object by id.

Returns
ApplicationDomain

Throws
EpSdkApiContentError - if api response data is undefined
Parameters
- object: {
  applicationDomainId: string;
  xContextId?: string;
  }
  - applicationDomainId: string
  - Optional xContextId?: string
Returns Promise<ApplicationDomain>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationDomainsService.ts:204

getByName

getByName(object: {
applicationDomainName: string;
xContextId?: string;
}): Promise<ApplicationDomain>
Get application domain object by name.

Returns
ApplicationDomain - if found

Returns
undefined - if not found

Throws
EpSdkApiContentError - if more than 1 application domain exists with the same name
Parameters
- object: {
  applicationDomainName: string;
  xContextId?: string;
  }
  - applicationDomainName: string
  - Optional xContextId?: string
Returns Promise<ApplicationDomain>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationDomainsService.ts:172

listAll

listAll(__namedParameters: {
    attributesQuery?: IEpSdkAttributesQuery;
    pageSize?: number;
    xContextId?: string;
}): Promise<ApplicationDomainsResponse>
Parameters
- __namedParameters: {
      attributesQuery?: IEpSdkAttributesQuery;
      pageSize?: number;
      xContextId?: string;
  }
  - Optional attributesQuery?: IEpSdkAttributesQuery
  - Optional pageSize?: number
  - Optional xContextId?: string
Returns Promise<ApplicationDomainsResponse>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationDomainsService.ts:114

removeAssociatedEntityTypeFromCustomAttributeDefinitions

removeAssociatedEntityTypeFromCustomAttributeDefinitions(__namedParameters: {
customAttributeNames: string[];
xContextId?: string;
}): Promise<void>
Removes the custom attribute association for application domains.
Parameters
- __namedParameters: {
  customAttributeNames: string[];
  xContextId?: string;
  }
  - customAttributeNames: string[]
  - Optional xContextId?: string
Returns Promise<void>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationDomainsService.ts:101

setCustomAttributes

setCustomAttributes(__namedParameters: {
    applicationDomainId: string;
    epSdkCustomAttributes: TEpSdkCustomAttribute[];
    xContextId?: string;
}): Promise<ApplicationDomain>
Sets the custom attributes in the list on the application domain. Creates attribute definitions / adds entity type 'applicationDomain' if it doesn't exist.
Parameters
- __namedParameters: {
      applicationDomainId: string;
      epSdkCustomAttributes: TEpSdkCustomAttribute[];
      xContextId?: string;
  }
  - applicationDomainId: string
  - epSdkCustomAttributes: TEpSdkCustomAttribute[]
  - Optional xContextId?: string
Returns Promise<ApplicationDomain>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationDomainsService.ts:60

unsetCustomAttributes

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

`Private` updateApplicationDomain

updateApplicationDomain(__namedParameters: {
update: ApplicationDomain;
xContextId?: string;
}): Promise<ApplicationDomain>
Parameters
- __namedParameters: {
  update: ApplicationDomain;
  xContextId?: string;
  }
  - update: ApplicationDomain
  - Optional xContextId?: string
Returns Promise<ApplicationDomain>
- Defined in packages/ep-sdk/src/services/EpSdkApplicationDomainsService.ts:34

Class EpSdkApplicationDomainsServiceClass

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns EpSdkApplicationDomainsServiceClass

Methods

deleteById

Returns

Parameters

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

applicationDomainId: string

Optional xContextId?: string

Returns Promise<ApplicationDomain>

deleteByName

Returns

Throws

Parameters

object: { applicationDomainName: string; xContextId?: string; }

applicationDomainName: string

Optional xContextId?: string

Returns Promise<ApplicationDomain>

getById

Returns

Throws

Parameters

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

applicationDomainId: string

Optional xContextId?: string

Returns Promise<ApplicationDomain>

getByName

Returns

Returns

Throws

Parameters

object: { applicationDomainName: string; xContextId?: string; }

applicationDomainName: string

Optional xContextId?: string

Returns Promise<ApplicationDomain>

listAll

Parameters

__namedParameters: { attributesQuery?: IEpSdkAttributesQuery; pageSize?: number; xContextId?: string; }

Optional attributesQuery?: IEpSdkAttributesQuery

Optional pageSize?: number

Optional xContextId?: string

Returns Promise<ApplicationDomainsResponse>

removeAssociatedEntityTypeFromCustomAttributeDefinitions

Parameters

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

customAttributeNames: string[]

Optional xContextId?: string

Returns Promise<void>

setCustomAttributes

Parameters

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

applicationDomainId: string

epSdkCustomAttributes: TEpSdkCustomAttribute[]

Optional xContextId?: string

Returns Promise<ApplicationDomain>

unsetCustomAttributes

Parameters

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

applicationDomainId: string

epSdkCustomAttributes: TEpSdkCustomAttribute[]

Optional xContextId?: string

Returns Promise<ApplicationDomain>

Private updateApplicationDomain

Parameters

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

update: ApplicationDomain

Optional xContextId?: string

Returns Promise<ApplicationDomain>

Settings

Member Visibility

Theme

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

`Optional` xContextId?: string

object: {
applicationDomainName: string;
xContextId?: string;
}

`Optional` xContextId?: string

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

`Optional` xContextId?: string

object: {
applicationDomainName: string;
xContextId?: string;
}

`Optional` xContextId?: string

__namedParameters: {
attributesQuery?: IEpSdkAttributesQuery;
pageSize?: number;
xContextId?: string;
}

`Optional` attributesQuery?: IEpSdkAttributesQuery

`Optional` pageSize?: number

`Optional` xContextId?: string

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

`Optional` xContextId?: string

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

`Optional` xContextId?: string

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

`Optional` xContextId?: string

`Private` updateApplicationDomain

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

`Optional` xContextId?: string