Playlist
Extends
AbstractEntity
class Playlist extends AbstractEntity
Static
create
static create(json = null): Playlist
Parameters:
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| json | null | object | No | null | Used to constructor from a JSON representation. See fromJSON |
Returns:
Type: Playlist
getName
static getName(): "Playlist"
Returns:
Type: constant ("Playlist": string)
Constructor
constructor
constructor(json = null): Playlist
Parameters:
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| json | null | object | No | null | Used to constructor from a JSON representation. See fromJSON |
Properties
created_at
| Type | Default | Description |
|---|---|---|
| Date | null | null |
client_id
| Type | Default | Description |
|---|---|---|
| string | null | null |
description
| Type | Default | Description |
|---|---|---|
| string | null |
id
| Type | Default | Description |
|---|---|---|
| null | int | symbol | null | The entity identifier |
medias
| Type | Default | Description |
|---|---|---|
| OrderedCollection<Media> | new OrderedCollection('Media') |
metadata
| Type | Default | Description |
|---|---|---|
| Map | new Map() |
name
| Type | Default | Description |
|---|---|---|
| string | null |
parameters
| Type | Default | Description |
|---|---|---|
| Set<string> | new Set() |
signature
| Type | Default | Description |
|---|---|---|
| string | null | null |
site
| Type | Default | Description |
|---|---|---|
| Reference<Site> | new Reference('Site', null) |
tags
| Type | Default | Description |
|---|---|---|
| Collection<Tag> | new Collection('Tag') |
updated_at
| Type | Default | Description |
|---|---|---|
| Date | null | null |
Read-Only
version
| Type | Default | Description |
|---|---|---|
| int | null |
Read-Only
Methods
toJSON
toJSON(): object
Returns:
Type: object (see properties bellow)
| Name | Type | Description |
|---|---|---|
| created_at | string | null | |
| client_id | string | null | |
| description | string | null | |
| id | int | symbol | null | |
| medias | Array<{id: int | symbol, position: int}> | |
| metadata | object | |
| name | string | null | |
| parameters | string[] | |
| signature | string | null | |
| site | int | symbol | null | |
| tags | Array< int | symbol > | |
| updated_at | string | null | |
| version | int |
fromJSON
fromJSON(json: object): Playlist
Parameters:
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| json | object | Yes | - | |
| json.created_at | string | null | No | null | Datetime in ISO 8601 format |
| json.client_id | string | null | No | null | |
| json.description | string | null | No | null | |
| json.id | int | symbol | null | No | null | |
| json.medias | Array<{id: int | symbol, position: int}> | No | [] | |
| json.metadata | object | No | {} | |
| json.name | string | null | No | null | |
| json.parameters | string[] | No | [] | |
| json.signature | string | null | No | null | |
| json.site | int | symbol | null | No | null | |
| json.tags | Array< int | symbol > | No | [] | |
| json.updated_at | string | null | No | null | Datetime in ISO 8601 format |
| json.version | int | No | null |
Returns:
Returns this
clone
clone(): Playlist
Returns:
A new deep copy
Type: Playlist