Class EpSdkEventApisServiceClass

Hierarchy

EpSdkServiceClass
- EpSdkEventApisServiceClass

Index

Constructors

constructor

Methods

deleteById deleteByName getById getByName setCustomAttributes updateEventApi

Constructors

constructor

new EpSdkEventApisServiceClass(): EpSdkEventApisServiceClass
Returns EpSdkEventApisServiceClass

Inherited from EpSdkServiceClass.constructor

Methods

deleteById

deleteById(__namedParameters: {
    applicationDomainId?: string;
    eventApiId: string;
    xContextId?: string;
}): Promise<EventApi>
Parameters
- __namedParameters: {
      applicationDomainId?: string;
      eventApiId: string;
      xContextId?: string;
  }
  - Optional applicationDomainId?: string
  - eventApiId: string
  - Optional xContextId?: string
Returns Promise<EventApi>
- Defined in packages/ep-sdk/src/services/EpSdkEventApisService.ts:131

deleteByName

deleteByName(__namedParameters: {
    applicationDomainId: string;
    eventApiName: string;
    xContextId?: string;
}): Promise<EventApi>
Parameters
- __namedParameters: {
      applicationDomainId: string;
      eventApiName: string;
      xContextId?: string;
  }
  - applicationDomainId: string
  - eventApiName: string
  - Optional xContextId?: string
Returns Promise<EventApi>
- Defined in packages/ep-sdk/src/services/EpSdkEventApisService.ts:149

getById

getById(__namedParameters: {
    applicationDomainId?: string;
    eventApiId: string;
    xContextId?: string;
}): Promise<EventApi>
Parameters
- __namedParameters: {
      applicationDomainId?: string;
      eventApiId: string;
      xContextId?: string;
  }
  - Optional applicationDomainId?: string
  - eventApiId: string
  - Optional xContextId?: string
Returns Promise<EventApi>
- Defined in packages/ep-sdk/src/services/EpSdkEventApisService.ts:103

getByName

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

setCustomAttributes

setCustomAttributes(param0: {
    epSdkCustomAttributes: TEpSdkCustomAttribute[];
    eventApiId: string;
    xContextId?: string;
}): Promise<EventApi>
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: {
      epSdkCustomAttributes: TEpSdkCustomAttribute[];
      eventApiId: string;
      xContextId?: string;
  }
  - epSdkCustomAttributes: TEpSdkCustomAttribute[]
  - eventApiId: string
  - Optional xContextId?: string
Returns Promise<EventApi>
- Defined in packages/ep-sdk/src/services/EpSdkEventApisService.ts:55

`Private` updateEventApi

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

Class EpSdkEventApisServiceClass

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns EpSdkEventApisServiceClass

Methods

deleteById

Parameters

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

Optional applicationDomainId?: string

eventApiId: string

Optional xContextId?: string

Returns Promise<EventApi>

deleteByName

Parameters

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

applicationDomainId: string

eventApiName: string

Optional xContextId?: string

Returns Promise<EventApi>

getById

Parameters

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

Optional applicationDomainId?: string

eventApiId: string

Optional xContextId?: string

Returns Promise<EventApi>

getByName

Parameters

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

applicationDomainId: string

eventApiName: string

Optional xContextId?: string

Returns Promise<EventApi>

setCustomAttributes

Returns

Parameters

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

epSdkCustomAttributes: TEpSdkCustomAttribute[]

eventApiId: string

Optional xContextId?: string

Returns Promise<EventApi>

Private updateEventApi

Parameters

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

update: EventApi

Optional xContextId?: string

Returns Promise<EventApi>

Settings

Member Visibility

Theme

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

`Optional` applicationDomainId?: string

`Optional` xContextId?: string

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

`Optional` xContextId?: string

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

`Optional` applicationDomainId?: string

`Optional` xContextId?: string

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

`Optional` xContextId?: string

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

`Optional` xContextId?: string

`Private` updateEventApi

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

`Optional` xContextId?: string