SW Combine SDK
    Preparing search index...

    Events resource for querying events

    Hierarchy (View Summary)

    Index

    Constructors

    Methods

    Constructors

    Methods

    • List events by type and mode (paginated)

      Note: This endpoint uses 0-based indexing (unlike most other endpoints which use 1-based).

      Parameters

      • options: {
            eventMode: string;
            eventType?: string;
            faction_id?: string;
            item_count?: number;
            start_index?: number;
            start_time?: number;
        }

        Event mode, event type, and optional pagination/filtering parameters

        • eventMode: string

          Event mode: 'personal', 'faction', 'inventory', or 'combat'

        • OptionaleventType?: string

          Event type filter (optional, only for personal/faction modes)

        • Optionalfaction_id?: string

          Faction ID for faction mode

        • Optionalitem_count?: number

          Number of items to retrieve. Default: 50, Max: 1000

        • Optionalstart_index?: number

          Starting position (0-based). Default: 0

        • Optionalstart_time?: number

          Unix timestamp to filter events after this time

      Returns Promise<Event[]>

      const events = await client.events.list({ eventMode: 'personal' });
      const moreEvents = await client.events.list({ eventMode: 'personal', start_index: 50, item_count: 100 });
      const recentEvents = await client.events.list({ eventMode: 'personal', start_time: 1640000000 });
      const factionEvents = await client.events.list({ eventMode: 'faction', faction_id: '20:123' });
      // Fetch up to 1000 events at once
      const manyEvents = await client.events.list({ eventMode: 'personal', item_count: 1000 });