Class AlbumsGroupParent

Undocumented

Hierarchy

SharedMediaObject
- AlbumsGroupParent
  - AlbumsGroup

Constructors

constructor

new AlbumsGroupParent(): AlbumsGroupParent
Returns AlbumsGroupParent

Inherited from SharedMediaObject.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

id

id: number

Gets integer id of the object

idColl

idColl: number

Undocumented

isObservable

isObservable: boolean

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

isStatusBarSource

isStatusBarSource: boolean

Is source for status bar informations.

itemImageType

itemImageType: string

Undocumented

objectType

objectType: string

Gets the object type as string

persistentID

persistentID: string

Gets persistent id of the object

statusInfo

statusInfo: Promise<any>

Undocumented

supportPin

supportPin: boolean

Whether object support pin to pinned list

title

title: string

Gets the object title

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>
Inherited from SharedMediaObject.addLink
- Defined in src/types/Native.ts:980

beginUpdate

beginUpdate(): void
Lock object to update state. Events are not called when in update state.

Returns void
Inherited from SharedMediaObject.beginUpdate
- Defined in src/types/Native.ts:276

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
Inherited from SharedMediaObject.checkUpdate
- Defined in src/types/Native.ts:288

doCut

doCut(data): Promise<any>
Undocumented
Parameters
- data: Base
Returns Promise<any>
Inherited from SharedMediaObject.doCut
- Defined in src/types/Native.ts:213

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
Inherited from SharedMediaObject.endUpdate
- Defined in src/types/Native.ts:282

getAllLinksList

getAllLinksList(): ExternalLinksList
Get all external object links (acoustID, musicbrainz, wikipedia etc.)

Returns ExternalLinksList
Inherited from SharedMediaObject.getAllLinksList
- Defined in src/types/Native.ts:953

getCachedThumb

getCachedThumb(dimX, dimY): string
Undocumented
Parameters
- dimX: number
- dimY: number
Returns string
- Defined in src/types/Native.ts:2589

getClassName

getClassName(): string
Gets class name of the object.

Returns string
Inherited from SharedMediaObject.getClassName
- Defined in src/types/Native.ts:198

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
Inherited from SharedMediaObject.getLinksList
- Defined in src/types/Native.ts:971

getPersistentJSON

getPersistentJSON(): string
Undocumented

Returns string
Inherited from SharedMediaObject.getPersistentJSON
- Defined in src/types/Native.ts:214

getThumbAsync

getThumbAsync(...params): number
Undocumented
Parameters
- Rest ...params: any[]
Returns number
- Defined in src/types/Native.ts:2590

isMarked

isMarked(id): boolean
Undocumented
Parameters
- id: number
Returns boolean
Inherited from SharedMediaObject.isMarked
- Defined in src/types/Native.ts:212

isPinned

isPinned(): Promise<any>
Object is pinned in pinned list

Returns Promise<any>
Inherited from SharedMediaObject.isPinned
- Defined in src/types/Native.ts:940

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
Inherited from SharedMediaObject.locked
- Defined in src/types/Native.ts:192

modifyAsync

modifyAsync(...params): Promise<any>
Call defined method with the item locked for modifications.
Parameters
- Rest ...params: any[]
Returns Promise<any>
Inherited from SharedMediaObject.modifyAsync
- Defined in src/types/Native.ts:262

notifyChanged

notifyChanged(...params): void
Notifies that the object was changed (e.g. to force visual update etc.)
Parameters
- Rest ...params: any[]
Returns void
Inherited from SharedMediaObject.notifyChanged
- Defined in src/types/Native.ts:308

removeLink

removeLink(...params): Promise<any>
Remove external link from object.
Parameters
- Rest ...params: any[]
Returns Promise<any>
Inherited from SharedMediaObject.removeLink
- Defined in src/types/Native.ts:989

setMarked

setMarked(id, value): void
Undocumented
Parameters
- id: number
- value: boolean
Returns void
Inherited from SharedMediaObject.setMarked
- Defined in src/types/Native.ts:211

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
Inherited from SharedMediaObject.setPinned
- Defined in src/types/Native.ts:947

toString

toString(): string
Undocumented

Returns string
Inherited from SharedMediaObject.toString
- Defined in src/types/Native.ts:264

toUriString

toUriString(): string
Undocumented

Returns string
Inherited from SharedMediaObject.toUriString
- Defined in src/types/Native.ts:263

updateStatus

updateStatus(): void
Undocumented

Returns void
Inherited from SharedMediaObject.updateStatus
- Defined in src/types/Native.ts:297

Events

event_change

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

Type declaration

- (changeType, ...additionalArgs): void
- Event is called when object is somehow changed
  
  See App.listen
  
  Example
```
app.listen(object, 'change', (changeType) => {  });
```
  Parameters
  - changeType: string
    
    additional change type (can have values like 'tracklist', 'deleted', 'title' or undefined)
  - Rest ...additionalArgs: any[]
  Returns void

event_destroying

event_destroying: (() => void)

Type declaration

- (): void
- Event is called when object is going to destroy
  
  See App.listen
  
  Returns void

event_statuschange

event_statuschange: (() => void)

Type declaration

- (): void
- Event is called when status info of the object is changed
  
  See App.listen
  
  Returns void

Class AlbumsGroupParent

Undocumented

Hierarchy

Index

Constructors

Properties

Methods

Events

Constructors

constructor

Returns AlbumsGroupParent

Properties

asJSON

deleted

dontNotify

Undocumented

id

idColl

Undocumented

isObservable

isStatusBarSource

itemImageType

Undocumented

objectType

persistentID

statusInfo

Undocumented

supportPin

title

Methods

addLink

Parameters

linkType: string

linkInfo: string

link: string

Returns Promise<any>

beginUpdate

Returns void

checkUpdate

Parameters

interval: number

Returns void

doCut

Undocumented

Parameters

data: Base

Returns Promise<any>

endUpdate

Returns boolean

getAllLinksList

Returns ExternalLinksList

getCachedThumb

Undocumented

Parameters

dimX: number

dimY: number

Returns string

getClassName

Returns string

getLinksList

Parameters

Rest ...params: any[]

Returns ExternalLinksList

getPersistentJSON

Undocumented

Returns string

getThumbAsync

Undocumented

Parameters

Rest ...params: any[]

Returns number

isMarked

Undocumented

Parameters

id: number

Returns boolean

isPinned

Returns Promise<any>

locked

Parameters

`Rest` ...params: any[]

`Rest` ...params: any[]

`Rest` ...params: any[]

`Rest` ...params: any[]

`Rest` ...params: any[]

`Rest` ...additionalArgs: any[]