helgoland-toolbox documentation
  1. Classes
  2. EventingApiService

File

libs/eventing/src/lib/eventing-api.service.ts

Extends

ApiInterface

Index

Methods

Methods

Public Abstract getEvent
getEvent(id: string, apiUrl: string, options?: HttpRequestOptions)
Defined in libs/eventing/src/lib/eventing-api.service.ts:17
Parameters :
Name Type Optional
id string No
apiUrl string No
options HttpRequestOptions Yes
Returns : Observable<Event>
Public Abstract getEvents
getEvents(apiUrl: string, params?: EventFilter, options?: HttpRequestOptions)
Defined in libs/eventing/src/lib/eventing-api.service.ts:15
Parameters :
Name Type Optional
apiUrl string No
params EventFilter Yes
options HttpRequestOptions Yes
Returns : Observable<EventResults>
Public Abstract getNotification
getNotification(id: string, apiUrl: string, options?: HttpRequestOptions)
Defined in libs/eventing/src/lib/eventing-api.service.ts:29
Parameters :
Name Type Optional
id string No
apiUrl string No
options HttpRequestOptions Yes
Returns : Observable<Notification>
Public Abstract getNotifications
getNotifications(apiUrl: string, params?: NotificationFilter, options?: HttpRequestOptions)
Defined in libs/eventing/src/lib/eventing-api.service.ts:27
Parameters :
Name Type Optional
apiUrl string No
params NotificationFilter Yes
options HttpRequestOptions Yes
Returns : Observable<NotificationResults>
Public Abstract getPublication
getPublication(id: string, apiUrl: string, options?: HttpRequestOptions)
Defined in libs/eventing/src/lib/eventing-api.service.ts:25
Parameters :
Name Type Optional
id string No
apiUrl string No
options HttpRequestOptions Yes
Returns : Observable<Publication>
Public Abstract getPublications
getPublications(apiUrl: string, params?: PublicationFilter, options?: HttpRequestOptions)
Defined in libs/eventing/src/lib/eventing-api.service.ts:23
Parameters :
Name Type Optional
apiUrl string No
params PublicationFilter Yes
options HttpRequestOptions Yes
Returns : Observable<PublicationResults>
Public Abstract getSubscription
getSubscription(id: string, apiUrl: string, options?: HttpRequestOptions)
Defined in libs/eventing/src/lib/eventing-api.service.ts:21
Parameters :
Name Type Optional
id string No
apiUrl string No
options HttpRequestOptions Yes
Returns : Observable<Subscription>
Public Abstract getSubscriptions
getSubscriptions(apiUrl: string, params?: SubscriptionFilter, options?: HttpRequestOptions)
Defined in libs/eventing/src/lib/eventing-api.service.ts:19
Parameters :
Name Type Optional
apiUrl string No
params SubscriptionFilter Yes
options HttpRequestOptions Yes
Returns : Observable<SubscriptionResults>
Protected createBasicAuthHeader
createBasicAuthHeader(token: string)
Inherited from ApiInterface
Defined in ApiInterface:19
Parameters :
Name Type Optional
token string No
Returns : HttpHeaders
Protected createRequestTimespan
createRequestTimespan(timespan: Timespan)
Inherited from ApiInterface
Defined in ApiInterface:15
Parameters :
Name Type Optional
timespan Timespan No
Returns : string
Protected createRequestUrl
createRequestUrl(apiUrl: string, endpoint: string, id?: string)
Inherited from ApiInterface
Defined in ApiInterface:8
Parameters :
Name Type Optional
apiUrl string No
endpoint string No
id string Yes
Returns : string 
import { ApiInterface, HttpRequestOptions } from '@helgoland/core';
import { Observable } from 'rxjs';

import { EventFilter } from './model/request/events';
import { SubscriptionFilter } from './model/request/subscriptions';
import { Event, EventResults } from './model/response/events';
import { Subscription, SubscriptionResults } from './model/response/subscriptions';
import { PublicationFilter } from './model/request/publications';
import { PublicationResults, Publication } from './model/response/publications';
import { NotificationFilter } from './model/request/notifications';
import { NotificationResults, Notification } from './model/response/notifications';

export abstract class EventingApiService extends ApiInterface {

  public abstract getEvents(apiUrl: string, params?: EventFilter, options?: HttpRequestOptions): Observable<EventResults>;

  public abstract getEvent(id: string, apiUrl: string, options?: HttpRequestOptions): Observable<Event>;

  public abstract getSubscriptions(apiUrl: string, params?: SubscriptionFilter, options?: HttpRequestOptions): Observable<SubscriptionResults>;

  public abstract getSubscription(id: string, apiUrl: string, options?: HttpRequestOptions): Observable<Subscription>;

  public abstract getPublications(apiUrl: string, params?: PublicationFilter, options?: HttpRequestOptions): Observable<PublicationResults>;

  public abstract getPublication(id: string, apiUrl: string, options?: HttpRequestOptions): Observable<Publication>;

  public abstract getNotifications(apiUrl: string, params?: NotificationFilter, options?: HttpRequestOptions): Observable<NotificationResults>;

  public abstract getNotification(id: string, apiUrl: string, options?: HttpRequestOptions): Observable<Notification>;

}

result-matching ""

    No results matching ""