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

EventtypesApi - object-oriented interface

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

basePath

basePath: string

fetch

fetch: FetchAPI

Methods

createEventType

deleteEventType

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

  • Delete an event type

    Parameters

    • params: object
      • domain: string
      • entity: string
      • eventType: string
    • Optional options: any

    Returns Promise<any>

eventTypeOptions

  • eventTypeOptions(params: object, options?: any): Promise<string[]>

  • What can this endpoint do?

    Parameters

    • params: object
      • domain: string
      • entity: string
      • eventType: string
    • Optional options: any

    Returns Promise<string[]>

eventTypesOptions

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

  • What can this endpoint do?

    Parameters

    • Optional options: any

    Returns Promise<any>

getEventTypes

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

  • Lists the set of event-types visible on the Administrative Portal.

    Parameters

    • params: object
      • Optional domain?: string
      • Optional entity?: string
      • Optional eventType?: string
    • Optional options: any

    Returns Promise<any>

modifyEventType

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

  • Modify an event type

    Parameters

    • params: object
      • body: Body1
      • domain: string
      • entity: string
      • eventType: string
    • Optional options: any

    Returns Promise<any>