Person

Extends

Poi

class Person extends Poi

Table of Contents

Static

create

static create(json = null): Person

Parameters:

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

Returns:

Type: Person

getName

static getName(): string

Returns:

Type: constant ("Person": string)

Constructor

constructor

constructor(json = null): Person

Person is abstract and cannot be instantiated

Parameters:

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

Properties

desk_phone

Type	Default	Description
string | null	null

firstname

Type	Default	Description
string | null	null

lastname

Type	Default	Description
string | null	null

mobile_phone

Type	Default	Description
string | null	null

Overwritten Properties

type

Type	Default	Description
enum(POI_TYPES)	POI_TYPES.PERSON

Read-Only

Inherited Properties

categories

Type	Default	Description
Collection<Category>	new Collection('Category')

children

Type	Default	Description
OrderedCollection<Poi>	new OrderedCollection('Poi')

client_id

Type	Default	Description
string | null	null

created_at

Type	Default	Description
Date | null	null

Read-Only

custom_objects

Type	Default	Description
Collection<CustomObject>	new Collection('CustomObject')

description

Type	Default	Description
string | null	null

id

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

logos

Type	Default	Description
OrderedCollection<File>	new OrderedCollection('File')

medias

Type	Default	Description
OrderedCollection<Media>	new OrderedCollection('Media')

metadata

Type	Default	Description
Map	new Map()

name

Type	Default	Description
string	null

new

Type	Default	Description
boolean	true

parents

Type	Default	Description
Collection<Poi>	new Collection('Poi')

pictures

Type	Default	Description
OrderedCollection<File>	new OrderedCollection('File')

places

Type	Default	Description
Collection<Place>	new Collection('Place')

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
categories	Array<int | symbol>
children	Array<{id: int | symbol, position: int}>
client_id	string | null
created_at	string | null	Datetime in ISO 8601 format
custom_objects	Array<int | symbol>
description	null | string
id	null | int | symbol
logos	Array<{id: int | symbol, position: int}>
medias	Array<{id: int | symbol, position: int}>
metadata	object
name	string | null
new	boolean
parents	Array<int | symbol>
pictures	Array<{id: int | symbol, position: int}>
places	Array<int | symbol>
signature	string | null
site	null | int | symbol
tags	Array<int | symbol>
type	string | null
updated_at	string | null	Datetime in ISO 8601 format
version	int | null
desk_phone	null | string
firstname	null | string
lastname	null | string
mobile_phone	null | string

fromJSON

fromJSON(json: object): Person

Parameters:

Name	Type	Required	Default	Description
json	object	Yes	-
json.categories	Array<int | symbol>	No	[]
json.children	Array<{id: int | symbol, position: int}>	No	[]
json.client_id	string | null	No	null
json.created_at	string | null	No	null	Datetime in ISO 8601 format
json.custom_objects	Array<int | symbol>	No	[]
json.description	null | string	No	null
json.id	null | int | symbol	No	null
json.logos	Array<{id: int | symbol, position: int}>	No	[]
json.medias	Array<{id: int | symbol, position: int}>	No	[]
json.metadata	object	No	{}
json.name	string | null	No	null
json.new	boolean	No	true
json.parents	Array<int | symbol>	No	[]
json.pictures	Array<{id: int | symbol, position: int}>	No	[]
json.places	Array<int | symbol>	No	[]
json.signature	string | null	No	null
json.site	null | int | symbol	No	null
json.tags	Array<int | symbol>	No	[]
json.type	string | null	No	null
json.updated_at	string | null	No	null	Datetime in ISO 8601 format
json.version	int | null	No	null	| json.phone	null | string	No	null
json.desk_phone	null | string	No	null
json.firstname	null | string	No	null
json.lastname	null | string	No	null
json.mobile_phone	null | string	No	null

Returns:

Returns this

clone

clone(): Person

Returns:

A new deep copy

Type: Person