SubscriptionsApi | byu-event-hub-sdk

SubscriptionsApi - object-oriented interface

Hierarchy

BaseAPI
- SubscriptionsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SubscriptionsApi(fetch?: FetchAPI, basePath?: string): SubscriptionsApi

Inherited from BaseAPI.constructor
- Defined in api.ts:31
Parameters
- Default value fetch: FetchAPI = isomorphicFetch
- Default value basePath: string = BASE_PATH
Returns SubscriptionsApi

Properties

basePath

basePath: string

fetch

fetch: FetchAPI

Methods

createSubscription

createSubscription(params: object, options?: any): Promise<InlineResponse2013>

- Defined in api.ts:2305
Defines a new subscription.

Parameters
- params: object
  - body: Body5
- Optional options: any
Returns Promise<InlineResponse2013>

deleteSubscription

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

- Defined in api.ts:2315
Delete a subscription

Parameters
- params: object
  - domain: string
  - entity: string
  - eventType: string
- Optional options: any
Returns Promise<any>

getSubscriptions

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

- Defined in api.ts:2326
Lists the set of subscriptions visible on the Administrative Portal.

Parameters
- params: object
  - Optional domain?: string
  - ecaIdentityId: string
  - Optional entity?: string
  - Optional eventType?: string
- Optional options: any
Returns Promise<any>

subscriptionOptions

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

- Defined in api.ts:2336
What can this endpoint do?

Parameters
- params: object
  - domain: string
  - entity: string
  - eventType: string
- Optional options: any
Returns Promise<string[]>

subscriptionsOptions

subscriptionsOptions(options?: any): Promise<any>

- Defined in api.ts:2343
What can this endpoint do?

Parameters
- Optional options: any
Returns Promise<any>