Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LSPluginUser

User plugin instance

Hierarchy

Implements

Index

Constructors

Properties

_beforeunloadCallback?: (e: any) => Promise<void>

Type declaration

    • (e: any): Promise<void>
    • handler of before unload plugin

      Parameters

      • e: any

      Returns Promise<void>

_connected: boolean = false
_debugTag: string = ''
_mExperiments: LSPluginExperiments
_mFileStorage: LSPluginFileStorage
_settingsSchema?: SettingSchemaDesc[]
_ui: Map<number, uiState> = ...

ui frame identities

_version: string = LIB_VERSION
prefixed: string | boolean

Accessors

  • get Experiments(): LSPluginExperiments
  • get FileStorage(): LSPluginFileStorage
  • get caller(): LSPluginCaller
  • get connected(): boolean
  • get isMainUIVisible(): boolean
  • get settings(): { disabled: boolean }
  • get version(): string

Methods

  • _callWin(...args: any[]): Promise<any>
  • _execCallableAPI(method: any, ...args: any[]): void
  • _execCallableAPIAsync(method: any, ...args: any[]): Promise<any>
  • addListener<T>(event: T, fn: (...args: any[]) => void, context?: any): LSPluginUser
  • Type parameters

    Parameters

    • event: T
    • fn: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any

    Returns LSPluginUser

  • beforeunload(callback: (e: any) => Promise<void>): void
  • emit<T>(event: T, ...args: any[]): boolean
  • Calls each of the listeners registered for a given event.

    Type parameters

    Parameters

    • event: T
    • Rest ...args: any[]

    Returns boolean

  • ensureConnected(): void
  • Return an array listing the events for which the emitter has registered listeners.

    Returns LSPluginUserEvents[]

  • hideMainUI(opts?: { restoreEditingCursor: boolean }): void
  • hideSettingsUI(): void
  • Return the number of listeners listening to a given event.

    Parameters

    Returns number

  • listeners<T>(event: T): ((...args: any[]) => void)[]
  • Return the listeners registered for a given event.

    Type parameters

    Parameters

    • event: T

    Returns ((...args: any[]) => void)[]

  • off<T>(event: T, fn?: (...args: any[]) => void, context?: any, once?: boolean): LSPluginUser
  • Type parameters

    Parameters

    • event: T
    • Optional fn: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any
    • Optional once: boolean

    Returns LSPluginUser

  • on<T>(event: T, fn: (...args: any[]) => void, context?: any): LSPluginUser
  • Add a listener for a given event.

    Type parameters

    Parameters

    • event: T
    • fn: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any

    Returns LSPluginUser

  • onSettingsChanged<T>(cb: (a: T, b: T) => void): IUserOffHook
  • once<T>(event: T, fn: (...args: any[]) => void, context?: any): LSPluginUser
  • Add a one-time listener for a given event.

    Type parameters

    Parameters

    • event: T
    • fn: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any

    Returns LSPluginUser

  • ready(model?: any, callback?: any): Promise<void>
  • removeListener<T>(event: T, fn?: (...args: any[]) => void, context?: any, once?: boolean): LSPluginUser
  • Remove the listeners of a given event.

    Type parameters

    Parameters

    • event: T
    • Optional fn: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any
    • Optional once: boolean

    Returns LSPluginUser

  • resolveResourceFullUrl(filePath: string): string
  • setMainUIInlineStyle(style: Properties<0 | (string & {}), string & {}>): void
  • showMainUI(opts?: { autoFocus: boolean }): void
  • showSettingsUI(): void
  • toggleMainUI(): void
  • updateSettings(attrs: Record<string, any>): void

Generated using TypeDoc