ApiService

Index

Constructors

• constructor

Properties

• RuntimeConfig

Accessors

• accessToken
• authenticated
• tokenLifetime
• Instance

Methods

• clearLayout
• clearPreferences
• clearSnippet
• clearWorkspace
• getLayouts
• getPreferences
• getSharedWorkspaceKey
• getSnippets
• getWorkspace
• getWorkspaceList
• logout
• setLayout
• setPreference
• setPreferences
• setSnippet
• setToken
• setWorkspace
• stopServer
• SetRuntimeConfig

Constructors

constructor

• new ApiService(): ApiService

• Returns ApiService

Properties

publicstaticRuntimeConfig

RuntimeConfig: RuntimeConfig = {}

Accessors

accessToken

• get accessToken(): string

• Returns string

authenticated

• get authenticated(): boolean

• Returns boolean

tokenLifetime

• get tokenLifetime(): number

• Returns number

staticInstance

• get Instance(): ApiService

• Returns ApiService

Methods

publicclearLayout

• clearLayout(layoutName: string): Promise<any>

• Parameters

  • layoutName: string

  Returns Promise<any>

publicclearPreferences

• clearPreferences(keys: string[]): Promise<any>

• Parameters

  • keys: string[]

  Returns Promise<any>

publicclearSnippet

• clearSnippet(snippetName: string): Promise<any>

• Parameters

  • snippetName: string

  Returns Promise<any>

publicclearWorkspace

• clearWorkspace(workspaceName: string): Promise<any>

• Parameters

  • workspaceName: string

  Returns Promise<any>

publicgetLayouts

• getLayouts(): Promise<{}>

• Returns Promise<{}>

publicgetPreferences

• getPreferences(): Promise<any>

• Returns Promise<any>

publicgetSharedWorkspaceKey

• getSharedWorkspaceKey(workspaceId: string): Promise<string>

• Parameters

  • workspaceId: string

  Returns Promise<string>

publicgetSnippets

• getSnippets(): Promise<Map<string, Snippet>>

• Returns Promise<Map<string, Snippet>>

publicgetWorkspace

• getWorkspace(name: string, isKey?: boolean): Promise<Workspace>

• Parameters

  • name: string

  • isKey: boolean = false

  Returns Promise<Workspace>

publicgetWorkspaceList

• getWorkspaceList(): Promise<WorkspaceListItem[]>

• Returns Promise<WorkspaceListItem[]>

publiclogout

• logout(): Promise<void>

• Returns Promise<void>

publicsetLayout

• setLayout(layoutName: string, layout: any): Promise<boolean>

• Parameters

  • layoutName: string

  • layout: any

  Returns Promise<boolean>

publicsetPreference

• setPreference(key: string, value: any): Promise<any>

• Parameters

  • key: string

  • value: any

  Returns Promise<any>

publicsetPreferences

• setPreferences(preferences: any): Promise<any>

• Parameters

  • preferences: any

  Returns Promise<any>

publicsetSnippet

• setSnippet(snippetName: string, snippet: Snippet): Promise<any>

• Parameters

  • snippetName: string

  • snippet: Snippet

  Returns Promise<any>

setToken

• setToken(tokenString: string, tokenLifetime?: number): boolean

• Parameters

  • tokenString: string

  • tokenLifetime: number = Number.MAX_VALUE

  Returns boolean

publicsetWorkspace

• setWorkspace(workspaceName: string, workspace: Workspace): Promise<Workspace>

• Parameters

  • workspaceName: string

  • workspace: Workspace

  Returns Promise<Workspace>

publicstopServer

• stopServer(): Promise<void>

• Returns Promise<void>

publicstaticSetRuntimeConfig

• SetRuntimeConfig(data: any): void

• Parameters

  • data: any

  Returns void