setDisplayName method

Future<DynamiteResponse<GuestSetDisplayNameResponseApplicationJson, void>> setDisplayName({ required String displayName, required String token, GuestSetDisplayNameApiVersion? apiVersion, bool? oCSAPIRequest, })

Set the display name as a guest.

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:

• displayName New display name.
• apiVersion Defaults to "v1".
• token
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Display name updated successfully
• 403: Not a guest
• 404: Not a participant

See:

• $setDisplayName_Request for the request send by this method.
• $setDisplayName_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<GuestSetDisplayNameResponseApplicationJson, void>> setDisplayName({
  required String displayName,
  required String token,
  GuestSetDisplayNameApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $setDisplayName_Request(
    displayName: displayName,
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

  final _serializer = $setDisplayName_Serializer();
  final _rawResponse =
      await _i1.ResponseConverter<GuestSetDisplayNameResponseApplicationJson, void>(_serializer).convert(_response);
  return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}