Class: SessionService

Defined in: service-framework-client/src/services.ts:130

Extends

• BaseEventService<{ changed: SessionSnapshot; }, SessionServiceConfig>

Constructors

Constructor

new SessionService(context: ServiceActivationContext<SessionServiceConfig>): SessionService;

Defined in: service-framework/src/event-service.ts:9

Parameters

Parameter	Type
context	ServiceActivationContext<SessionServiceConfig>

Returns

SessionService

Inherited from

BaseEventService.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
abortSignal	readonly	AbortSignal	-	BaseEventService.abortSignal	service-framework/src/base-service.ts:23
environment	readonly	IEnvironmentDescriptor	-	BaseEventService.environment	service-framework/src/base-service.ts:22
logEvent	readonly	TelemetryLog	Emit a telemetry record. Named logEvent rather than log because log is the name a service is most likely to have already claimed for its own logging helper, and an inherited member would break it. With no telemetry configured this is NO_OP_TELEMETRY_LOG.	BaseEventService.logEvent	service-framework/src/base-service.ts:31
manager	readonly	ServiceManager	-	BaseEventService.manager	service-framework/src/base-service.ts:20
scheduler	readonly	IScheduler	-	BaseEventService.scheduler	service-framework/src/base-service.ts:21
serviceConfig	readonly	SessionServiceConfig	-	BaseEventService.serviceConfig	service-framework/src/base-service.ts:46
serviceName	readonly	string	-	BaseEventService.serviceName	service-framework/src/base-service.ts:44
servicePriority	readonly	number	-	BaseEventService.servicePriority	service-framework/src/base-service.ts:45

Accessors

isDestroyed

Get Signature

get isDestroyed(): boolean;

Defined in: service-framework/src/base-service.ts:59

Returns

boolean

Inherited from

BaseEventService.isDestroyed

---

isEnabled

Get Signature

get isEnabled(): boolean;

Defined in: service-framework/src/base-service.ts:47

Returns

boolean

Inherited from

BaseEventService.isEnabled

---

isInitialized

Get Signature

get isInitialized(): boolean;

Defined in: service-framework/src/base-service.ts:51

Returns

boolean

Inherited from

BaseEventService.isInitialized

---

isServiceRegistered

Get Signature

get isServiceRegistered(): boolean;

Defined in: service-framework/src/base-service.ts:63

Returns

boolean

Inherited from

BaseEventService.isServiceRegistered

---

isStarted

Get Signature

get isStarted(): boolean;

Defined in: service-framework/src/base-service.ts:55

Returns

boolean

Inherited from

BaseEventService.isStarted

---

serviceModules

Get Signature

get serviceModules(): readonly IServiceModule<IService>[];

Defined in: service-framework/src/base-service.ts:67

Returns

readonly IServiceModule<IService>[]

Inherited from

BaseEventService.serviceModules

Methods

_setDestroyedState()

_setDestroyedState(isDestroyed: boolean): void;

Defined in: service-framework/src/base-service.ts:157

Parameters

Parameter	Type
isDestroyed	boolean

Returns

void

Inherited from

BaseEventService._setDestroyedState

---

_setInitializedState()

_setInitializedState(isInitialized: boolean): void;

Defined in: service-framework/src/base-service.ts:149

Parameters

Parameter	Type
isInitialized	boolean

Returns

void

Inherited from

BaseEventService._setInitializedState

---

_setRegistrationState()

_setRegistrationState(isRegistered: boolean): void;

Defined in: service-framework/src/base-service.ts:145

Parameters

Parameter	Type
isRegistered	boolean

Returns

void

Inherited from

BaseEventService._setRegistrationState

---

_setStartedState()

_setStartedState(isStarted: boolean): void;

Defined in: service-framework/src/base-service.ts:153

Parameters

Parameter	Type
isStarted	boolean

Returns

void

Inherited from

BaseEventService._setStartedState

---

destroy()

destroy(): void;

Defined in: service-framework/src/base-service.ts:85

Returns

void

Inherited from

BaseEventService.destroy

---

Destroy()

Destroy(): void;

Defined in: service-framework/src/base-service.ts:133

Returns

void

Inherited from

BaseEventService.Destroy

---

emit()

emit<TEventName extends "changed">(eventName: TEventName, payload: {
  changed: SessionSnapshot;
}[TEventName]): void;

Defined in: service-framework/src/event-service.ts:46

Type Parameters

Type Parameter
TEventName extends "changed"

Parameters

Parameter	Type
eventName	TEventName
payload	{ changed: SessionSnapshot; }[TEventName]

Returns

void

Inherited from

BaseEventService.emit

---

fixedUpdate()

fixedUpdate(_context: LifecycleContext): void;

Defined in: service-framework/src/base-service.ts:81

Parameters

Parameter	Type
_context	LifecycleContext

Returns

void

Inherited from

BaseEventService.fixedUpdate

---

FixedUpdate()

FixedUpdate(context: LifecycleContext): void;

Defined in: service-framework/src/base-service.ts:125

Parameters

Parameter	Type
context	LifecycleContext

Returns

void

Inherited from

BaseEventService.FixedUpdate

---

getSnapshot()

getSnapshot(): SessionSnapshot;

Defined in: service-framework-client/src/services.ts:148

Returns

SessionSnapshot

---

initialize()

initialize(): void;

Defined in: service-framework-client/src/services.ts:137

Returns

void

Overrides

BaseEventService.initialize

---

Initialize()

Initialize(): void;

Defined in: service-framework/src/base-service.ts:105

Returns

void

Inherited from

BaseEventService.Initialize

---

lateUpdate()

lateUpdate(_context: LifecycleContext): void;

Defined in: service-framework/src/base-service.ts:79

Parameters

Parameter	Type
_context	LifecycleContext

Returns

void

Inherited from

BaseEventService.lateUpdate

---

LateUpdate()

LateUpdate(context: LifecycleContext): void;

Defined in: service-framework/src/base-service.ts:121

Parameters

Parameter	Type
context	LifecycleContext

Returns

void

Inherited from

BaseEventService.LateUpdate

---

listenerCount()

listenerCount<TEventName extends "changed">(eventName: TEventName): number;

Defined in: service-framework/src/event-service.ts:58

Type Parameters

Type Parameter
TEventName extends "changed"

Parameters

Parameter	Type
eventName	TEventName

Returns

number

Inherited from

BaseEventService.listenerCount

---

off()

off<TEventName extends "changed">(eventName: TEventName, handler: EventHandler<{
  changed: SessionSnapshot;
}[TEventName]>): void;

Defined in: service-framework/src/event-service.ts:23

Type Parameters

Type Parameter
TEventName extends "changed"

Parameters

Parameter	Type
eventName	TEventName
handler	EventHandler<{ changed: SessionSnapshot; }[TEventName]>

Returns

void

Inherited from

BaseEventService.off

---

on()

on<TEventName extends "changed">(eventName: TEventName, handler: EventHandler<{
  changed: SessionSnapshot;
}[TEventName]>): () => void;

Defined in: service-framework/src/event-service.ts:13

Type Parameters

Type Parameter
TEventName extends "changed"

Parameters

Parameter	Type
eventName	TEventName
handler	EventHandler<{ changed: SessionSnapshot; }[TEventName]>

Returns

() => void

Inherited from

BaseEventService.on

---

once()

once<TEventName extends "changed">(eventName: TEventName, handler: EventHandler<{
  changed: SessionSnapshot;
}[TEventName]>): () => void;

Defined in: service-framework/src/event-service.ts:37

Type Parameters

Type Parameter
TEventName extends "changed"

Parameters

Parameter	Type
eventName	TEventName
handler	EventHandler<{ changed: SessionSnapshot; }[TEventName]>

Returns

() => void

Inherited from

BaseEventService.once

---

onFocusChange()

onFocusChange(_context: FocusChangeContext): void;

Defined in: service-framework/src/base-service.ts:87

Parameters

Parameter	Type
_context	FocusChangeContext

Returns

void

Inherited from

BaseEventService.onFocusChange

---

OnFocusChange()

OnFocusChange(context: FocusChangeContext): void;

Defined in: service-framework/src/base-service.ts:137

Parameters

Parameter	Type
context	FocusChangeContext

Returns

void

Inherited from

BaseEventService.OnFocusChange

---

onPauseChange()

onPauseChange(_context: {
  paused: boolean;
}): void;

Defined in: service-framework/src/base-service.ts:89

Parameters

Parameter	Type
_context	{ paused: boolean; }
_context.paused	boolean

Returns

void

Inherited from

BaseEventService.onPauseChange

---

OnPauseChange()

OnPauseChange(context: {
  paused: boolean;
}): void;

Defined in: service-framework/src/base-service.ts:141

Parameters

Parameter	Type
context	{ paused: boolean; }
context.paused	boolean

Returns

void

Inherited from

BaseEventService.OnPauseChange

---

registerServiceModule()

registerServiceModule(serviceModule: IServiceModule): void;

Defined in: service-framework/src/base-service.ts:91

Parameters

Parameter	Type
serviceModule	IServiceModule

Returns

void

Inherited from

BaseEventService.registerServiceModule

---

render()

render(_context: LifecycleContext): void;

Defined in: service-framework/src/base-service.ts:83

Parameters

Parameter	Type
_context	LifecycleContext

Returns

void

Inherited from

BaseEventService.render

---

Render()

Render(context: LifecycleContext): void;

Defined in: service-framework/src/base-service.ts:129

Parameters

Parameter	Type
context	LifecycleContext

Returns

void

Inherited from

BaseEventService.Render

---

reset()

reset(): void;

Defined in: service-framework/src/base-service.ts:75

Returns

void

Inherited from

BaseEventService.reset

---

Reset()

Reset(): void;

Defined in: service-framework/src/base-service.ts:113

Returns

void

Inherited from

BaseEventService.Reset

---

start()

start(): void;

Defined in: service-framework/src/base-service.ts:73

Returns

void

Inherited from

BaseEventService.start

---

Start()

Start(): void;

Defined in: service-framework/src/base-service.ts:109

Returns

void

Inherited from

BaseEventService.Start

---

touch()

touch(): void;

Defined in: service-framework-client/src/services.ts:152

Returns

void

---

unregisterServiceModule()

unregisterServiceModule(serviceModule: IServiceModule): void;

Defined in: service-framework/src/base-service.ts:97

Parameters

Parameter	Type
serviceModule	IServiceModule

Returns

void

Inherited from

BaseEventService.unregisterServiceModule

---

update()

update(_context: LifecycleContext): void;

Defined in: service-framework/src/base-service.ts:77

Parameters

Parameter	Type
_context	LifecycleContext

Returns

void

Inherited from

BaseEventService.update

---

Update()

Update(context: LifecycleContext): void;

Defined in: service-framework/src/base-service.ts:117

Parameters

Parameter	Type
context	LifecycleContext

Returns

void

Inherited from

BaseEventService.Update