Interface ScriptSessionManager

Session manager.

Hierarchy

ScriptSessionManager

Index

Properties

Methods

get getSessionId put putIntoSession remove

Properties

sessionId

sessionId: string

Returns

the ID of the current session.

Methods

get

get(key: null | string): JsonType
Get a value from the current session.
Parameters
- key: null | string
Returns JsonType
- Defined in typescript-definitions.ts:2991

getSessionId

getSessionId(): string
Returns
the ID of the current session.

Returns string
- Defined in typescript-definitions.ts:2996

put

put(key: null | string, value: JsonType): void
Put a value into the current session.
Parameters
- key: null | string
- value: JsonType
Returns void
- Defined in typescript-definitions.ts:3009

putIntoSession

putIntoSession(sessionId: null | string, key: null | string, value: JsonType): void
Put a value into the specified session.

Notice that sessions are isolated by plugin group, so it's not possible to share a session value between plugins unless both plugins belong to the same plugin group.
Parameters
- sessionId: null | string
- key: null | string
- value: JsonType
Returns void
- Defined in typescript-definitions.ts:3020

remove

remove(key: null | string): JsonType
Remove a value from the given session.

Returns
the current value associated with the given key.
Parameters
- key: null | string
Returns JsonType
- Defined in typescript-definitions.ts:3029