Class Collections

Collections

Hierarchy (view full)

SharedBase
- Collections

Constructors

constructor

new Collections(): Collections
Returns Collections
Inherited from SharedBase.constructor

Properties

statusInfo

statusInfo: Promise<any>

Undocumented

Methods

applyCollections

applyCollections(list): void
Apply list of collections (update them in DB).
Parameters
- list: CollectionList
  List of collections to apply
Returns void
- Defined in src/types/Native.ts:4021

assign

assign(collections): void
Assign data from another collections manager.
Parameters
- collections: Collections
  Source collections manager
Returns void
- Defined in src/types/Native.ts:3995

collectionExists

collectionExists(id): boolean
Check collection with specified ID exists.
Parameters
- id: number
  ID of the collection
Returns boolean
- Defined in src/types/Native.ts:4053

deleteCollection

deleteCollection(flt): void
Delete Collection.
Parameters
- flt: Collection
Returns void
- Defined in src/types/Native.ts:4001

getClassName

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

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

getCollection

getCollection(id): Collection
Get collection by its ID.
Parameters
- id: number
  ID of the collection to get
Returns Collection
- Defined in src/types/Native.ts:4034

getCollectionByType

getCollectionByType(colType): Collection
Gets collection by its content type.
Parameters
- colType: string
Returns Collection
- Defined in src/types/Native.ts:4041

getCollectionForObjectAsync

getCollectionForObjectAsync(obj): Promise<any>
Gets collection to which a given object belongs (e.g. track, artist, composer, genre, ...).
Parameters
- obj: SharedObject
Returns Promise<any>
- Defined in src/types/Native.ts:4074

getCollectionID

getCollectionID(Name): number
Get ID of a collection by given name.
Parameters
- Name: string
Returns number
- Defined in src/types/Native.ts:4067

getCollectionListAsync

getCollectionListAsync(params?): Promise<CollectionList>
Get list of all collections.
Parameters
- Optional params: {
      cacheIsEmpty?: boolean;
      cacheVisibility?: boolean;
      includeEntireLibrary?: boolean;
  }
  - Optional cacheIsEmpty?: boolean
    Undocumented
  - Optional cacheVisibility?: boolean
    Undocumented
  - Optional includeEntireLibrary?: boolean
    Undocumented
Returns Promise<CollectionList>
- Defined in src/types/Native.ts:4015

getCollectionName

getCollectionName(id): string
Get name of a collection with specified name
Parameters
- id: number
  ID of the collection
Returns string
- Defined in src/types/Native.ts:4060

getCopy

getCopy(): Collections
Gets copy of a collections manager.

Returns Collections
- Defined in src/types/Native.ts:3989

getEntireLibrary

getEntireLibrary(): Collection
Gets 'Entire Library' collection

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

getMusicCollectionID

getMusicCollectionID(): number
Get ID of a collection with type 'music'.

Returns number
- Defined in src/types/Native.ts:4080

getNewCollection

getNewCollection(): Collection
Create new, empty collection.

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

isPodcastCollection

isPodcastCollection(id): boolean
Check collection is a type 'podcast'.
Parameters
- id: number
  ID of a collection
Returns boolean
- Defined in src/types/Native.ts:4094

isVideoCollection

isVideoCollection(id): boolean
Check collection is a type 'video'.
Parameters
- id: number
  ID of a collection
Returns boolean
- Defined in src/types/Native.ts:4087

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

notifyChange

notifyChange(): void
Returns void
Undocumented
- Defined in src/types/Native.ts:3983

refreshAll

refreshAll(): void
Refresh all collections.

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

saveAllCollectionsAsync

saveAllCollectionsAsync(list): Promise<any>
Save all collections to database.
Parameters
- list: CollectionList
  List of collections to apply
Returns Promise<any>
- Defined in src/types/Native.ts:4007

Events

event_change

event_change: (() => void)

Type declaration

- (): void
- Returns void