Package ch.examzone.sebbb.api

Class SessionsApi

java.lang.Object
ch.examzone.sebbb.api.SessionsApi
public class SessionsApi extends Object

  • Constructor Details

    • SessionsApi

      public SessionsApi()

    • SessionsApi

      public SessionsApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getHostIndex

      public int getHostIndex()

    • setHostIndex

      public void setHostIndex(int hostIndex)

    • getCustomBaseUrl

      public String getCustomBaseUrl()

    • setCustomBaseUrl

      public void setCustomBaseUrl(String customBaseUrl)

    • endSessionCall

      public okhttp3.Call endSessionCall(String id, ApiCallback _callback) throws ApiException
      Build call for endSession
      Parameters:
      id - Session ID (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Session -
      404 Error -

    • endSession

      public Session endSession(String id) throws ApiException
      End a session from your side E.g. when the exam time is up. The app quits and releases the device.
      Parameters:
      id - Session ID (required)
      Returns:
      Session
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Session -
      404 Error -

    • endSessionWithHttpInfo

      public ApiResponse<Session> endSessionWithHttpInfo(String id) throws ApiException
      End a session from your side E.g. when the exam time is up. The app quits and releases the device.
      Parameters:
      id - Session ID (required)
      Returns:
      ApiResponse<Session>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Session -
      404 Error -

    • endSessionAsync

      public okhttp3.Call endSessionAsync(String id, ApiCallback<Session> _callback) throws ApiException
      End a session from your side (asynchronously) E.g. when the exam time is up. The app quits and releases the device.
      Parameters:
      id - Session ID (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Session -
      404 Error -

    • getSessionCall

      public okhttp3.Call getSessionCall(String id, ApiCallback _callback) throws ApiException
      Build call for getSession
      Parameters:
      id - Session ID (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Session -
      404 Error -

    • getSession

      public Session getSession(String id) throws ApiException
      Get a session: state, times, app version, integrity, counters
      Parameters:
      id - Session ID (required)
      Returns:
      Session
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Session -
      404 Error -

    • getSessionWithHttpInfo

      public ApiResponse<Session> getSessionWithHttpInfo(String id) throws ApiException
      Get a session: state, times, app version, integrity, counters
      Parameters:
      id - Session ID (required)
      Returns:
      ApiResponse<Session>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Session -
      404 Error -

    • getSessionAsync

      public okhttp3.Call getSessionAsync(String id, ApiCallback<Session> _callback) throws ApiException
      Get a session: state, times, app version, integrity, counters (asynchronously)
      Parameters:
      id - Session ID (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Session -
      404 Error -

    • listSessionEventsCall

      public okhttp3.Call listSessionEventsCall(String id, Integer limit, Integer after, String type, OffsetDateTime from, OffsetDateTime to, ApiCallback _callback) throws ApiException
      Build call for listSessionEvents
      Parameters:
      id - Session ID (required)
      limit - 1–1000, default 100 (optional)
      after - `next` of the previous page (optional)
      type - Comma-separated event types (optional)
      from - occurred_at >= from (optional)
      to - occurred_at < to (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Events -
      404 Error -

    • listSessionEvents

      public EventPage listSessionEvents(String id, Integer limit, Integer after, String type, OffsetDateTime from, OffsetDateTime to) throws ApiException
      Event log of a session, oldest first
      Parameters:
      id - Session ID (required)
      limit - 1–1000, default 100 (optional)
      after - `next` of the previous page (optional)
      type - Comma-separated event types (optional)
      from - occurred_at >= from (optional)
      to - occurred_at < to (optional)
      Returns:
      EventPage
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Events -
      404 Error -

    • listSessionEventsWithHttpInfo

      public ApiResponse<EventPage> listSessionEventsWithHttpInfo(String id, Integer limit, Integer after, String type, OffsetDateTime from, OffsetDateTime to) throws ApiException
      Event log of a session, oldest first
      Parameters:
      id - Session ID (required)
      limit - 1–1000, default 100 (optional)
      after - `next` of the previous page (optional)
      type - Comma-separated event types (optional)
      from - occurred_at >= from (optional)
      to - occurred_at < to (optional)
      Returns:
      ApiResponse<EventPage>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Events -
      404 Error -

    • listSessionEventsAsync

      public okhttp3.Call listSessionEventsAsync(String id, Integer limit, Integer after, String type, OffsetDateTime from, OffsetDateTime to, ApiCallback<EventPage> _callback) throws ApiException
      Event log of a session, oldest first (asynchronously)
      Parameters:
      id - Session ID (required)
      limit - 1–1000, default 100 (optional)
      after - `next` of the previous page (optional)
      type - Comma-separated event types (optional)
      from - occurred_at >= from (optional)
      to - occurred_at < to (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Events -
      404 Error -

    • listSessionScreenshotsCall

      public okhttp3.Call listSessionScreenshotsCall(String id, Integer limit, Integer after, ApiCallback _callback) throws ApiException
      Build call for listSessionScreenshots
      Parameters:
      id - Session ID (required)
      limit - 1–1000, default 100 (optional)
      after - `next` of the previous page (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Screenshots -
      404 Error -

    • listSessionScreenshots

      public ScreenshotPage listSessionScreenshots(String id, Integer limit, Integer after) throws ApiException
      Screenshots of a session with short-lived signed URLs, oldest first
      Parameters:
      id - Session ID (required)
      limit - 1–1000, default 100 (optional)
      after - `next` of the previous page (optional)
      Returns:
      ScreenshotPage
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Screenshots -
      404 Error -

    • listSessionScreenshotsWithHttpInfo

      public ApiResponse<ScreenshotPage> listSessionScreenshotsWithHttpInfo(String id, Integer limit, Integer after) throws ApiException
      Screenshots of a session with short-lived signed URLs, oldest first
      Parameters:
      id - Session ID (required)
      limit - 1–1000, default 100 (optional)
      after - `next` of the previous page (optional)
      Returns:
      ApiResponse<ScreenshotPage>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Screenshots -
      404 Error -

    • listSessionScreenshotsAsync

      public okhttp3.Call listSessionScreenshotsAsync(String id, Integer limit, Integer after, ApiCallback<ScreenshotPage> _callback) throws ApiException
      Screenshots of a session with short-lived signed URLs, oldest first (asynchronously)
      Parameters:
      id - Session ID (required)
      limit - 1–1000, default 100 (optional)
      after - `next` of the previous page (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Screenshots -
      404 Error -

    • setSessionParticipantCall

      public okhttp3.Call setSessionParticipantCall(String id, Participant participant, ApiCallback _callback) throws ApiException
      Build call for setSessionParticipant
      Parameters:
      id - Session ID (required)
      participant - Participant (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Session -
      404 Error -
      422 Validation failed -

    • setSessionParticipant

      public Session setSessionParticipant(String id, Participant participant) throws ApiException
      Tag the session with your participant reference Optional. Makes the session list readable. Several sessions may carry the same reference.
      Parameters:
      id - Session ID (required)
      participant - Participant (required)
      Returns:
      Session
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Session -
      404 Error -
      422 Validation failed -

    • setSessionParticipantWithHttpInfo

      public ApiResponse<Session> setSessionParticipantWithHttpInfo(String id, Participant participant) throws ApiException
      Tag the session with your participant reference Optional. Makes the session list readable. Several sessions may carry the same reference.
      Parameters:
      id - Session ID (required)
      participant - Participant (required)
      Returns:
      ApiResponse<Session>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Session -
      404 Error -
      422 Validation failed -

    • setSessionParticipantAsync

      public okhttp3.Call setSessionParticipantAsync(String id, Participant participant, ApiCallback<Session> _callback) throws ApiException
      Tag the session with your participant reference (asynchronously) Optional. Makes the session list readable. Several sessions may carry the same reference.
      Parameters:
      id - Session ID (required)
      participant - Participant (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Session -
      404 Error -
      422 Validation failed -