validateConfirmationCode method

Future<void> validateConfirmationCode({
  1. required MyUserIdentifier identifier,
  2. required ConfirmationCode code,
})

Validates the provided ConfirmationCode for the MyUser identified by the provided MyUserIdentifier without using it.

If the concrete MyUserIdentifier.email address or MyUserIdentifier.phone number is provided, then the provided ConfirmationCode is validated against it exclusively, meaning that providing ConfirmationCodes sent to any other MyUserEmails.confirmed or MyUserPhones.confirmed is invalid. Otherwise, if a MyUserIdentifier.num or a MyUserIdentifier.login is provided, then a ConfirmationCode sent to any of MyUserEmails.confirmed or MyUserPhones.confirmed is suitable.

User-Agent HTTP header must be specified for this mutation and meet the UserAgent scalar format.

Authentication

None.

Result

Always returns null on success.

Idempotent

ConfirmationCode can be validated unlimited number of times (for now).

Implementation

Future<void> validateConfirmationCode({
  required MyUserIdentifier identifier,
  required ConfirmationCode code,
}) async {
  Log.debug(
    'validateConfirmationCode(identifier: $identifier, code: $code)',
    '$runtimeType',
  );

  final variables = ValidateConfirmationCodeArguments(
    ident: identifier,
    code: code,
  );
  await client.mutate(
    MutationOptions(
      operationName: 'ValidateConfirmationCode',
      document:
          ValidateConfirmationCodeMutation(variables: variables).document,
      variables: variables.toJson(),
    ),
    onException:
        (data) => ValidateConfirmationCodeException(
          (ValidateConfirmationCode$Mutation.fromJson(
            data,
          ).validateConfirmationCode)!,
        ),
  );
}