Class SharedDrive

SharedDrive class

SharedDrive

Hierarchy (view full)

Constructors

constructor

Properties

asJSON deleted dontNotify driveLetter driveType folderMediaType hasSubfolders icon id idColl isEmpty isObservable isPlaylist isStatusBarSource isTemporary itemImageType mediaType monitorChanges monitorContinous monitorStartup objectType path persistentID serialNumber statusInfo supportPin tag title volumeLabel

Methods

addLink beginUpdate checkUpdate commit createFolder doCut endUpdate getAllLinksList getClassName getFileList getFolderList getIcon getLinksList getPathAsync getPersistentJSON getSharedFolder getTracklist isMarked isPinned locked modifyAsync notifyChanged removeLink setMarked setPinned toString toUriString updateHasSubfoldersAsync updateStatus

Events

event_change event_destroying event_statuschange

Constructors

constructor

Properties

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)

deleted

deleted: boolean

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

dontNotify

dontNotify: boolean

Undocumented

driveLetter

driveLetter: string

Drive letter

driveType

driveType: string

Drive type string property ('optical_drive', 'drive')

folderMediaType

folderMediaType: number

Gets/sets media type of the folder

hasSubfolders

hasSubfolders: boolean

Gets/sets whether the folder has subfolders

icon

icon: string

Gets/Sets icon of this folder.

id

id: number

Gets integer id of the object

idColl

idColl: number

Undocumented

isEmpty

isEmpty: boolean

Returns true if media isn't inserted (e.g. for optical CD drives)
NOTE: Introduced in 5.0.4

isObservable

isObservable: boolean

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

isPlaylist

isPlaylist: boolean

Gets whether the folder is actually M3U/PLA playlist

isStatusBarSource

isStatusBarSource: boolean

Is source for status bar informations.

isTemporary

isTemporary: boolean

Undocumented

itemImageType

itemImageType: string

Undocumented

mediaType

mediaType: number

Media type integer property (returning integer values from https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-getdrivetypea )
e.g. DRIVE_FIXED = 3
NOTE: Added in version 5.0.4

monitorChanges

monitorChanges: boolean

Gets/sets the folder to be monitored for changes

monitorContinous

monitorContinous: boolean

Gets/sets the folder to be monitored continuously

monitorStartup

monitorStartup: boolean

Gets/sets the folder to be monitored on startup

objectType

objectType: string

Gets the object type as string

path

path: string

Gets/Sets path of this folder.

persistentID

persistentID: string

Gets persistent id of the object

serialNumber

serialNumber: number

Serial numbrer

statusInfo

statusInfo: Promise<any>

Undocumented

supportPin

supportPin: boolean

Whether object support pin to pinned list

tag

tag: any

Temporary JS objects can be attached here

title

title: string

Gets/Sets title of this folder.

volumeLabel

volumeLabel: string

Drive label

Methods

addLink

  • addLink(linkType, linkInfo, link): Promise<any>

  • Add new external list associated with object.

    Parameters

    • linkType: string

      Type of a link

    • linkInfo: string

      Link information (like release or releaseGroup for musicbrainz link)

    • link: string

      Link string

    Returns Promise<any>

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

commit

  • commit(): void

  • Returns void

    Undocumented

createFolder

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

getAllLinksList

getClassName

  • getClassName(): string

  • Gets class name of the object.

    Returns string

getFileList

  • getFileList(recursive): StringList

  • Gets list of individual files as string list NOTE: Introduced in version 5.0.4

    Parameters

    • recursive: boolean

      If true then lists files contained even within sub-folders

    Returns StringList

    list of files

    Example

    var list = folder.getFileList( true {recursive});
    await list.whenLoaded();
    // all files are loaded here

getFolderList

getIcon

  • getIcon(): string

  • Returns string

    Undocumented

getLinksList

  • getLinksList(...params): ExternalLinksList

  • Get external link associated with the object. All link identifiers are (updated list is available in consts.js) : var LINK_MUSICBRAINZ = 'musicbrainz', LINK_ACOUSTID = 'acoustid', LINK_TVDB = 'tvdb', LINK_MAZE = 'maze', LINK_IMDB = 'imdb', LINK_WIKI = 'wiki', LINK_ECHOPRINT = 'echoprint', LINK_MOVIEDB = 'moviedb', LINK_DISCOGS = 'discogs';

    Parameters

    • Rest ...params: any[]

    Returns ExternalLinksList

getPathAsync

  • getPathAsync(): Promise<any>

  • Gets path of this folder asynchronously

    Returns Promise<any>

getPersistentJSON

getSharedFolder

getTracklist

  • getTracklist(...params): Tracklist

  • Gets tracks of this folder

    Parameters

    • Rest ...params: any[]

    Returns Tracklist

    Example

    var trcklist = folder.getTracklist();
    trcklist.whenLoaded().then(function () {
        // all tracks are loaded here
    });

isMarked

  • isMarked(id): boolean

  • Parameters

    • id: number

    Returns boolean

    Undocumented

isPinned

  • isPinned(): Promise<any>

  • Object is pinned in pinned list

    Returns Promise<any>

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

removeLink

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

  • Remove external link from object.

    Parameters

    • Rest ...params: any[]

    Returns Promise<any>

setMarked

  • setMarked(id, value): void

  • Parameters

    • id: number
    • value: boolean

    Returns void

    Undocumented

setPinned

  • setPinned(pinned, collID): void

  • Set object is pinned in pinned list.

    Parameters

    • pinned: boolean

      Object is pinned

    • collID: number

      ID of collection where object is pinned

    Returns void

toString

  • toString(): string

  • Returns string

    Undocumented

toUriString

  • toUriString(): string

  • Returns string

    Undocumented

updateHasSubfoldersAsync

  • updateHasSubfoldersAsync(): Promise<any>

  • Updates hasSubfolders value based on current file system state
    NOTE: Added in 5.0.4

    Returns Promise<any>

    Since

    5.0.4

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