Class EventsModule

Events Module - Event Bus and Audit Log

Constructors

constructor

Properties

client

Methods

getEvent getStats getSubscription listDeliveries listEvents listSubscriptions publish subscribe unsubscribe updateSubscription

Constructors

constructor

Properties

Private client

client: ArqeraClient

Methods

getEvent

  • getEvent(eventId): Promise<unknown>

  • Get event details by ID

    Parameters

    • eventId: number

    Returns Promise<unknown>

getStats

  • getStats(): Promise<unknown>

  • Get event bus statistics

    Returns Promise<unknown>

getSubscription

  • getSubscription(subscriptionId): Promise<unknown>

  • Get subscription details

    Parameters

    • subscriptionId: number

    Returns Promise<unknown>

listDeliveries

  • listDeliveries(options?): Promise<unknown>

  • List event deliveries

    Parameters

    • options: {
          eventId?: number;
          page?: number;
          pageSize?: number;
          status?: string;
          subscriptionId?: number;
      } = {}
      • Optional eventId?: number
      • Optional page?: number
      • Optional pageSize?: number
      • Optional status?: string
      • Optional subscriptionId?: number

    Returns Promise<unknown>

listEvents

  • listEvents(options?): Promise<unknown>

  • List events with optional filters

    Parameters

    • options: {
          category?: string;
          correlationId?: string;
          eventType?: string;
          page?: number;
          pageSize?: number;
          since?: string;
          status?: string;
          until?: string;
      } = {}
      • Optional category?: string
      • Optional correlationId?: string
      • Optional eventType?: string
      • Optional page?: number
      • Optional pageSize?: number
      • Optional since?: string
      • Optional status?: string
      • Optional until?: string

    Returns Promise<unknown>

listSubscriptions

  • listSubscriptions(options?): Promise<unknown>

  • List event subscriptions

    Parameters

    • options: {
          agentDefinitionId?: number;
          isActive?: boolean;
          page?: number;
          pageSize?: number;
      } = {}
      • Optional agentDefinitionId?: number
      • Optional isActive?: boolean
      • Optional page?: number
      • Optional pageSize?: number

    Returns Promise<unknown>

publish

  • publish(options): Promise<unknown>

  • Publish an event to the event bus

    Parameters

    • options: {
          correlationId?: string;
          eventType: string;
          expiresInSeconds?: number;
          payload: Record<string, unknown>;
          source?: string;
          sourceId?: string;
      }
      • Optional correlationId?: string
      • eventType: string
      • Optional expiresInSeconds?: number
      • payload: Record<string, unknown>
      • Optional source?: string
      • Optional sourceId?: string

    Returns Promise<unknown>

subscribe

  • subscribe(options): Promise<unknown>

  • Subscribe an agent to event types

    Parameters

    • options: {
          action: string;
          actionConfig?: Record<string, unknown>;
          agentDefinitionId: number;
          description?: string;
          eventTypes: string[];
          filterConditions?: Record<string, unknown>;
          name: string;
          priority?: number;
          rateLimitPerMinute?: number;
      }
      • action: string
      • Optional actionConfig?: Record<string, unknown>
      • agentDefinitionId: number
      • Optional description?: string
      • eventTypes: string[]
      • Optional filterConditions?: Record<string, unknown>
      • name: string
      • Optional priority?: number
      • Optional rateLimitPerMinute?: number

    Returns Promise<unknown>

unsubscribe

  • unsubscribe(subscriptionId): Promise<unknown>

  • Delete a subscription

    Parameters

    • subscriptionId: number

    Returns Promise<unknown>

updateSubscription

  • updateSubscription(subscriptionId, options): Promise<unknown>

  • Update a subscription

    Parameters

    • subscriptionId: number
    • options: {
          actionConfig?: Record<string, unknown>;
          eventTypes?: string[];
          isActive?: boolean;
          priority?: number;
      }
      • Optional actionConfig?: Record<string, unknown>
      • Optional eventTypes?: string[]
      • Optional isActive?: boolean
      • Optional priority?: number

    Returns Promise<unknown>

Settings

Member Visibility

Theme

On This Page

constructorclientgetEventgetStatsgetSubscriptionlistDeliverieslistEventslistSubscriptionspublishsubscribeunsubscribeupdateSubscription