seb-win-refactoring/SafeExamBrowser.Server.Contracts/IServerProxy.cs

61 lines
1.7 KiB
C#

/*
* Copyright (c) 2020 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
using System;
using System.Collections.Generic;
using SafeExamBrowser.Server.Contracts.Data;
using SafeExamBrowser.Settings.Server;
namespace SafeExamBrowser.Server.Contracts
{
/// <summary>
/// Defines the communication options with a server.
/// </summary>
public interface IServerProxy
{
/// <summary>
/// Attempts to initialize a connection to the server.
/// </summary>
ServerResponse Connect();
/// <summary>
/// TODO
/// </summary>
ServerResponse Disconnect();
/// <summary>
/// Retrieves a list of all currently available exams.
/// </summary>
ServerResponse<IEnumerable<Exam>> GetAvailableExams();
/// <summary>
/// Retrieves the URI of the configuration file for the given exam.
/// </summary>
ServerResponse<Uri> GetConfigurationFor(Exam exam);
/// <summary>
/// Retrieves the information required to establish a connection with this server.
/// </summary>
ConnectionInfo GetConnectionInfo();
/// <summary>
/// Initializes the server settings to be used for communication.
/// </summary>
void Initialize(ServerSettings settings);
/// <summary>
/// Initializes the configuration and server settings to be used for communication.
/// </summary>
void Initialize(string api, string connectionToken, string oauth2Token, ServerSettings settings);
/// <summary>
/// TODO
/// </summary>
ServerResponse SendSessionInfo(string sessionId);
}
}