Class Collection

Collection

Hierarchy (view full)

SharedMediaObject
- Collection

Index

Constructors

constructor

Events

event_change event_destroying event_statuschange

Constructors

constructor

new Collection(): Collection
Returns Collection
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)

collectionCond

collectionCond: string

Gets/Sets collection query condition in the old INI format

criteriaJSON

criteriaJSON: string

Gets/Sets collection query condition in the new JSON portable and human readable format

deleted

deleted: boolean

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

description

description: string

Gets/Sets description of the collection.

dontNotify

dontNotify: boolean

Undocumented

icon

icon: string

Icon name of the collection.

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

name

name: string

Gets/Sets name of the collection.

objectType

objectType: string

Gets the object type as string

persistentID

persistentID: string

Gets persistent id of the object

pos

pos: number

Gets/Sets position order of the collection node in media tree.

queryData

queryData: QueryData

Gets queryData of the collection.

statusInfo

statusInfo: Promise<any>

Undocumented

supportPin

supportPin: boolean

Whether object support pin to pinned list

title

title: string

Gets the object title

visibleInMainTree

visibleInMainTree: number

Gets/Sets visibility of the collection in media tree. It can be one of the value: 0 - invisible (false) 1 - visible (true) 2 - visible if not empty

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

assignFrom

assignFrom(data): void
Assign internal data from collection.
Parameters
- data: Collection
Returns void
- Defined in src/types/Native.ts:3800

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

commitAsync

commitAsync(): Promise<any>
Save collection to database.

Returns Promise<any>
- Defined in src/types/Native.ts:3810

doCut

doCut(data): Promise<any>
Parameters
- data: Base
Returns Promise<any>
Undocumented
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

fillSharedViewList

fillSharedViewList(): CollectionList
Gets list of collections sharing same view.

Returns CollectionList
- Defined in src/types/Native.ts:3823

getAlbumArtistList

getAlbumArtistList(): ArtistList
Get ArtistList based on collection filter. Returns album artists only.

Returns ArtistList
- Defined in src/types/Native.ts:3933

getAlbumList

getAlbumList(...params): AlbumList
Get AlbumList based on collection filter.
Parameters
- Rest ...params: any[]
Returns AlbumList
- Defined in src/types/Native.ts:3921

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

getArtistList

getArtistList(): ArtistList
Get ArtistList based on collection filter.

Returns ArtistList
- Defined in src/types/Native.ts:3927

getArtistOnlyList

getArtistOnlyList(): ArtistList
Get ArtistList based on collection filter. Returns artists only (contributing artists).

Returns ArtistList
- Defined in src/types/Native.ts:3939

getCachedIsEmpty

getCachedIsEmpty(): boolean
Get cached empty of the collection.

Returns boolean
- Defined in src/types/Native.ts:3841

getCachedIsVisible

getCachedIsVisible(): boolean
Get cached visible status of the collection.

Returns boolean
- Defined in src/types/Native.ts:3835

getClassName

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

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

getCollectionQueryAsync

getCollectionQueryAsync(): Promise<any>
Returns Promise<any>
Undocumented
- Defined in src/types/Native.ts:3884

getCopy

getCopy(): Collection
Get copy of the collection.

Returns Collection
Collection
- Defined in src/types/Native.ts:3794

getDecades

getDecades(...params): DecadeList
Get decade list.
Parameters
- Rest ...params: any[]
Returns DecadeList
- Defined in src/types/Native.ts:3966

getGenreCategories

getGenreCategories(categories): SharedUIList<GenreCategory>
Parameters
- categories: StringList
Returns SharedUIList<GenreCategory>
Undocumented
- Defined in src/types/Native.ts:3952

getGenreList

getGenreList(): GenreList
Get GenreList based on collection filter.

Returns GenreList
- Defined in src/types/Native.ts:3951

getIgnoreFlag

getIgnoreFlag(): boolean
Returns boolean
Undocumented
- Defined in src/types/Native.ts:3817

getIsVisibleAsync

getIsVisibleAsync(): Promise<any>
Get visible status of the collection.

Returns Promise<any>
- Defined in src/types/Native.ts:3829

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
Returns string
Undocumented
Inherited from SharedMediaObject.getPersistentJSON
- Defined in src/types/Native.ts:214

getPersonList

getPersonList(...params): ArtistList
Get PersonList (ArtistList) based on collection filter and person type.
Parameters
- Rest ...params: any[]
Returns ArtistList
- Defined in src/types/Native.ts:3947

getRating

getRating(rating): RatingItem
Get Rating | rating class based on collection filter and specified rating. Rating should be a value between 0 and 100 where 0 is unknown and 100 is 5 stars.
Parameters
- rating: number
  Rating value
Returns RatingItem
- Defined in src/types/Native.ts:3959

getTracklist

getTracklist(...params): Tracklist
Get tracklist based on collection filter.
Parameters
- Rest ...params: any[]
Returns Tracklist
- Defined in src/types/Native.ts:3914

getType

getType(): string
Get type of a collection. Known types are: music, podcast, videopodcast, audiobook, classicalmusic, musicvideo, video, tv, mixed

Returns string
- Defined in src/types/Native.ts:3848

getYear

getYear(year): Year
Parameters
- year: number
Returns Year
Undocumented
- Defined in src/types/Native.ts:3967

hasVideoContent

hasVideoContent(): boolean
Collection has video content.

Returns boolean
- Defined in src/types/Native.ts:3805

isMarked

isMarked(id): boolean
Parameters
- id: number
Returns boolean
Undocumented
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

setDeleteFlag

setDeleteFlag(): void
Mark collection as to be deleted.

Returns void
- Defined in src/types/Native.ts:3815

setIgnoreFlag

setIgnoreFlag(): void
Returns void
Undocumented
- Defined in src/types/Native.ts:3816

setMarked

setMarked(id, value): void
Parameters
- id: number
- value: boolean
Returns void
Undocumented
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
Returns string
Undocumented
Inherited from SharedMediaObject.toString
- Defined in src/types/Native.ts:264

toUriString

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

updateStatus

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

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

Class Collection

Hierarchy (view full)

Index

Constructors

Properties

Methods

Events

Constructors

constructor

Returns Collection

Properties

asJSON

collectionCond

criteriaJSON

deleted

description

dontNotify

Undocumented

icon

id

idColl

Undocumented

isObservable

isStatusBarSource

itemImageType

Undocumented

name

objectType

persistentID

pos

queryData

statusInfo

Undocumented

supportPin

title

visibleInMainTree

Methods

addLink

Parameters

Returns Promise<any>

assignFrom

Parameters

Returns void

beginUpdate

Returns void

checkUpdate

Parameters

Returns void

commitAsync

Returns Promise<any>

doCut

Parameters

Returns Promise<any>

Undocumented

endUpdate

Returns boolean

fillSharedViewList

Returns CollectionList

getAlbumArtistList

Returns ArtistList

getAlbumList

Parameters

Returns AlbumList

getAllLinksList

Returns ExternalLinksList

getArtistList

Returns ArtistList

getArtistOnlyList

Returns ArtistList

getCachedIsEmpty

Returns boolean

getCachedIsVisible

Returns boolean

getClassName

Returns string

getCollectionQueryAsync

Returns Promise<any>

Undocumented

getCopy

Returns Collection