Interface IAnnotoApi

Hierarchy

IAnnotoApi

Index

Methods

Methods

auth

auth(token: string): Promise<void>

- Defined in api/index.ts:15
Single Sign On (SSO) user authentication

Parameters
- token: string
Returns Promise<void>

destroy

destroy(index?: number): Promise<void>

- Defined in api/index.ts:25
Destroy single or all the widgets

Parameters
- Optional index: number
  
  if provided destroy specific widget
Returns Promise<void>

getMetadata

getMetadata(index?: number): IMetadata

- Defined in api/index.ts:44
get metrics stats

Parameters
- Optional index: number
  
  widget index, 0 by default
Returns IMetadata

getWidgetState

getWidgetState(index?: number): WidgetStateType

- Defined in api/index.ts:49
Get state of the a widget

Parameters
- Optional index: number
  
  widget index, 0 by default
Returns WidgetStateType

hide

hide(index?: number): Promise<void>

- Defined in api/index.ts:39
Hide single or all the widgets

Parameters
- Optional index: number
  
  if provided hide specific widget
Returns Promise<void>

load

load(config: IConfig<IFeatures>): Promise<void>

- Defined in api/index.ts:20
Load new application configuration

Parameters
- config: IConfig<IFeatures>
Returns Promise<void>

logout

logout(): Promise<void>

- Defined in api/index.ts:29
Logout current user

Returns Promise<void>

show

show(index?: number): Promise<void>

- Defined in api/index.ts:34
Show single or all the widgets

Parameters
- Optional index: number
  
  if provided show specific widget
Returns Promise<void>