refreshSession method

Future<RefreshSession$Mutation> refreshSession(
  1. RefreshTokenSecret secret
)

Refreshes a Session of the MyUser identified by the provided RefreshTokenSecret.

Invalidates the provided RefreshTokenSecret and returns a new one for the same RefreshToken, which should be used instead.

The refreshed AccessToken has its own expiration, so to refresh it again, use this mutation with the new returned RefreshTokenSecret (omit using old ones).

RefreshToken doesn't change at all, only the new RefreshTokenSecret is generated for it, which means its expiration is not prolonged comparing to the AccessToken. Once the RefreshToken is expired, the Session cannot be either refreshed or accessed anymore. To create a new Session use the signIn.

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

Authentication

None.

Non-idempotent

Each time creates a new AccessToken and generates a new RefreshTokenSecret for the RefreshToken.

Implementation

Future<RefreshSession$Mutation> refreshSession(
  RefreshTokenSecret secret,
) async {
  Log.debug('refreshSession($secret)', '$runtimeType');

  final variables = RefreshSessionArguments(secret: secret);
  final QueryResult result = await client.mutate(
    MutationOptions(
      operationName: 'RefreshSession',
      document: RefreshSessionMutation(variables: variables).document,
      variables: variables.toJson(),
    ),
    onException:
        (data) => RefreshSessionException(
          (RefreshSession$Mutation.fromJson(data).refreshSession
                  as RefreshSession$Mutation$RefreshSession$RefreshSessionError)
              .code,
        ),
    raw: const RawClientOptions(),
  );
  return RefreshSession$Mutation.fromJson(result.data!);
}