Site

Extends

AbstractEntity

class Site extends AbstractEntity

Static

create

static create(json = null): Site

Parameters:

Name	Type	Required	Default	Description
json	null | object	No	null	Used to constructor from a JSON representation. See fromJSON

Returns:

Type: Site

getName

static getName(): "Site"

Returns:

Type: constant ("Site": string)

Constructor

constructor

constructor(json = null): Site

Parameters:

Name	Type	Required	Default	Description
json	null | object	No	null	Used to constructor from a JSON representation. See fromJSON

Properties

address

Type	Default	Description
string | null	null

city

Type	Default	Description
string | null	null

client_id

Type	Default	Description
string | null	null

cp

Type	Default	Description
string | null	null

created_at

Type	Default	Description
Date | null	null

Read-Only

description

Type	Default	Description
string | null	null

direction

Type	Default	Description
string | null	null

email

Type	Default	Description
string | null	null

gps_positions

Type	Default	Description
Set<{x: number, y: number, z: number, latitude: number, longitude: number, altitude: number}>	new Set()

gps_transform

Type	Default	Description
Set<number>	new Set()

gps_translate

Type	Default	Description
Set<number>	new Set()

id

Type	Default	Description
null | int | symbol	null	The entity identifier

languages

Type	Default	Description
Set<string>	new Set()

locale

Type	Default	Description
string | null	null

logo

Type	Default	Description
Reference<File>	new Reference('File', null)

name

Type	Default	Description
string | null	null

metadata

Type	Default	Description
Map	new Map()

opening

Type	Default	Description
string | null	null

phone

Type	Default	Description
string | null	null

signature

Type	Default	Description
string | null	null

target_platforms

Type	Default	Description
Set<string>	new Set()

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
address	string | null
city	string | null
client_id	string | null
cp	string | null
created_at	string | null	Datetime in ISO 8601 format
description	string | null
direction	string | null
email	string | null
gps_position	Array<{ x: number, y: number, z: number, longitude: number, latitude: number, altitude: number }>
gps_transform	Array<number>
gps_translate	Array<number>
id	int | symbol | null
languages	Array<string>
locale	string | null
logo	int | symbol | null
name	string | null
metadata	object
opening	string | null
phone	string | null
signature	string | null
target_platforms	Array<string>
updated_at	string | null	Datetime in ISO 8601 format
version	int | null

fromJSON

fromJSON(json: object): Site

Parameters:

Name	Type	Required	Default	Description
json	object	Yes	-
json.address	string | null	No	null
json.city	string | null	No	null
json.client_id	string | null	No	null
json.cp	string | null	No	null
json.created_at	string | null	No	null	Datetime in ISO 8601 format
json.description	string | null	No	null
json.direction	string | null	No	null
json.email	string | null	No	null
json.gps_position	Array<{ x: number, y: number, z: number, longitude: number, latitude: number, altitude: number }>	No	[]
json.gps_transform	Array<number>	No	[]
json.gps_translate	Array<number>	No	[]
json.id	int | symbol | null	No	null
json.languages	Array<string>	No	[]
json.locale	string | null	No	null
json.logo	int | symbol | null	No	null
json.name	string | null	No	null
json.metadata	object	No	{}
json.opening	string | null	No	null
json.phone	string | null	No	null
json.signature	string | null	No	null
json.target_platforms	Array<string>	No	[]
json.updated_at	string | null	No	null	Datetime in ISO 8601 format
json.version	int | null	No	null

Returns:

Returns this

clone

clone(): Site

Returns:

A new deep copy

Type: Site