API ReferenceGlobalsPlanner

# Class: Planner

# Hierarchy

# Implements

# Index

# Constructors

# Methods

# Constructors

# constructor

+ new Planner(creator?: string): Planner

Inherited from Main.constructor

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

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:139

Parameters:

Name Type
settings? object

Returns: void


# destroy

destroy(): void

Inherited from Main.destroy

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

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:194

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:162

Returns: void


# resume

resume(element?: HTMLElement): void

Inherited from Main.resume

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

Parameters:

Name Type
element? HTMLElement

Returns: void


# teardown

teardown(): void

Inherited from Main.teardown

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

Returns: void