Class Addon

Undocumented

Hierarchy (view full)

Constructors

constructor

Properties

archiveType asJSON author configFile deleted description dontNotify downloadUrl ext_id hasConfig id infoJSON installType installing isObservable isStatusBarSource isTrial isValid license maxAppVersion minAppVersion objectType path persistentID reloadRequiredInstall reloadRequiredUninstall remainingTrialDays required showRestartPrompt skinOptions statusInfo title uninstalled updateInfo validationResult version

Methods

beginUpdate checkUpdate doCut endUpdate getClassName getIconAsync getPersistentJSON isMarked locked modifyAsync notifyChanged setMarked toJSON toString toUriString updateStatus

Events

event_change event_destroying event_statuschange

Constructors

constructor

Properties

archiveType

archiveType: string

Undocumented

asJSON

asJSON: string

Gets the object as serialized JSON string. Or sets serialized JSON (to fill this object's metadata by the metadata included within the JSON)

author

author: string

Undocumented

configFile

configFile: string

Undocumented

deleted

deleted: boolean

Set to true after deletion so that 'change' event is called and item is removed from UI lists.

description

description: string

Undocumented

dontNotify

dontNotify: boolean

Undocumented

downloadUrl

downloadUrl: string

Undocumented

ext_id

ext_id: string

Undocumented

hasConfig

hasConfig: boolean

Undocumented

id

id: number

Gets integer id of the object

infoJSON

infoJSON: string

Undocumented

installType

installType: string

Undocumented

installing

installing: boolean

Undocumented

isObservable

isObservable: boolean

Whether this object can be listened (e.g. for 'change' event)

isStatusBarSource

isStatusBarSource: boolean

Is source for status bar informations.

isTrial

isTrial: boolean

Undocumented

isValid

isValid: boolean

Undocumented

license

license: string

Undocumented

maxAppVersion

maxAppVersion: string

Undocumented

minAppVersion

minAppVersion: string

Undocumented

objectType

objectType: string

Gets the object type as string

path

path: string

Undocumented

persistentID

persistentID: string

Gets persistent id of the object

reloadRequiredInstall

reloadRequiredInstall: boolean

Undocumented

reloadRequiredUninstall

reloadRequiredUninstall: boolean

Undocumented

remainingTrialDays

remainingTrialDays: number

Undocumented

required

required: boolean

Undocumented

showRestartPrompt

showRestartPrompt: boolean

Undocumented

skinOptions

skinOptions: string

Undocumented

statusInfo

statusInfo: Promise<any>

Undocumented

title

title: string

Undocumented

uninstalled

uninstalled: boolean

Undocumented

updateInfo

updateInfo: string

Undocumented

validationResult

validationResult: string

Undocumented

version

version: string

Undocumented

Methods

beginUpdate

  • beginUpdate(): void

  • Lock object to update state. Events are not called when in update state.

    Returns void

checkUpdate

  • checkUpdate(interval): void

  • Updates the object every X ms when called periodically. Useful e.g. when filling lists. Can be used only in the update lock! (i.e. between beginUpdate/endUpdate)

    Parameters

    • interval: number

    Returns void

doCut

  • doCut(data): Promise<any>

  • Parameters

    Returns Promise<any>

    Undocumented

endUpdate

  • endUpdate(): boolean

  • Unlock object from update state. beginUpdate and endUpdate must be in pair. When endUpdate is called, change event is called.

    Returns boolean

getClassName

  • getClassName(): string

  • Gets class name of the object.

    Returns string

getIconAsync

  • getIconAsync(): Promise<any>

  • Returns Promise<any>

    Undocumented

getPersistentJSON

isMarked

  • isMarked(id): boolean

  • Parameters

    • id: number

    Returns boolean

    Undocumented

locked

  • locked(func): void

  • Call defined method with locked data so user can access them.

    Parameters

    • func: (() => any)

      Method to call

        • (): any

        • Returns any

    Returns void

modifyAsync

  • modifyAsync(...params): Promise<any>

  • Call defined method with the item locked for modifications.

    Parameters

    • Rest ...params: any[]

    Returns Promise<any>

notifyChanged

  • notifyChanged(...params): void

  • Notifies that the object was changed (e.g. to force visual update etc.)

    Parameters

    • Rest ...params: any[]

    Returns void

setMarked

  • setMarked(id, value): void

  • Parameters

    • id: number
    • value: boolean

    Returns void

    Undocumented

toJSON

  • toJSON(async, fast): string

  • Parameters

    Returns string

    Undocumented

toString

toUriString

updateStatus

Events

event_change

event_change: ((changeType, ...additionalArgs) => void)

Event is called when object is somehow changed

See App.listen

Type declaration

    • (changeType, ...additionalArgs): void

    • Parameters

      • changeType: string

        additional change type (can have values like 'tracklist', 'deleted', 'title' or undefined)

      • Rest ...additionalArgs: any[]

      Returns void

Example

app.listen(object, 'change', (changeType) => {  });

event_destroying

event_destroying: (() => void)

Event is called when object is going to destroy

See App.listen

Type declaration

    • (): void

    • Returns void

event_statuschange

event_statuschange: (() => void)

Event is called when status info of the object is changed

See App.listen

Type declaration

    • (): void

    • Returns void

Download
Forum
Support
Addons
Develop

Settings

Member Visibility

Theme

© 2000-2024 Ventis Media Inc.Generated using TypeDoc