PlayElement

Gets the ID.

getId(): string

Returns

string

---

Sets the ID.

setId(id): void

Parameters

Name	Type	Description
id	string	The ID.

---

Gets the design ID.

getDesignId(): string

Returns

string

---

Sets the design ID.

setDesignId(designId): void

Parameters

Name	Type	Description
designId	string	The design ID.

---

Gets the name.

getName(): string

Returns

string

---

Sets the name.

setName(name): void

Parameters

Name	Type	Description
name	string	The name.

---

Gets the description.

getDescription(): string

Returns

string

---

Sets the description.

setDescription(description): void

Parameters

Name	Type	Description
description	string	The description.

---

Gets the creation date.

getCreated(): Date | null

Returns

Date | null

---

Sets the creation date.

setCreated(created): void

Parameters

Name	Type	Description
created	Date	The creation date.

---

Gets the update date.

getUpdated(): Date | null

Returns

Date | null

---

Sets the update date.

setUpdated(updated): void

Parameters

Name	Type	Description
updated	Date	The update date.

---

Gets the publish state.

getPublishState(): PublishState

Returns

PublishState

---

Sets the publish state.

setPublishState(publishState): void

Parameters

Name	Type	Description
publishState	PublishState	The publish state.

---

Gets the thumbnail URL.

getThumbnailUrl(): string | null

Returns

string | null

---

Sets the thumbnail URL.

setThumbnailUrl(thumbnailUrl): void

Parameters

Name	Type	Description
thumbnailUrl	string	The thumbnail URL.

---

Gets the creator.

getCreator(): Creator

Returns

Creator

---

Sets the creator.

setCreator(creator): void

Parameters

Name	Type	Description
creator	Creator	The creator.

---

Gets the settings.

getSettings(): Settings

Returns

Settings

---

Sets the settings.

setSettings(settings): void

Parameters

Name	Type	Description
settings	Settings	The settings.

---

Gets the design.

getDesign(): Design

Returns

Design

---

Sets the design.

setDesign(design): void

Parameters

Name	Type	Description
design	Design	The design.

---

Gets the likes.

getLikes(): number

Returns

number

---

Sets the likes.

setLikes(likes): void

Parameters

Name	Type	Description
likes	number	The likes.

---

Gets the publish date.

getPublishAt(): Date | null

Returns

Date | null

---

Sets the publish date.

setPublishAt(publishAt): void

Parameters

Name	Type	Description
publishAt	Date	The publish date.

---

Gets the moderation state.

getModerationState(): number

Returns

number

---

Sets the moderation state.

setModerationState(moderationState): void

Parameters

Name	Type	Description
moderationState	number	The moderation state.

---

Gets the short code.

getShortCode(): string | null

Returns

string | null

---

Sets the short code.

setShortCode(shortCode): void

Parameters

Name	Type	Description
shortCode	string | null	The short code.

---

Gets the map rotation.

getMaps(): MapRotation

Returns

MapRotation

---

Sets the map rotation.

setMaps(maps): void

Parameters

Name	Type	Description
maps	MapRotation	The map rotation.

---

Populates the play element from a JSON object.

fromJSON(data): PlayElement

Parameters

Name	Type	Description
data	any	The JSON object.

Returns

PlayElement

---

Converts the play element to a JSON object.

toJSON(): any

Returns

any

---