Class EpSdkEpEventsServiceClass

Hierarchy

EpSdkServiceClass
- EpSdkEpEventsServiceClass

Index

Constructors

Methods

createEvent deleteById deleteByName getById getByName listAll removeAssociatedEntityTypeFromCustomAttributeDefinitions setCustomAttributes unsetCustomAttributes updateEpEvent updateEvent

Constructors

constructor

new EpSdkEpEventsServiceClass(): EpSdkEpEventsServiceClass
Returns EpSdkEpEventsServiceClass

Inherited from EpSdkServiceClass.constructor

Methods

createEvent

createEvent(__namedParameters: {
requestBody: EpSdkEvent;
xContextId?: string;
}): Promise<EpSdkEventResponse>
Parameters
- __namedParameters: {
  requestBody: EpSdkEvent;
  xContextId?: string;
  }
  - requestBody: EpSdkEvent
  - Optional xContextId?: string
Returns Promise<EpSdkEventResponse>
- Defined in packages/ep-sdk/src/services/EpSdkEpEventsService.ts:291

deleteById

deleteById(__namedParameters: {
eventId: string;
xContextId?: string;
}): Promise<EpSdkEvent>
Parameters
- __namedParameters: {
  eventId: string;
  xContextId?: string;
  }
  - eventId: string
  - Optional xContextId?: string
Returns Promise<EpSdkEvent>
- Defined in packages/ep-sdk/src/services/EpSdkEpEventsService.ts:248

deleteByName

deleteByName(__namedParameters: {
    applicationDomainId: string;
    eventName: string;
    xContextId?: string;
}): Promise<EpSdkEvent>
Parameters
- __namedParameters: {
      applicationDomainId: string;
      eventName: string;
      xContextId?: string;
  }
  - applicationDomainId: string
  - eventName: string
  - Optional xContextId?: string
Returns Promise<EpSdkEvent>
- Defined in packages/ep-sdk/src/services/EpSdkEpEventsService.ts:264

getById

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

getByName

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

listAll

listAll(__namedParameters: {
    applicationDomainIds?: string[];
    attributesQuery?: IEpSdkAttributesQuery;
    brokerType?: EpSdkBrokerTypes;
    shared?: boolean;
    sortFieldName?: string;
    xContextId?: string;
}): Promise<EpSdkEventsResponse>
Retrieves a sorted and filtered list of all Events without paging. Filters are all AND.
Parameters
- __namedParameters: {
      applicationDomainIds?: string[];
      attributesQuery?: IEpSdkAttributesQuery;
      brokerType?: EpSdkBrokerTypes;
      shared?: boolean;
      sortFieldName?: string;
      xContextId?: string;
  }
  - Optional applicationDomainIds?: string[]
  - Optional attributesQuery?: IEpSdkAttributesQuery
  - Optional brokerType?: EpSdkBrokerTypes
  - Optional shared?: boolean
  - Optional sortFieldName?: string
  - Optional xContextId?: string
Returns Promise<EpSdkEventsResponse>
- Defined in packages/ep-sdk/src/services/EpSdkEpEventsService.ts:131

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/EpSdkEpEventsService.ts:114

setCustomAttributes

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

Returns
Parameters
- param0: {
      epSdkCustomAttributes: TEpSdkCustomAttribute[];
      eventId: string;
      xContextId?: string;
  }
  - epSdkCustomAttributes: TEpSdkCustomAttribute[]
  - eventId: string
  - Optional xContextId?: string
Returns Promise<EpSdkEvent>
- Defined in packages/ep-sdk/src/services/EpSdkEpEventsService.ts:67

unsetCustomAttributes

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

`Private` updateEpEvent

updateEpEvent(__namedParameters: {
update: EpSdkEventUpdate;
xContextId?: string;
}): Promise<EpSdkEvent>
Parameters
- __namedParameters: {
  update: EpSdkEventUpdate;
  xContextId?: string;
  }
  - update: EpSdkEventUpdate
  - Optional xContextId?: string
Returns Promise<EpSdkEvent>
- Defined in packages/ep-sdk/src/services/EpSdkEpEventsService.ts:37

updateEvent

updateEvent(__namedParameters: {
    eventId: string;
    requestBody: EpSdkEventUpdate;
    xContextId?: string;
}): Promise<EpSdkEventResponse>
Parameters
- __namedParameters: {
      eventId: string;
      requestBody: EpSdkEventUpdate;
      xContextId?: string;
  }
  - eventId: string
  - requestBody: EpSdkEventUpdate
  - Optional xContextId?: string
Returns Promise<EpSdkEventResponse>
- Defined in packages/ep-sdk/src/services/EpSdkEpEventsService.ts:316

Class EpSdkEpEventsServiceClass

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns EpSdkEpEventsServiceClass

Methods

createEvent

Parameters

__namedParameters: { requestBody: EpSdkEvent; xContextId?: string; }

requestBody: EpSdkEvent

Optional xContextId?: string

Returns Promise<EpSdkEventResponse>

deleteById

Parameters

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

eventId: string

Optional xContextId?: string

Returns Promise<EpSdkEvent>

deleteByName

Parameters

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

applicationDomainId: string

eventName: string

Optional xContextId?: string

Returns Promise<EpSdkEvent>

getById

Parameters

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

eventId: string

Optional xContextId?: string

Returns Promise<EpSdkEvent>

getByName

Parameters

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

applicationDomainId: string

eventName: string

Optional xContextId?: string

Returns Promise<EpSdkEvent>

listAll

Parameters

__namedParameters: { applicationDomainIds?: string[]; attributesQuery?: IEpSdkAttributesQuery; brokerType?: EpSdkBrokerTypes; shared?: boolean; sortFieldName?: string; xContextId?: string; }

Optional applicationDomainIds?: string[]

Optional attributesQuery?: IEpSdkAttributesQuery

Optional brokerType?: EpSdkBrokerTypes

Optional shared?: boolean

Optional sortFieldName?: string

Optional xContextId?: string

Returns Promise<EpSdkEventsResponse>

removeAssociatedEntityTypeFromCustomAttributeDefinitions

Parameters

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

customAttributeNames: string[]

Optional xContextId?: string

Returns Promise<void>

setCustomAttributes

Returns

Parameters

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

epSdkCustomAttributes: TEpSdkCustomAttribute[]

eventId: string

Optional xContextId?: string

Returns Promise<EpSdkEvent>

unsetCustomAttributes

Parameters

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

epSdkCustomAttributes: TEpSdkCustomAttribute[]

eventId: string

Optional xContextId?: string

Returns Promise<EpSdkEvent>

Private updateEpEvent

Parameters

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

update: EpSdkEventUpdate

Optional xContextId?: string

Returns Promise<EpSdkEvent>

updateEvent

Parameters

__namedParameters: {
requestBody: EpSdkEvent;
xContextId?: string;
}

`Optional` xContextId?: string

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

`Optional` xContextId?: string

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

`Optional` xContextId?: string

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

`Optional` xContextId?: string

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

`Optional` xContextId?: string

__namedParameters: {
applicationDomainIds?: string[];
attributesQuery?: IEpSdkAttributesQuery;
brokerType?: EpSdkBrokerTypes;
shared?: boolean;
sortFieldName?: string;
xContextId?: string;
}

`Optional` applicationDomainIds?: string[]

`Optional` attributesQuery?: IEpSdkAttributesQuery

`Optional` brokerType?: EpSdkBrokerTypes

`Optional` shared?: boolean

`Optional` sortFieldName?: string

`Optional` xContextId?: string

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

`Optional` xContextId?: string

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

`Optional` xContextId?: string

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

`Optional` xContextId?: string

`Private` updateEpEvent

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

`Optional` xContextId?: string

__namedParameters: {
eventId: string;
requestBody: EpSdkEventUpdate;
xContextId?: string;
}

`Optional` xContextId?: string