Planner.Planner

planner-core/src/planner.Planner

Type parameters

Name	Type
P	extends readonly PluginName[] = readonly []

Hierarchy

• default

  ↳ Planner

Table of contents

Constructors

• constructor

Methods

• boot

• destroy

• getApi

• getRapiAccess

• pause

• resume

• teardown

Constructors

constructor

• new Planner<P>(creator?, activePlugins?)

Type parameters

Name	Type
P	extends readonly "external-objects"[] = readonly []

Parameters

Name	Type
creator?	string
activePlugins?	P

Overrides

default.constructor

Methods

boot

▸ boot(settings?): void

Parameters

Name	Type
settings?	object

Returns

void

Inherited from

default.boot

---

destroy

▸ destroy(): void

Returns

void

Inherited from

default.destroy

---

getApi

▸ getApi(): default<P>

Returns

default<P>

Overrides

default.getApi

---

getRapiAccess

▸ getRapiAccess(): default

returns the instance of the rapi access so that the user of the SDK can fetch data from the Roomle backend

Params

none

Returns

default

RapiAccess

Inherited from

default.getRapiAccess

---

pause

▸ pause(): void

Returns

void

Inherited from

default.pause

---

resume

▸ resume(element?): void

Parameters

Name	Type
element?	HTMLElement

Returns

void

Inherited from

default.resume

---

teardown

▸ teardown(): void

Returns

void

Inherited from

default.teardown