Class QueryData

Defines set of search rules (e.g. auto-playlist is defined by QueryData), see dlgSearch for example

QueryData

Hierarchy (view full)

SharedMediaObject
- QueryData

Index

Constructors

constructor

Events

event_change event_destroying event_statuschange

Constructors

constructor

new QueryData(): QueryData
Returns QueryData
Inherited from SharedMediaObject.constructor

Properties

advancedSearch

advancedSearch: boolean

Undocumented

allFieldsList

allFieldsList: StringList

Gets all possible fields that can be used ('Album','Rating',...)

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)

collection

collection: string

Gets/Sets collection to be searched ('Entire Library', 'Music', 'Video',...)

collectionID

collectionID: number

Undocumented

conditions

conditions: QueryConditionList

Gets list of QueryCondition objects defining search rules, see dlgSearch for example

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

limitOrderIndex

limitOrderIndex: number

Undocumented

matchAllCriteria

matchAllCriteria: boolean

Undocumented

maxBytesEnabled

maxBytesEnabled: boolean

Undocumented

maxBytesValue

maxBytesValue: number

Undocumented

maxCountEnabled

maxCountEnabled: boolean

Undocumented

maxCountValue

maxCountValue: number

Undocumented

maxLenEnabled

maxLenEnabled: boolean

Undocumented

maxLenValue

maxLenValue: number

Undocumented

objectType

objectType: string

Gets the object type as string

persistentID

persistentID: string

Gets persistent id of the object

quickSearch

quickSearch: boolean

Undocumented

searchPhrase

searchPhrase: string

Gets/Sets phrase to be searched (e.g. when searching via search bar)

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

addNewCondition

addNewCondition(...params): QueryCondition
Parameters
- Rest ...params: any[]
Returns QueryCondition
Adds new QueryCondition to conditions list and returns
- Defined in src/types/Native.ts:5875

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

clear

clear(): void
Returns void
Undocumented
- Defined in src/types/Native.ts:5969

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

getAlbumList

getAlbumList(...params): AlbumList
Gets all albums fullfilling this query params
Parameters
- Rest ...params: any[]
Returns AlbumList
- Defined in src/types/Native.ts:5943

getAllLimitOrdersList

getAllLimitOrdersList(): StringList
Returns StringList
list of all possible limit orders
- Defined in src/types/Native.ts:5891

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

getAllSortOrdersList

getAllSortOrdersList(): StringList
Returns StringList
list of all possible sort orders
- Defined in src/types/Native.ts:5887

getClassName

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

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

getCopy

getCopy(): QueryData
Returns QueryData
Undocumented
- Defined in src/types/Native.ts:5851

getFieldList

getFieldList(includeFilter, excludeFilter): StringList
Parameters
- includeFilter: string
- excludeFilter: string
Returns StringList
Undocumented
- Defined in src/types/Native.ts:5883

getGenreList

getGenreList(...params): GenreList
Gets all genres fullfilling this query params
Parameters
- Rest ...params: any[]
Returns GenreList
- Defined in src/types/Native.ts:5956

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

getOrderString

getOrderString(): string
Returns string
sort string used in SQL
- Defined in src/types/Native.ts:5899

getPersistentJSON

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

getPersonList

getPersonList(...params): ArtistList
Gets persons fullfilling this query params
Parameters
- Rest ...params: any[]
Returns ArtistList
- Defined in src/types/Native.ts:5950

getPlaylists

getPlaylists(...params): PlaylistList
Gets all playlists fullfilling this query params
Parameters
- Rest ...params: any[]
Returns PlaylistList
- Defined in src/types/Native.ts:5968

getPodcastList

getPodcastList(...params): PodcastList
Gets all podcasts fullfilling this query params
Parameters
- Rest ...params: any[]
Returns PodcastList
- Defined in src/types/Native.ts:5962

getSortOrders

getSortOrders(): any
Returns any
JS array of currently set sort orders, see dlgSearch.js for examples
- Defined in src/types/Native.ts:5895

getTextAsync

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

getTracklist

getTracklist(...params): Tracklist
Gets list of files that fullfills this search criteria
Parameters
- Rest ...params: any[]
  content optional param to specify content e.g. {contentType: 'audio', fillPlayOrder: true}
```
var trcklist = QueryData.getTracklist();
trcklist.whenLoaded().then(function () {
    // all tracks are loaded here
});
```
Returns Tracklist
- Defined in src/types/Native.ts:5936

hasSameData

hasSameData(compQD): boolean
Parameters
- compQD: QueryData
Returns boolean
Undocumented
- Defined in src/types/Native.ts:5852

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

loadFromString

loadFromString(query): number
Parameters
- query: string
Returns number
Undocumented
- Defined in src/types/Native.ts:5850

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

resolveSortName

resolveSortName(value): string
Parameters
- value: string
Returns string
sort string used by QueryData
- Defined in src/types/Native.ts:5904

saveToString

saveToString(): string
Returns string
Undocumented
- Defined in src/types/Native.ts:5849

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

setSortOrders

setSortOrders(Value): void
Sets sort orders, it is JS array (see dlgSearch.js for examples)
Parameters
- Value: any
Returns void
- Defined in src/types/Native.ts:5910

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 QueryData

Hierarchy (view full)

Index

Constructors

Properties

Methods

Events

Constructors

constructor

Returns QueryData

Properties

advancedSearch

Undocumented

allFieldsList

asJSON

collection

collectionID

Undocumented

conditions

deleted

dontNotify

Undocumented

id

idColl

Undocumented

isObservable

isStatusBarSource

itemImageType

Undocumented

limitOrderIndex

Undocumented

matchAllCriteria

Undocumented

maxBytesEnabled

Undocumented

maxBytesValue

Undocumented

maxCountEnabled

Undocumented

maxCountValue

Undocumented

maxLenEnabled

Undocumented

maxLenValue

Undocumented

objectType

persistentID

quickSearch

Undocumented

searchPhrase

statusInfo

Undocumented

supportPin

title

Methods

addLink

Parameters

Returns Promise<any>

addNewCondition

Parameters

Returns QueryCondition

beginUpdate

Returns void

checkUpdate

Parameters

Returns void

clear

Returns void

Undocumented

doCut

Parameters

Returns Promise<any>

Undocumented

endUpdate

Returns boolean

getAlbumList

Parameters

Returns AlbumList

getAllLimitOrdersList

Returns StringList