Class SessionService

Class SessionService#

Inheritance Relationships#

Base Type#

Class Documentation#

class xbe.sdk.Services.SessionService : xbe.sdk.ServiceBase#

Public Functions

SessionService ()#
Task<ServerInstance> Assign (string id, AssignServerInstance obj)#

Request a server instance assignment.

Return:

A task whose result is the final assigned server instance.

Task<List<Session>> FindAll (Dictionary<string, string> query = null)#

Returns all sessions from the system that the user has access to.

Task<Session> Create (Session obj)#

Create a new session.

Task<ClientWebSocket> Connect (string id)#

Initiates a connection to the service for using real-time sessions.

Param id:

The unique id of the session to make a real-time socket with.

Return:

async Task<ClientWebSocket> Connect (string id, SocketMode mode)

Initiates a connection to the service for using real-time sessions.

Param id:

The unique id of the session to make a real-time connection with.

Param mode:

The operating mode of the socket to establish.

Return:

Task<Session> FindById (string id)#

Returns a single session from the system that the user has access to.

Task<Session> Update (string id, Session obj)#

Updates a single session.

Task<Session> Join (string id, string password = null)#

Adds the authenticated user to the session with the specified identifier.

Task<Session> UpdateData (string id, Object data)#

Updates the logged in user’s data on the session with the specified identifier.

Task Leave (string id)#

Removes the authenticated user from the session with the specified identifier.

Task<long?> Count (Dictionary<string, string> query = null)#

Retrieves the Entities Count based on the given criteria.

Return:

Entity Count

Task Delete (string id)#

Deletes an instance of T with the specified unique identifier.

Return:

Task

Task Truncate (Dictionary<string, string> query = null)#

Deletes all Entities from the service.

Return:

Task