Class BasePlaylist

The Document definition for a Playlist. Defines the DataSchema and common behaviors for a Playlist which are shared between both client and server.

mixes: PlaylistData
memberof: documents
param data: Initial data from which to construct the Playlist
param context: Construction context options

Hierarchy

Document
- BasePlaylist

Index

Constructors

constructor

Properties

metadata

Methods

Constructors

constructor

new BasePlaylist(): BasePlaylist

Inherited from Document.constructor
Returns BasePlaylist

Properties

Static metadata

metadata: any = ...

Default metadata which applies to each instance of this Document type.

Methods

Static defineSchema

defineSchema(): { _id: DocumentIdField; name: StringField; description: StringField; sounds: EmbeddedCollectionField; mode: NumberField; playing: BooleanField; fade: NumberField; folder: ForeignDocumentField; sorting: StringField; seed: NumberField; sort: IntegerSortField; ownership: DocumentOwnershipField; flags: ObjectField; _stats: DocumentStatsField }

inheritdoc
Returns { _id: DocumentIdField; name: StringField; description: StringField; sounds: EmbeddedCollectionField; mode: NumberField; playing: BooleanField; fade: NumberField; folder: ForeignDocumentField; sorting: StringField; seed: NumberField; sort: IntegerSortField; ownership: DocumentOwnershipField; flags: ObjectField; _stats: DocumentStatsField }
- _id: DocumentIdField
- name: StringField
- description: StringField
- sounds: EmbeddedCollectionField
- mode: NumberField
- playing: BooleanField
- fade: NumberField
- folder: ForeignDocumentField
- sorting: StringField
- seed: NumberField
- sort: IntegerSortField
- ownership: DocumentOwnershipField
- flags: ObjectField
- _stats: DocumentStatsField

Static migrateData

migrateData(data: any): any

inheritdoc
Parameters
- data: any
Returns any

Static shimData

shimData(data: any, options: any): any

inheritdoc
Parameters
- data: any
- options: any
Returns any