setDisplayName method

Future<DynamiteResponse<GuestSetDisplayNameResponseApplicationJson, void>> setDisplayName({
  1. required String displayName,
  2. required String token,
  3. GuestSetDisplayNameApiVersion? apiVersion,
  4. 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:

  • setDisplayNameRaw for an experimental operation that returns a DynamiteRawResponse that can be serialized.

Implementation

Future<_i1.DynamiteResponse<GuestSetDisplayNameResponseApplicationJson, void>> setDisplayName({
  required String displayName,
  required String token,
  GuestSetDisplayNameApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = setDisplayNameRaw(
    displayName: displayName,
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}