@acceleratxr/core_sdk / SessionService
Class: SessionService#
Hierarchy#
-
↳ SessionService
Index#
Constructors#
Properties#
Methods#
Constructors#
constructor#
+ new SessionService(apiClient: ApiClient, config: Configuration): SessionService
Overrides ServiceBase.constructor
Defined in src/services/SessionService.ts:11
Parameters:#
Name |
Type |
|---|---|
|
|
|
Returns: SessionService
Properties#
apiClient#
• Protected apiClient: ApiClient
Inherited from ServiceBase.apiClient
Defined in src/ServiceBase.ts:14
The API Client used when making requests to the API backend server.
config#
• Protected config: Configuration
Inherited from ServiceBase.config
Defined in src/ServiceBase.ts:19
The SDK configuration to use.
uuid#
▪ Static uuid: string = “4955feaf-923f-46fa-8554-5ab50591035f”
Defined in src/services/SessionService.ts:17
Methods#
assignServer#
▸ assignServer(id: string, request: AssignServerInstance): Promise<Session | undefined>
Defined in src/services/SessionService.ts:192
Request a server instance to be assigned to the session with the given id.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
Returns: Promise<Session | undefined>
connect#
▸ connect(id: string): Promise<WebSocket>
Defined in src/services/SessionService.ts:47
Initiates a connection to the service for using real-time sessions.
Parameters:#
Name |
Type |
Description |
|---|---|---|
|
string |
The unique id of the session to make a real-time connection with. |
Returns: Promise<WebSocket>
count#
▸ count(query?: any): Promise<number>
Defined in src/services/SessionService.ts:95
Returns the count of sessions
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<number>
create#
▸ create(obj: Session): Promise<Session | undefined>
Defined in src/services/SessionService.ts:34
Create a new session.
Parameters:#
Name |
Type |
|---|---|
|
Returns: Promise<Session | undefined>
delete#
▸ delete(id: string): Promise<void>
Defined in src/services/SessionService.ts:153
Deletes the session
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<void>
findAll#
▸ findAll(query?: any): Promise<Session[] | undefined>
Defined in src/services/SessionService.ts:22
Returns all sessions from the system that the user has access to.
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<Session[] | undefined>
findById#
▸ findById(id: string): Promise<Session | undefined>
Defined in src/services/SessionService.ts:114
Returns a single session from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<Session | undefined>
join#
▸ join(id: string): Promise<Session | undefined>
Defined in src/services/SessionService.ts:166
Adds the authenticated user to the session with the specified identifier.
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<Session | undefined>
leave#
▸ leave(id: string): Promise<void>
Defined in src/services/SessionService.ts:179
Removes the authenticated user from the session with the specified identifier.
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<void>
truncate#
▸ truncate(query?: any): Promise<void>
Defined in src/services/SessionService.ts:83
Removes all sessions from the datastore.
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<void>
update#
▸ update(id: string, obj: Session): Promise<Session | undefined>
Defined in src/services/SessionService.ts:127
Updates a single session
Parameters:#
Name |
Type |
|---|---|
|
string |
|
Returns: Promise<Session | undefined>
updateData#
▸ updateData(id: string, obj: any): Promise<Session | undefined>
Defined in src/services/SessionService.ts:140
Updates a single session’s data property.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
any |
Returns: Promise<Session | undefined>