Skip to content

docs: use the same error codes across platforms #132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vonovak merged 1 commit into from
Jun 23, 2026
+19 −12
Merged

docs: use the same error codes across platforms #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 17 additions & 10 deletions docs/api/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,14 +182,15 @@ Learn more in the [guide](/docs/one-tap#requestauthorization).

#### Properties

| Property | Type | Description |
| ---------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <a id="property-accountname"></a> `accountName?` | `string` | Android only. Specifies an account on the device that should be used. |
| <a id="property-hosteddomain"></a> `hostedDomain?` | `string` | Android only. Specifies a hosted domain restriction. By setting this, authorization will be restricted to accounts of the user in the specified domain. |
| <a id="property-offlineaccess"></a> `offlineAccess?` | \{ `enabled`: `boolean`; `forceCodeForRefreshToken?`: `boolean`; \} | - |
| `offlineAccess.enabled` | `boolean` | Whether to enable offline access. If enabled, `serverAuthCode` will be returned in the response. |
| `offlineAccess.forceCodeForRefreshToken?` | `boolean` | Android only. If true, the granted code can be exchanged for an access token and a refresh token. Only use true if your server has suffered some failure and lost the user's refresh token. |
| <a id="property-scopes-1"></a> `scopes` | `string`[] | The Google API scopes to request access to. See [scopes docs](/docs/integration-notes#additional-scopes). |
| Property | Type | Description |
| ---------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| <a id="property-accountname"></a> `accountName?` | `string` | Android only. Specifies an account on the device that should be used. |
| <a id="property-hosteddomain"></a> `hostedDomain?` | `string` | Android only. Specifies a hosted domain restriction. By setting this, authorization will be restricted to accounts of the user in the specified domain. |
| <a id="property-offlineaccess"></a> `offlineAccess?` | \{ `enabled`: `boolean`; `forceCodeForRefreshToken?`: `boolean`; \} | - |
| `offlineAccess.enabled` | `boolean` | Whether to enable offline access. If enabled, `serverAuthCode` will be returned in the response. |
| `offlineAccess.forceCodeForRefreshToken?` | `boolean` | Android only. If true, the granted code can be exchanged for an access token and a refresh token. Only use true if your server has suffered some failure and lost the user's refresh token. **Deprecated** Use `prompt: 'consent'` instead. |
| <a id="property-prompt"></a> `prompt?` | [`AuthorizationPrompt`](#authorizationprompt) \| [`AuthorizationPrompt`](#authorizationprompt)[] | Android only. Controls the prompt behavior for the authorization request. - `'select_account'`: Forces account selection (overrides `accountName`) modal to show. - `'consent'`: Forces the consent modal to show. Applies only to when `offlineAccess` is enabled. You may pass an array (`['consent', 'select_account']`) to show both modals. |
| <a id="property-scopes-1"></a> `scopes` | `string`[] | The Google API scopes to request access to. See [scopes docs](/docs/integration-notes#additional-scopes). |

---

Expand Down Expand Up @@ -364,7 +365,7 @@ The entry point of the Google Sign In API, exposed as `GoogleSignin`.

### statusCodes

> `const` **statusCodes**: `Readonly`\<\{ `IN_PROGRESS`: `string`; `NULL_PRESENTER`: `"NULL_PRESENTER"`; `ONE_TAP_START_FAILED`: `"ONE_TAP_START_FAILED"`; `PLAY_SERVICES_NOT_AVAILABLE`: `string`; \}\>
> `const` **statusCodes**: `Readonly`\<\{ `IN_PROGRESS`: `"IN_PROGRESS"`; `NULL_PRESENTER`: `"NULL_PRESENTER"`; `PLAY_SERVICES_NOT_AVAILABLE`: `"PLAY_SERVICES_NOT_AVAILABLE"`; \}\>

Read more about the meaning of the error codes in the [guide](/docs/errors).

Expand Down Expand Up @@ -595,14 +596,20 @@ You can specify a different bundle path for the config file, e.g. "GoogleService

Alternatively, set the client ID explicitly by providing `iosClientId`.

#### Type Declaration
#### Union Members

##### Type Literal

\{ `iosClientId?`: `string`; \}

| Name | Type | Description |
| -------------- | -------- | ------------------------------------------------------------------------------------------------------------------ |
| `iosClientId?` | `string` | If you want to specify the client ID of type iOS. It is taken from the `GoogleService-Info.plist` file by default. |

---

##### Type Literal

\{ `googleServicePlistPath?`: `string`; \}

| Name | Type | Description |
Expand Down
4 changes: 2 additions & 2 deletions docs/errors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_position: 60
description: 'Error handling guide. Covers `isErrorWithCode` helper, error codes (`SIGN_IN_CANCELLED`, `PLAY_SERVICES_NOT_AVAILABLE`, etc.), and best practices.'
description: 'Error handling guide. Covers `isErrorWithCode` helper, stable status codes, and best practices.'
---

# Error handling
Expand Down Expand Up @@ -37,7 +37,7 @@ try {
import { statusCodes } from '@react-native-google-signin/google-signin';
```

Status codes are useful when determining which kind of error has occurred during the sign-in process. Under the hood, these constants are derived from native error codes and are platform-specific. Always compare `error.code` to `statusCodes.*` and do not rely on the raw value of `error.code`.
Status codes are useful when determining which kind of error has occurred during the sign-in process. These constants are stable canonical values exported by the library, so you can compare `error.code` to `statusCodes.*` with good TypeScript support. Less common native failures may still surface other string values.

See [example usage](one-tap#signin).

Expand Down