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