Google Sign In

https://pub.dev/documentation/google_sign_in/latest
Admin
A Flutter plugin that provides Google Sign In functionality for Android, iOS, macOS, and Web...
Tokens:8,590
Snippets:160
Trust Score:9.9
Update:1 week ago
Show doc for...
Tokens:
Raw
### Initialize GoogleSignIn and start lightweight authentication

Source: https://pub.dev/documentation/google_sign_in/latest/index.html

Initializes the GoogleSignIn instance and optionally starts lightweight authentication. Uses the stream-based approach to determine UI state. Requires clientId and serverClientId.

```dart
final GoogleSignIn signIn = GoogleSignIn.instance;
unawaited(
  signIn.initialize(clientId: clientId, serverClientId: serverClientId).then((
    _,
  ) {
    signIn.authenticationEvents
        .listen(_handleAuthenticationEvent)
        .onError(_handleAuthenticationError);

    /// This example always uses the stream-based approach to determining
    /// which UI state to show, rather than using the future returned here,
    /// if any, to conditionally skip directly to the signed-in state.
    signIn.attemptLightweightAuthentication();
  }),
);
```

--------------------------------

### authenticate

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignIn-class.html

Starts an interactive sign-in process.

```APIDOC
## Future<GoogleSignInAccount> authenticate({List<String> scopeHint = const <String>[]})

### Description
Starts an interactive sign-in process.

### Method
Method

### Endpoint
authenticate

### Parameters
#### Optional Parameters
- **scopeHint** (List<String>) - Optional - A list of scopes to request during authentication.

### Response
- **Future<GoogleSignInAccount>** - A future that completes with the authenticated account.

```

--------------------------------

### Example usage of FakeSignInBackend

Source: https://pub.dev/documentation/google_sign_in/latest/testing/FakeSignInBackend-class.html

Sets up a GoogleSignIn instance with a FakeSignInBackend and a FakeUser, then attaches the backend's handleMethodCall to the channel's mock method call handler.

```dart
GoogleSignIn googleSignIn;
FakeSignInBackend fakeSignInBackend;

setUp(() {
  googleSignIn = GoogleSignIn();
  fakeSignInBackend = FakeSignInBackend();
  fakeSignInBackend.user = FakeUser(
    id: 123,
    email: 'jdoe@example.org',
  );
  googleSignIn.channel.setMockMethodCallHandler(
      fakeSignInBackend.handleMethodCall);
});
```

--------------------------------

### User-initiated sign-in flow with authenticate and web fallback

Source: https://pub.dev/documentation/google_sign_in/latest/index.html

Shows UI to start a sign-in flow when the user isn't signed in by the lightweight method. Uses authenticate on platforms that support it, otherwise falls back to a platform-specific approach, such as a web button rendered by the sign-in SDK.

```dart
if (GoogleSignIn.instance.supportsAuthenticate())
  ElevatedButton(
    onPressed: () async {
      try {
        await GoogleSignIn.instance.authenticate();
      } catch (e) {
        // ···
      }
    },
    child: const Text('SIGN IN'),
  )
else ...<Widget>[
  if (kIsWeb)
    web.renderButton()
  // ···
],
```

--------------------------------

### idToken property

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignInAuthentication-class.html

Gets the OpenID Connect ID token that identifies the user. This property is final and can be null.

```APIDOC
## idToken → String?

### Description
An OpenID Connect ID token that identifies the user. This property is final and can be null.

### Type
String?

### Example
```dart
final token = auth.idToken;
```
```

--------------------------------

### initialize

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignIn-class.html

Initializes the sign in manager with the given configuration.

```APIDOC
## Future<void> initialize({String? clientId, String? serverClientId, String? nonce, String? hostedDomain})

### Description
Initializes the sign in manager with the given configuration.

### Method
Method

### Endpoint
initialize

### Parameters
#### Optional Parameters
- **clientId** (String?) - Optional - The client ID for the application.
- **serverClientId** (String?) - Optional - The server client ID for the application.
- **nonce** (String?) - Optional - A nonce to use for the authentication.
- **hostedDomain** (String?) - Optional - The hosted domain to restrict sign-in to.

### Response
- **Future<void>** - Completes when initialization is complete.

```

--------------------------------

### GoogleSignIn.instance

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignIn-class.html

Returns the singleton instance of GoogleSignIn.

```APIDOC
## GoogleSignIn.instance

### Description
Returns the single GoogleSignIn instance.

### Method
Static property

### Endpoint
GoogleSignIn.instance

### Parameters
None

### Response
- **GoogleSignIn** - The singleton instance of GoogleSignIn.

```

--------------------------------

### GoogleSignInServerAuthorization constructor

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignInServerAuthorization-class.html

Creates a new token container with the given server auth code.

```APIDOC
## GoogleSignInServerAuthorization({required String serverAuthCode})

### Description
Creates a new token container with the given server auth code.

### Constructor
`GoogleSignInServerAuthorization({required String serverAuthCode})`

### Parameters
- **serverAuthCode** (String) - Required - The server auth code to store.

### Example
```dart
final auth = GoogleSignInServerAuthorization(serverAuthCode: 'your_auth_code');
```
```

--------------------------------

### GoogleSignInClientAuthorization constructor

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignInClientAuthorization-class.html

Creates a new token container with the given access token. The constructor is const and requires an accessToken string.

```APIDOC
## GoogleSignInClientAuthorization({required String accessToken})

### Description
Creates a new token container with the given access token. The constructor is const and requires an accessToken string.

### Parameters
- **accessToken** (String) - Required - The OAuth2 access token to access Google services.

### Example
```dart
const auth = GoogleSignInClientAuthorization(accessToken: 'your_access_token');
```
```

--------------------------------

### GoogleUserCircleAvatar.build method

Source: https://pub.dev/documentation/google_sign_in/latest/widgets/GoogleUserCircleAvatar-class.html

Describes the part of the user interface represented by this widget. This method is overridden from StatelessWidget.

```APIDOC
## build(BuildContext context) → Widget

### Description
Describes the part of the user interface represented by this widget.

### Parameters
- **context** (BuildContext) - The build context.

### Returns
Widget - The widget tree that represents this widget's UI.
```

--------------------------------

### GoogleSignInAuthenticationEventSignIn constructor

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignInAuthenticationEventSignIn-class.html

Creates an event for a successful sign in.

```APIDOC
## GoogleSignInAuthenticationEventSignIn({required GoogleSignInAccount user})

### Description
Creates an event for a successful sign in.

### Parameters
- **user** (GoogleSignInAccount) - Required - The user that was authenticated.

### Example
```dart
GoogleSignInAuthenticationEventSignIn(user: googleSignInAccount);
```
```

--------------------------------

### GoogleSignInException class

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignInException-class.html

Documentation for the GoogleSignInException class, including its constructor, properties, and methods.

```APIDOC
## GoogleSignInException

### Description
An exception thrown by the plugin when there is authentication or authorization failure, or some other error.

### Constructors

#### GoogleSignInException({required GoogleSignInExceptionCode code, String? description, Object? details})
Creates a new exception with the given information.

### Properties
- **code** (GoogleSignInExceptionCode) - The type of failure.
- **description** (String?) - A human-readable description of the failure.
- **details** (Object?) - Any additional details about the failure.

### Methods
- **toString()** → String - A string representation of this object.
```

--------------------------------

### authorizeServer(List<String> scopes) → Future<GoogleSignInServerAuthorization?>

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignInAuthorizationClient-class.html

Requests that the user authorize the given scopes for server use.

```APIDOC
## authorizeServer(List<String> scopes)

### Description
Requests that the user authorize the given scopes for server use.

### Method
authorizeServer

### Parameters
- **scopes** (List<String>) - Required - The scopes to request authorization for.

### Returns
Future<GoogleSignInServerAuthorization?> - The server authorization tokens, or null if authorization fails.
```

--------------------------------

### attemptLightweightAuthentication

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignIn-class.html

Attempts to sign in a previously authenticated user with minimal interaction.

```APIDOC
## Future<GoogleSignInAccount?>? attemptLightweightAuthentication({bool reportAllExceptions = false})

### Description
Attempts to sign in a previously authenticated user with minimal interaction.

### Method
Method

### Endpoint
attemptLightweightAuthentication

### Parameters
#### Optional Parameters
- **reportAllExceptions** (bool) - Optional - Whether to report all exceptions during the attempt.

### Response
- **Future<GoogleSignInAccount?>?** - A future that completes with the account if successful, or null if not.

```

--------------------------------

### authorizationHeaders(List<String> scopes, {bool promptIfNecessary = false}) → Future<Map<String, String>?>

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignInAuthorizationClient-class.html

Convenience method returning a map of HTML authorization headers, containing the access token for the given scopes. Optionally prompts the user if necessary.

```APIDOC
## authorizationHeaders(List<String> scopes, {bool promptIfNecessary = false})

### Description
Convenience method returning a map of HTML authorization headers, containing the access token for the given scopes. Optionally prompts the user if necessary.

### Method
authorizationHeaders

### Parameters
- **scopes** (List<String>) - Required - The scopes to request authorization for.
- **promptIfNecessary** (bool) - Optional - Whether to prompt the user if necessary. Defaults to false.

### Returns
Future<Map<String, String>?> - A map of authorization headers, or null if authorization fails.
```

--------------------------------

### GoogleSignInAuthentication constructor

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignInAuthentication-class.html

Creates a new token container with the given tokens. The constructor is const and requires an optional idToken.

```APIDOC
## GoogleSignInAuthentication({required String? idToken})

### Description
Creates a new token container with the given tokens. The constructor is const.

### Parameters
- **idToken** (String?) - Required - An OpenID Connect ID token that identifies the user.

### Example
```dart
const auth = GoogleSignInAuthentication(idToken: 'your_id_token');
```
```

--------------------------------

### GoogleIdentity()

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleIdentity-class.html

Constructor for the GoogleIdentity class. It is abstract and cannot be instantiated directly.

```APIDOC
## GoogleIdentity()

### Description
Constructor for the GoogleIdentity class. It is abstract and cannot be instantiated directly.

### Method
Constructor

### Parameters
None

### Returns
A new instance of GoogleIdentity.

```

--------------------------------

### Request a server auth code with authorizeServer

Source: https://pub.dev/documentation/google_sign_in/latest/index.html

Requests a server auth code to send to a backend server. Server auth codes may not be available on all platforms and should be requested as soon as possible after initial sign-in. Must be initiated from a user interaction on platforms where authorizationRequiresUserInteraction() returns true.

```dart
final GoogleSignInServerAuthorization? serverAuth = await user
    .authorizationClient
    .authorizeServer(scopes);
```

--------------------------------

### supportsAuthenticate

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignIn-class.html

Whether or not the current platform supports the authenticate method.

```APIDOC
## bool supportsAuthenticate()

### Description
Whether or not the current platform supports the authenticate method.

### Method
Method

### Endpoint
supportsAuthenticate

### Parameters
None

### Response
- **bool** - True if the authenticate method is supported.

```

--------------------------------

### authorizationClient

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignIn-class.html

Returns a client that can be used to request authorization tokens for some user.

```APIDOC
## GoogleSignInAuthorizationClient authorizationClient

### Description
Returns a client that can be used to request authorization tokens for some user.

### Method
Property

### Endpoint
authorizationClient

### Parameters
None

### Response
- **GoogleSignInAuthorizationClient** - A client for requesting authorization tokens.

```

--------------------------------

### authenticationEvents

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignIn-class.html

Subscribe to this stream to be notified when sign in and sign out events happen.

```APIDOC
## Stream<GoogleSignInAuthenticationEvent> authenticationEvents

### Description
Subscribe to this stream to be notified when sign in (authentication) and sign out events happen.

### Method
Property

### Endpoint
authenticationEvents

### Parameters
None

### Response
- **Stream<GoogleSignInAuthenticationEvent>** - A stream of authentication events.

```

--------------------------------

### toString method

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignInAuthentication-class.html

Returns a string representation of this object. This method overrides the default implementation.

```APIDOC
## toString() → String

### Description
Returns a string representation of this object. This method overrides the default implementation.

### Returns
String - A string representation of the object.

### Example
```dart
print(auth.toString());
```
```

--------------------------------

### authorizeScopes(List<String> scopes) → Future<GoogleSignInClientAuthorization>

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignInAuthorizationClient-class.html

Requests that the user authorize the given scopes, and either returns the resulting client authorization tokens, or throws an exception with failure details.

```APIDOC
## authorizeScopes(List<String> scopes)

### Description
Requests that the user authorize the given scopes, and either returns the resulting client authorization tokens, or throws an exception with failure details.

### Method
authorizeScopes

### Parameters
- **scopes** (List<String>) - Required - The scopes to request authorization for.

### Returns
Future<GoogleSignInClientAuthorization> - The resulting client authorization tokens.
```

--------------------------------

### authorizationForScopes(List<String> scopes) → Future<GoogleSignInClientAuthorization?>

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignInAuthorizationClient-class.html

Requests client authorization tokens if they can be returned without user interaction. Returns null if user interaction is required.

```APIDOC
## authorizationForScopes(List<String> scopes)

### Description
Requests client authorization tokens if they can be returned without user interaction. Returns null if user interaction is required.

### Method
authorizationForScopes

### Parameters
- **scopes** (List<String>) - Required - The scopes to request authorization for.

### Returns
Future<GoogleSignInClientAuthorization?> - The authorization tokens, or null if user interaction is required.
```

--------------------------------

### GoogleUserCircleAvatar constructor

Source: https://pub.dev/documentation/google_sign_in/latest/widgets/GoogleUserCircleAvatar-class.html

Creates a new GoogleUserCircleAvatar widget based on the specified identity. The constructor is const and requires an identity parameter.

```APIDOC
## GoogleUserCircleAvatar({Key? key, required GoogleIdentity identity, String? placeholderPhotoUrl, Color? foregroundColor, Color? backgroundColor})

### Description
Creates a new widget based on the specified identity.

### Parameters
- **key** (Key?) - Optional - Controls how one widget replaces another widget in the tree.
- **identity** (GoogleIdentity) - Required - The Google user's identity; guaranteed to be non-null.
- **placeholderPhotoUrl** (String?) - Optional - The URL of a photo to use if the user's identity does not specify a photoUrl.
- **foregroundColor** (Color?) - Optional - The color of the text to be displayed if photo is not available.
- **backgroundColor** (Color?) - Optional - The color with which to fill the circle. Changing the background color will cause the avatar to animate to the new color.

### Usage
This constructor is used to instantiate a GoogleUserCircleAvatar widget.
```

--------------------------------

### user property

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignInAuthenticationEventSignIn-class.html

The user that was authenticated.

```APIDOC
## user → GoogleSignInAccount

### Description
The user that was authenticated.

### Type
GoogleSignInAccount

### Attributes
- final
```

--------------------------------

### displayName

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleIdentity-class.html

The display name of the signed in user. This property is read-only (no setter).

```APIDOC
## displayName

### Description
The display name of the signed in user.

### Type
String?

### Access
Read-only (no setter)

```

--------------------------------

### GoogleSignInAuthenticationEventSignOut()

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignInAuthenticationEventSignOut-class.html

Constructs a new instance of the GoogleSignInAuthenticationEventSignOut class, representing a sign-out event.

```APIDOC
## GoogleSignInAuthenticationEventSignOut()

### Description
Creates a new instance of the GoogleSignInAuthenticationEventSignOut class, which represents a sign-out event corresponding to a user having been signed out.

### Constructor
GoogleSignInAuthenticationEventSignOut()

### Parameters
None.

### Remarks
- This class is immutable.
- Implicit sign-outs (for example, due to server-side authentication revocation, or timeouts) are not guaranteed to send events.

### Inheritance
- Object
- GoogleSignInAuthenticationEvent
- GoogleSignInAuthenticationEventSignOut

### Inherited Members
- hashCode → int (no setter, inherited)
- runtimeType → Type (no setter, inherited)
- noSuchMethod(Invocation invocation) → dynamic (inherited)
- toString() → String (inherited)
- operator ==(Object other) → bool (inherited)
```

--------------------------------

### GoogleUserCircleAvatar.sizeDirective static property

Source: https://pub.dev/documentation/google_sign_in/latest/widgets/GoogleUserCircleAvatar-class.html

A regular expression that matches against the 'size directive' path segment of Google profile image URLs.

```APIDOC
## sizeDirective → RegExp

### Description
A regular expression that matches against the 'size directive' path segment of Google profile image URLs.
```

--------------------------------

### authorizationRequiresUserInteraction

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignIn-class.html

Whether or not authorization calls that could show UI must be called from a user interaction.

```APIDOC
## bool authorizationRequiresUserInteraction()

### Description
Whether or not authorization calls that could show UI must be called from a user interaction, such as a button press, on the current platform.

### Method
Method

### Endpoint
authorizationRequiresUserInteraction

### Parameters
None

### Response
- **bool** - True if authorization calls must be called from a user interaction.

```

--------------------------------

### photoUrl

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleIdentity-class.html

The photo url of the signed in user if the user has a profile picture. This property is read-only (no setter).

```APIDOC
## photoUrl

### Description
The photo url of the signed in user if the user has a profile picture.

### Type
String?

### Access
Read-only (no setter)

```

--------------------------------

### GoogleSignInAccount methods

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignInAccount-class.html

Methods of the GoogleSignInAccount class.

```APIDOC
## GoogleSignInAccount Methods

### noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed. Inherited.

### toString() → String
A string representation of this object. Override.

```

--------------------------------

### signOut

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignIn-class.html

Signs out any currently signed in user(s).

```APIDOC
## Future<void> signOut()

### Description
Signs out any currently signed in user(s).

### Method
Method

### Endpoint
signOut

### Parameters
None

### Response
- **Future<void>** - Completes when sign out is complete.

```

--------------------------------

### Request more scopes with authorizeScopes

Source: https://pub.dev/documentation/google_sign_in/latest/index.html

Initiates an Authorization request when the user hasn't granted required scopes. Must be initiated from a user interaction on platforms where authorizationRequiresUserInteraction() returns true.

```dart
final GoogleSignInClientAuthorization authorization = await user
    .authorizationClient
    .authorizeScopes(scopes);
```

--------------------------------

### email

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleIdentity-class.html

The email address of the signed in user. This property is read-only (no setter).

```APIDOC
## email

### Description
The email address of the signed in user.

### Type
String

### Access
Read-only (no setter)

```

--------------------------------

### accessToken property

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignInClientAuthorization-class.html

The OAuth2 access token to access Google services. This is a final property, meaning it cannot be changed after initialization.

```APIDOC
## accessToken → String

### Description
The OAuth2 access token to access Google services. This is a final property, meaning it cannot be changed after initialization.

### Type
String

### Example
```dart
final token = auth.accessToken;
```
```

--------------------------------

### id

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleIdentity-class.html

The unique ID for the Google account. This property is read-only (no setter).

```APIDOC
## id

### Description
The unique ID for the Google account.

### Type
String

### Access
Read-only (no setter)

```

--------------------------------

### clearAuthorizationToken({required String accessToken}) → Future<void>

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignInAuthorizationClient-class.html

Removes the given accessToken from any local authorization caches.

```APIDOC
## clearAuthorizationToken({required String accessToken})

### Description
Removes the given accessToken from any local authorization caches.

### Method
clearAuthorizationToken

### Parameters
- **accessToken** (String) - Required - The access token to remove from caches.

### Returns
Future<void> - A future that completes when the token is removed.
```

--------------------------------

### serverAuthCode property

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignInServerAuthorization-class.html

The server auth code to provide to a backend server to exchange for access or refresh tokens.

```APIDOC
## serverAuthCode

### Description
The server auth code to provide to a backend server to exchange for access or refresh tokens.

### Type
String

### Remarks
This property is final and immutable.
```

--------------------------------

### Check if scopes have been granted and request access token

Source: https://pub.dev/documentation/google_sign_in/latest/index.html

Silently requests an access token for previously authorized scopes. Uses authorizationClient.authorizationForScopes with a list of scopes.

```dart
const List<String> scopes = <String>[
  'https://www.googleapis.com/auth/contacts.readonly',
];
    final GoogleSignInAccount? user = // ...
    final GoogleSignInClientAuthorization? authorization = await user
        ?.authorizationClient
        .authorizationForScopes(scopes);
```

--------------------------------

### GoogleSignInAccount properties

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignInAccount-class.html

Properties of the GoogleSignInAccount class that provide account information and token access.

```APIDOC
## GoogleSignInAccount Properties

### authentication → GoogleSignInAuthentication
Returns authentication tokens for this account. No setter.

### authorizationClient → GoogleSignInAuthorizationClient
Returns a client that can be used to request authorization tokens for this user. No setter.

### displayName → String?
The display name of the signed in user. Final.

### email → String
The email address of the signed in user. Final.

### id → String
The unique ID for the Google account. Final.

### photoUrl → String?
The photo url of the signed in user if the user has a profile picture. Final.

```

--------------------------------

### GoogleUserCircleAvatar properties

Source: https://pub.dev/documentation/google_sign_in/latest/widgets/GoogleUserCircleAvatar-class.html

Properties of the GoogleUserCircleAvatar widget, including identity, placeholderPhotoUrl, foregroundColor, and backgroundColor.

```APIDOC
## Properties

### backgroundColor → Color?
The color with which to fill the circle. Changing the background color will cause the avatar to animate to the new color.

### foregroundColor → Color?
The color of the text to be displayed if photo is not available.

### identity → GoogleIdentity
The Google user's identity; guaranteed to be non-null.

### placeholderPhotoUrl → String?
The URL of a photo to use if the user's identity does not specify a photoUrl.
```

--------------------------------

### GoogleSignInAccount operators

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignInAccount-class.html

Operators of the GoogleSignInAccount class.

```APIDOC
## GoogleSignInAccount Operators

### operator ==(Object other) → bool
The equality operator. Override.

```

--------------------------------

### disconnect

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignIn-class.html

Disconnects any currently authorized users from the app, revoking previous authorization.

```APIDOC
## Future<void> disconnect()

### Description
Disconnects any currently authorized users from the app, revoking previous authorization.

### Method
Method

### Endpoint
disconnect

### Parameters
None

### Response
- **Future<void>** - Completes when disconnection is complete.

```

--------------------------------

### GoogleSignInExceptionCode enum

Source: https://pub.dev/documentation/google_sign_in/latest/google_sign_in/GoogleSignInExceptionCode.html

The GoogleSignInExceptionCode enum defines the possible exception codes for GoogleSignInException. It is used to categorize errors that occur during Google Sign-In operations.

```APIDOC
## GoogleSignInExceptionCode enum

### Description
Types of GoogleSignInExceptions, as indicated by GoogleSignInException.code.

### Values
- **unknownError** - A catch-all for implementations that need to return a code that does not have a corresponding known code. Whenever possible, implementators should update the platform interface to add new codes instead of using this type. When it is used, the GoogleSignInException.description should have information allowing developers to understand the issue.
- **canceled** - The operation was canceled by the user.
- **interrupted** - The operation was interrupted for a reason other than being intentionally canceled by the user.
- **clientConfigurationError** - The client is misconfigured. The GoogleSignInException.description should include details about the configuration problem.
- **providerConfigurationError** - The underlying auth SDK is unavailable or misconfigured.
- **uiUnavailable** - UI needed to be displayed, but could not be. For example, this can be returned on Android if a call tries to show UI when no Activity is available.
- **userMismatch** - An operation was attempted on a user who is not the current user, on a platform where the SDK only supports a single user being signed in at a time.

### Properties
- **hashCode** (int) - The hash code for this object. (inherited)
- **index** (int) - A numeric identifier for the enumerated value. (inherited)
- **name** (String) - The name of the enum value. (provided by the EnumName extension)
- **runtimeType** (Type) - A representation of the runtime type of the object. (inherited)

### Methods
- **noSuchMethod(Invocation invocation)** (dynamic) - Invoked when a nonexistent method or property is accessed. (inherited)
- **toString()** (String) - A string representation of this object. (inherited)

### Operators
- **operator ==(Object other)** (bool) - The equality operator. (inherited)

### Constants
- **values** (const List<GoogleSignInExceptionCode>) - A constant List of the values in this enum, in order of their declaration.
```
Tokens:
Raw