Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApplicationService

Hierarchy

Index

Constructors

constructor

Methods

binary

clone

create

  • Parameters

    Returns Promise<IResult<IApplication>>

    Response wrapped in IResult

    Example

    
     const newApp = {
       name: 'New application',
       type: 'EXTERNAL',
       key: 'new-app'
     };
    
     (async () => {
       const {data, res} = await applicationService.create(newApp);
     })();
    

delete

  • Parameters

    Returns Promise<IResult<null>>

    Response wrapped in IResult

detail

  • Parameters

    Returns Promise<IResult<IApplication>>

    Response wrapped in IResult

    Example

    
       const applicationId: number = 1;
    
       (async () => {
         const {data, res} = await applicationService.detail(applicationId);
      })();
    

getHref

  • Parameters

    Returns string

isAvailable

  • Parameters

    Returns Promise<IResult<boolean>>

    Response wrapped in IResult

list

list$

  • Parameters

    Returns Observable<IApplication[]>

    Data wrapped as ObservableList

    Example

    
      const list$ = alarmService.list$();
      list$.subscribe((data) => console.log(data));
    

    Deprecated This function will be removed soon in favor of decoupling this library from rxjs. Use Realtime for realtime connection and rxjs defer() or from() to composite an observable on your own.

listByName

  • Parameters

    • name: string

    Returns Promise<IResultList<IApplication>>

listByOwner

  • Parameters

    • Optional tenantOrName: string | ITenant
    • Default value params: object = {}

    Returns Promise<IResultList<IApplication>>

listByTenant

  • Parameters

    • Optional tenantOrName: string | ITenant
    • Default value params: object = {}

    Returns Promise<IResultList<IApplication>>

listByUser

  • Parameters

    • Optional userOrId: string | number | IUser
    • Default value params: object = {}

    Returns Promise<IResultList<IApplication>>

update

  • Parameters

    Returns Promise<IResult<IApplication>>

    Response wrapped in IResult

    Example

    
     const updateApp = {
       id: 38
       name: 'Updated application'
     };
    
     (async () => {
       const {data, res} = await applicationService.update(updateApp);
     })();
    

Generated using TypeDoc