byu-event-hub-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

ArchivesApi - object-oriented interface

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

basePath

basePath: string

fetch

fetch: FetchAPI

Methods

archivesOptions

  • archivesOptions(options?: any): Promise<any>

  • What can this endpoint do?

    Parameters

    • Optional options: any

    Returns Promise<any>

getArchives

  • getArchives(params: object, options?: any): Promise<any>

  • Retrieve Events from the Event Archive. Most events are available for 45 days.

    Parameters

    • params: object
      • Optional domain?: string
      • Optional entity?: string
      • eventDt: string
      • Optional eventType?: string
      • Optional pageSize?: number
      • Optional pageStart?: number
    • Optional options: any

    Returns Promise<any>