IEventsService.Events

Collection of functions to interact with the Events API endpoint.

All URI’s are relative to the VTN URL configured.

Method	HTTP request	Description
CreateEventAsync	POST /events	Create an event
DeleteEventAsync	DELETE /events/{eventID}	Delete an event
SearchEventsAsync	GET /events	Searches all events
FindEventByIdAsync	GET /events/{eventID}	Searches events by event ID
UpdateEventAsync	PUT /events/{eventID}	Update an event

CreateEventAsync

Task<Event> CreateEventAsync(
    Event @event,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Create a new event in the server.

DeleteEventAsync

Task<Event> DeleteEventAsync(
    string eventId,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Delete an existing event with the event ID.

SearchEventsAsync

Task<List<Event>> SearchEventsAsync(
    string? programId = default,
    string? targetType = default,
    List<string>? targetValues = default,
    int? skip = default,
    int? limit = default,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Searches all events known to the server. Use skip and pagination query params to limit response size.

FindEventByIdAsync

Task<Event> FindEventByIdAsync(
    string eventId,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Find event associated by the event ID.

UpdateEventAsync

Task<Event> UpdateEventAsync(
    string eventId,
    Event @event,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Update an existing event with specified event ID.