Interface IAnnotoApi

Hierarchy

IAnnotoApi

Index

Methods

auth destroy getMetadata getWidgetState hide load logout samlAuth show

Methods

auth

auth(token): Promise<void>
Single Sign On (SSO) user authentication
Parameters
- token: string
Returns Promise<void>
- Defined in api/index.ts:16

destroy

destroy(index?): Promise<void>
Destroy single or all the widgets
Parameters
- Optional index: number
  
  if provided destroy specific widget
Returns Promise<void>
- Defined in api/index.ts:32

getMetadata

getMetadata(index?): IMetadata
get metrics stats
Parameters
- Optional index: number
  
  widget index, 0 by default
Returns IMetadata
- Defined in api/index.ts:51

getWidgetState

getWidgetState(index?): WidgetStateType
Get state of the a widget
Parameters
- Optional index: number
  
  widget index, 0 by default
Returns WidgetStateType
- Defined in api/index.ts:56

hide

hide(index?): Promise<void>
Hide single or all the widgets
Parameters
- Optional index: number
  
  if provided hide specific widget
Returns Promise<void>
- Defined in api/index.ts:46

load

load(config): Promise<void>
Load new application configuration
Parameters
- config: IConfig<IFeatures>
Returns Promise<void>
- Defined in api/index.ts:27

logout

logout(): Promise<void>
Logout current user

Returns Promise<void>
- Defined in api/index.ts:36

samlAuth

samlAuth(responseXml): Promise<void>
Sing Sign On (SSO) user via SAML Notice: SAML integration needs to be setup for this method to work
Parameters
- responseXml: string
  
  SAMLResponse xml payload
Returns Promise<void>
- Defined in api/index.ts:22

show

show(index?): Promise<void>
Show single or all the widgets
Parameters
- Optional index: number
  
  if provided show specific widget
Returns Promise<void>
- Defined in api/index.ts:41