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

SummariesApi - object-oriented interface

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

basePath

basePath: string

fetch

fetch: FetchAPI

Methods

getSummaries

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

  • Lists the set of summaries visible on the Administrative Portal.

    Parameters

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

    Returns Promise<any>

summariesOptions

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

  • What can this endpoint do?

    Parameters

    • Optional options: any

    Returns Promise<any>