Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Endpoint

Endpoint class represents an Obelisk API Endpoint.

Hierarchy

  • Endpoint

Index

Accessors

Methods

Accessors

url

  • get url(): string
  • Absolute url to use in requests

    Returns string

Methods

delete

  • delete(): Observable<AjaxResponse>
  • Perform an ajax delete request and handle any auth errors.

    Returns Observable<AjaxResponse>

get

  • get(): Observable<AjaxResponse>
  • Perform an ajax get request and handle any auth errors.

    Returns Observable<AjaxResponse>

head

  • head(): Observable<AjaxResponse>
  • Perform an ajax head request and handle any auth errors.

    Returns Observable<AjaxResponse>

post

  • post(body: any): Observable<AjaxResponse>
  • Perform an ajax post request and handle any auth errors.

    Parameters

    • body: any

      The body

    Returns Observable<AjaxResponse>

put

  • put(body: any): Observable<AjaxResponse>
  • Perform an ajax put request and handle any auth errors.

    Parameters

    • body: any

      The body

    Returns Observable<AjaxResponse>

Static create

  • Creates an Endpoint instance, the client is used to add tokens and uri is relative path starting after /api/. Examples are: /things/my_thing/metrics/my_metric/events?from=1530089953000 or /locations/my_loc/metrics/my_metric/stats/unit

    Parameters

    Returns Endpoint