Class EpSdkEnumsServiceClass

Hierarchy

EpSdkServiceClass
- EpSdkEnumsServiceClass

Index

Constructors

constructor

Methods

deleteById deleteByName getById getByName setCustomAttributes updateEnum

Constructors

constructor

new EpSdkEnumsServiceClass(): EpSdkEnumsServiceClass
Returns EpSdkEnumsServiceClass

Inherited from EpSdkServiceClass.constructor

Methods

deleteById

deleteById(__namedParameters: {
    applicationDomainId: string;
    enumId: string;
    xContextId?: string;
}): Promise<TopicAddressEnum>
Parameters
- __namedParameters: {
      applicationDomainId: string;
      enumId: string;
      xContextId?: string;
  }
  - applicationDomainId: string
  - enumId: string
  - Optional xContextId?: string
Returns Promise<TopicAddressEnum>
- Defined in packages/ep-sdk/src/services/EpSdkEnumsService.ts:132

deleteByName

deleteByName(__namedParameters: {
    applicationDomainId: string;
    enumName: string;
    xContextId?: string;
}): Promise<TopicAddressEnum>
Parameters
- __namedParameters: {
      applicationDomainId: string;
      enumName: string;
      xContextId?: string;
  }
  - applicationDomainId: string
  - enumName: string
  - Optional xContextId?: string
Returns Promise<TopicAddressEnum>
- Defined in packages/ep-sdk/src/services/EpSdkEnumsService.ts:150

getById

getById(__namedParameters: {
    applicationDomainId?: string;
    enumId: string;
    xContextId?: string;
}): Promise<TopicAddressEnum>
Parameters
- __namedParameters: {
      applicationDomainId?: string;
      enumId: string;
      xContextId?: string;
  }
  - Optional applicationDomainId?: string
  - enumId: string
  - Optional xContextId?: string
Returns Promise<TopicAddressEnum>
- Defined in packages/ep-sdk/src/services/EpSdkEnumsService.ts:104

getByName

getByName(__namedParameters: {
    applicationDomainId: string;
    enumName: string;
    xContextId?: string;
}): Promise<TopicAddressEnum>
Parameters
- __namedParameters: {
      applicationDomainId: string;
      enumName: string;
      xContextId?: string;
  }
  - applicationDomainId: string
  - enumName: string
  - Optional xContextId?: string
Returns Promise<TopicAddressEnum>
- Defined in packages/ep-sdk/src/services/EpSdkEnumsService.ts:76

setCustomAttributes

setCustomAttributes(__namedParameters: {
    enumId: string;
    epSdkCustomAttributes: TEpSdkCustomAttribute[];
    xContextId?: string;
}): Promise<TopicAddressEnum>
Sets the custom attributes in the list on the event api product. Creates attribute definitions / adds entity type 'eventApiProduct' if it doesn't exist.
Parameters
- __namedParameters: {
      enumId: string;
      epSdkCustomAttributes: TEpSdkCustomAttribute[];
      xContextId?: string;
  }
  - enumId: string
  - epSdkCustomAttributes: TEpSdkCustomAttribute[]
  - Optional xContextId?: string
Returns Promise<TopicAddressEnum>
- Defined in packages/ep-sdk/src/services/EpSdkEnumsService.ts:53

`Private` updateEnum

updateEnum(__namedParameters: {
update: TopicAddressEnum;
xContextId?: string;
}): Promise<TopicAddressEnum>
Parameters
- __namedParameters: {
  update: TopicAddressEnum;
  xContextId?: string;
  }
  - update: TopicAddressEnum
  - Optional xContextId?: string
Returns Promise<TopicAddressEnum>
- Defined in packages/ep-sdk/src/services/EpSdkEnumsService.ts:27

Class EpSdkEnumsServiceClass

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns EpSdkEnumsServiceClass

Methods

deleteById

Parameters

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

applicationDomainId: string

enumId: string

Optional xContextId?: string

Returns Promise<TopicAddressEnum>

deleteByName

Parameters

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

applicationDomainId: string

enumName: string

Optional xContextId?: string

Returns Promise<TopicAddressEnum>

getById

Parameters

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

Optional applicationDomainId?: string

enumId: string

Optional xContextId?: string

Returns Promise<TopicAddressEnum>

getByName

Parameters

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

applicationDomainId: string

enumName: string

Optional xContextId?: string

Returns Promise<TopicAddressEnum>

setCustomAttributes

Parameters

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

enumId: string

epSdkCustomAttributes: TEpSdkCustomAttribute[]

Optional xContextId?: string

Returns Promise<TopicAddressEnum>

Private updateEnum

Parameters

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

update: TopicAddressEnum

Optional xContextId?: string

Returns Promise<TopicAddressEnum>

Settings

Member Visibility

Theme

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

`Optional` xContextId?: string

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

`Optional` xContextId?: string

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

`Optional` applicationDomainId?: string

`Optional` xContextId?: string

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

`Optional` xContextId?: string

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

`Optional` xContextId?: string

`Private` updateEnum

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

`Optional` xContextId?: string