API Reference › Globals › Planner

Class: Planner

Hierarchy

• Main

  ↳ Planner

Implements

• LifeCycleCallbacks

Index

Constructors

• constructor

Methods

• boot
• destroy
• getApi
• getRapiAccess
• pause
• resume
• teardown

Constructors

constructor

+ new Planner(creator?: string): Planner

Inherited from Main.constructor

Defined in packages/common-core/src/main.ts:76

Parameters:

Name	Type
creator?	string

Returns: Planner

Methods

boot

▸ boot(settings?: object): void

Inherited from Main.boot

Defined in packages/common-core/src/main.ts:135

Parameters:

Name	Type
settings?	object

Returns: void

---

destroy

▸ destroy(): void

Inherited from Main.destroy

Defined in packages/common-core/src/main.ts:176

Returns: void

---

getApi

▸ getApi(): RoomlePlanner

Overrides Main.getApi

Defined in packages/planner-core/src/planner.ts:47

Returns: RoomlePlanner

---

getRapiAccess

▸ getRapiAccess(): RapiAccess

Inherited from Main.getRapiAccess

Defined in packages/common-core/src/main.ts:190

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

params none

Returns: RapiAccess

RapiAccess

---

pause

▸ pause(): void

Inherited from Main.pause

Defined in packages/common-core/src/main.ts:158

Returns: void

---

resume

▸ resume(element?: HTMLElement): void

Inherited from Main.resume

Defined in packages/common-core/src/main.ts:167

Parameters:

Name	Type
element?	HTMLElement

Returns: void

---

teardown

▸ teardown(): void

Inherited from Main.teardown

Defined in packages/common-core/src/main.ts:147

Returns: void