Class EpSdkCustomAttributeDefinitionsServiceClass

Hierarchy

EpSdkServiceClass
- EpSdkCustomAttributeDefinitionsServiceClass

Index

Constructors

Methods

deleteById getById getByName listAll presentAssociatedEntityType removeAssociatedEntityTypeFromCustomAttributeDefinition

Constructors

constructor

new EpSdkCustomAttributeDefinitionsServiceClass(): EpSdkCustomAttributeDefinitionsServiceClass
Returns EpSdkCustomAttributeDefinitionsServiceClass

Inherited from EpSdkServiceClass.constructor

Methods

deleteById

deleteById(__namedParameters: {
    applicationDomainId?: string;
    customAttributeDefinitionId: string;
    xContextId?: string;
}): Promise<CustomAttributeDefinition>
Parameters
- __namedParameters: {
      applicationDomainId?: string;
      customAttributeDefinitionId: string;
      xContextId?: string;
  }
  - Optional applicationDomainId?: string
  - customAttributeDefinitionId: string
  - Optional xContextId?: string
Returns Promise<CustomAttributeDefinition>
- Defined in packages/ep-sdk/src/services/EpSdkCustomAttributeDefinitionsService.ts:247

getById

getById(__namedParameters: {
    applicationDomainId?: string;
    customAttributeDefinitionId: string;
    xContextId?: string;
}): Promise<CustomAttributeDefinition>
Parameters
- __namedParameters: {
      applicationDomainId?: string;
      customAttributeDefinitionId: string;
      xContextId?: string;
  }
  - Optional applicationDomainId?: string
  - customAttributeDefinitionId: string
  - Optional xContextId?: string
Returns Promise<CustomAttributeDefinition>
- Defined in packages/ep-sdk/src/services/EpSdkCustomAttributeDefinitionsService.ts:210

getByName

getByName(__namedParameters: {
    applicationDomainId?: string;
    attributeName: string;
    pageSize?: number;
    xContextId?: string;
}): Promise<CustomAttributeDefinition>
Get attribute definition by name. Name is unique.
Parameters
- __namedParameters: {
      applicationDomainId?: string;
      attributeName: string;
      pageSize?: number;
      xContextId?: string;
  }
  - Optional applicationDomainId?: string
  - attributeName: string
  - Optional pageSize?: number
  - Optional xContextId?: string
Returns Promise<CustomAttributeDefinition>
- Defined in packages/ep-sdk/src/services/EpSdkCustomAttributeDefinitionsService.ts:115

listAll

listAll(__namedParameters: {
xContextId?: string;
}): Promise<CustomAttributeDefinition[]>
Parameters
- __namedParameters: {
  xContextId?: string;
  }
  - Optional xContextId?: string
Returns Promise<CustomAttributeDefinition[]>
- Defined in packages/ep-sdk/src/services/EpSdkCustomAttributeDefinitionsService.ts:28

presentAssociatedEntityType

presentAssociatedEntityType(__namedParameters: {
    applicationDomainId?: string;
    associatedEntityType: EEpSdkCustomAttributeEntityTypes;
    attributeName: string;
    xContextId?: string;
}): Promise<EEpSdkCustomAttributeEntityTypes[]>
Adds the associated entity type to existing list of entity types if definition exists. Returns list of all associated enitity types.
Parameters
- __namedParameters: {
      applicationDomainId?: string;
      associatedEntityType: EEpSdkCustomAttributeEntityTypes;
      attributeName: string;
      xContextId?: string;
  }
  - Optional applicationDomainId?: string
  - associatedEntityType: EEpSdkCustomAttributeEntityTypes
  - attributeName: string
  - Optional xContextId?: string
Returns Promise<EEpSdkCustomAttributeEntityTypes[]>
- Defined in packages/ep-sdk/src/services/EpSdkCustomAttributeDefinitionsService.ts:60

removeAssociatedEntityTypeFromCustomAttributeDefinition

removeAssociatedEntityTypeFromCustomAttributeDefinition(__namedParameters: {
    associatedEntityType: EEpSdkCustomAttributeEntityTypes;
    attributeName: string;
    xContextId?: string;
}): Promise<CustomAttributeDefinition>
Removes the associatedEntityType from the custom attribute definition. If no associatedEntityTypes are left, then deletes the entire custom attribute definition.

Returns
The modified custom attribute definition or undefined if it has been deleted.
Parameters
- __namedParameters: {
      associatedEntityType: EEpSdkCustomAttributeEntityTypes;
      attributeName: string;
      xContextId?: string;
  }
  - associatedEntityType: EEpSdkCustomAttributeEntityTypes
  - attributeName: string
  - Optional xContextId?: string
Returns Promise<CustomAttributeDefinition>
- Defined in packages/ep-sdk/src/services/EpSdkCustomAttributeDefinitionsService.ts:80

Class EpSdkCustomAttributeDefinitionsServiceClass

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns EpSdkCustomAttributeDefinitionsServiceClass

Methods

deleteById

Parameters

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

Optional applicationDomainId?: string

customAttributeDefinitionId: string

Optional xContextId?: string

Returns Promise<CustomAttributeDefinition>

getById

Parameters

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

Optional applicationDomainId?: string

customAttributeDefinitionId: string

Optional xContextId?: string

Returns Promise<CustomAttributeDefinition>

getByName

Parameters

__namedParameters: { applicationDomainId?: string; attributeName: string; pageSize?: number; xContextId?: string; }

Optional applicationDomainId?: string

attributeName: string

Optional pageSize?: number

Optional xContextId?: string

Returns Promise<CustomAttributeDefinition>

listAll

Parameters

__namedParameters: { xContextId?: string; }

Optional xContextId?: string

Returns Promise<CustomAttributeDefinition[]>

presentAssociatedEntityType

Parameters

__namedParameters: { applicationDomainId?: string; associatedEntityType: EEpSdkCustomAttributeEntityTypes; attributeName: string; xContextId?: string; }

Optional applicationDomainId?: string

associatedEntityType: EEpSdkCustomAttributeEntityTypes

attributeName: string

Optional xContextId?: string

Returns Promise<EEpSdkCustomAttributeEntityTypes[]>

removeAssociatedEntityTypeFromCustomAttributeDefinition

Returns

Parameters

__namedParameters: { associatedEntityType: EEpSdkCustomAttributeEntityTypes; attributeName: string; xContextId?: string; }

associatedEntityType: EEpSdkCustomAttributeEntityTypes

attributeName: string

Optional xContextId?: string

Returns Promise<CustomAttributeDefinition>

Settings

Member Visibility

Theme

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

`Optional` applicationDomainId?: string

`Optional` xContextId?: string

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

`Optional` applicationDomainId?: string

`Optional` xContextId?: string

__namedParameters: {
applicationDomainId?: string;
attributeName: string;
pageSize?: number;
xContextId?: string;
}

`Optional` applicationDomainId?: string

`Optional` pageSize?: number

`Optional` xContextId?: string

__namedParameters: {
xContextId?: string;
}

`Optional` xContextId?: string

__namedParameters: {
applicationDomainId?: string;
associatedEntityType: EEpSdkCustomAttributeEntityTypes;
attributeName: string;
xContextId?: string;
}

`Optional` applicationDomainId?: string

`Optional` xContextId?: string

__namedParameters: {
associatedEntityType: EEpSdkCustomAttributeEntityTypes;
attributeName: string;
xContextId?: string;
}

`Optional` xContextId?: string