Interface IVISABSession

Interface that represents a transmission session at the VISAB WebApi and provides functionality for it.

Namespace: VISABConnector

Assembly: VISABConnector.dll

Syntax

public interface IVISABSession

Properties

Game

The name of the game of which data will be sent.

Declaration

string Game { get; }

Property Value

Type	Description
String

IsActive

Whether the session is active at the VISAB WebApi.

Declaration

bool IsActive { get; }

Property Value

Type	Description
Boolean

RequestHandler

The RequestHandler used for making the Http requests.

Declaration

IVISABRequestHandler RequestHandler { get; }

Property Value

Type	Description
IVISABRequestHandler

SessionId

The unique identifier for the current session.

Declaration

Guid SessionId { get; }

Property Value

Type	Description
Guid

Methods

CloseSessionAsync()

Closes the session at the VISAB WebApi.

Declaration

Task<ApiResponse<string>> CloseSessionAsync()

Returns

Type	Description
Task<ApiResponse<String>>	An ApiResponse object

GetCreatedFileAsync()

Queries the file that was created by VISAB for the session. Only works if the session was closed before.

Declaration

Task<ApiResponse<string>> GetCreatedFileAsync()

Returns

Type	Description
Task<ApiResponse<String>>	An ApiResponse object with the file as a json string in the content

SendImagesAsync(IImageContainer)

Sends a image object to the VISAB WebApi.

Declaration

Task<ApiResponse<string>> SendImagesAsync(IImageContainer image)

Parameters

Type	Name	Description
IImageContainer	image	The image object of type T

Returns

Type	Description
Task<ApiResponse<String>>	An ApiResponse object

SendStatisticsAsync(IStatistics)

Sends a statistics object to the VISAB WebApi.

Declaration

Task<ApiResponse<string>> SendStatisticsAsync(IStatistics statistics)

Parameters

Type	Name	Description
IStatistics	statistics	The statistics object of type T

Returns

Type	Description
Task<ApiResponse<String>>	An ApiResponse object