getWelcomeMessage method

Future<DynamiteResponse<SignalingGetWelcomeMessageResponseApplicationJson, void>> getWelcomeMessage({
  1. required int serverId,
  2. SignalingGetWelcomeMessageApiVersion? apiVersion,
  3. bool? oCSAPIRequest,
})

Get the welcome message from a signaling server.

Only available for logged-in users because guests can not use the apps right now. This endpoint requires admin access.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • apiVersion Defaults to v3.
  • serverId ID of the signaling server.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Welcome message returned
  • 404: Signaling server not found
  • 500

See:

Implementation

Future<DynamiteResponse<SignalingGetWelcomeMessageResponseApplicationJson, void>> getWelcomeMessage({
  required int serverId,
  SignalingGetWelcomeMessageApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = getWelcomeMessageRaw(
    serverId: serverId,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}