diff --git a/docs/manifest.json b/docs/manifest.json index 5b2b7b0da8..1d0224cd2c 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -8,7 +8,7 @@ [ { "title": "Quickstart", - "collapse": true, + "collapse": false, "sdk": ["nextjs"], "items": [ [ @@ -46,15 +46,15 @@ ], "href": "/docs/getting-started/quickstart" }, - { - "title": "Core concepts", - "href": "/docs/getting-started/core-concepts" - }, { "title": "Next steps", - "collapse": true, + "collapse": false, "items": [ [ + { + "title": "Core concepts", + "href": "/docs/getting-started/core-concepts" + }, { "title": "Add custom sign-in-or-up page", "href": "/docs/guides/development/custom-sign-in-or-up-page" @@ -1465,198 +1465,9 @@ [ { "title": "Reference", - "icon": "api", + "icon": "code-bracket", "collapse": true, "items": [ - [ - { - "title": "UI components", - "icon": "box", - "items": [ - [ - { - "title": "Overview", - "href": "/docs/references/components/overview" - }, - { - "title": "``", - "href": "/docs/references/components/clerk-provider" - }, - { - "title": "Authentication components", - "collapse": false, - "items": [ - [ - { - "title": "``", - "href": "/docs/references/components/authentication/sign-in" - }, - { - "title": "``", - "href": "/docs/references/components/authentication/sign-up" - }, - { - "title": "``", - "href": "/docs/references/components/authentication/google-one-tap" - }, - { - "title": "``", - "href": "/docs/references/components/authentication/task-choose-organization" - }, - { - "title": "``", - "href": "/docs/references/components/authentication/waitlist" - } - ] - ] - }, - { - "title": "User components", - "collapse": false, - "items": [ - [ - { - "title": "``", - "href": "/docs/references/components/user/user-button" - }, - { - "title": "``", - "href": "/docs/references/components/user/user-profile" - } - ] - ] - }, - { - "title": "Organization components", - "collapse": false, - "items": [ - [ - { - "title": "``", - "href": "/docs/references/components/organization/create-organization" - }, - { - "title": "``", - "href": "/docs/references/components/organization/organization-profile" - }, - { - "title": "``", - "href": "/docs/references/components/organization/organization-switcher" - }, - { - "title": "``", - "href": "/docs/references/components/organization/organization-list" - } - ] - ] - }, - { - "title": "Billing components", - "collapse": false, - "items": [ - [ - { - "title": "``", - "href": "/docs/references/components/billing/pricing-table" - }, - { - "title": "``", - "href": "/docs/references/components/billing/checkout-button", - "tag": "(Beta)" - }, - { - "title": "``", - "href": "/docs/references/components/billing/plan-details-button", - "tag": "(Beta)" - }, - { - "title": "``", - "href": "/docs/references/components/billing/subscription-details-button", - "tag": "(Beta)" - } - ] - ] - }, - { - "title": "Control components", - "collapse": false, - "items": [ - [ - { - "title": "``", - "href": "/docs/references/components/control/authenticate-with-redirect-callback" - }, - { - "title": "``", - "href": "/docs/references/components/control/clerk-loaded" - }, - { - "title": "``", - "href": "/docs/references/components/control/clerk-loading" - }, - { - "title": "``", - "href": "/docs/references/components/control/protect" - }, - { - "title": "``", - "href": "/docs/references/components/control/redirect-to-sign-in" - }, - { - "title": "``", - "href": "/docs/references/components/control/redirect-to-sign-up" - }, - { - "title": "``", - "href": "/docs/references/components/control/redirect-to-user-profile" - }, - { - "title": "``", - "href": "/docs/references/components/control/redirect-to-organization-profile" - }, - { - "title": "``", - "href": "/docs/references/components/control/redirect-to-create-organization" - }, - { - "title": "``", - "href": "/docs/references/components/control/signed-in" - }, - { - "title": "``", - "href": "/docs/references/components/control/signed-out" - } - ] - ] - }, - { - "title": "Unstyled components", - "collapse": false, - "items": [ - [ - { - "title": "``", - "href": "/docs/references/components/unstyled/sign-in-button" - }, - { - "title": "``", - "href": "/docs/references/components/unstyled/sign-in-with-metamask" - }, - { - "title": "``", - "href": "/docs/references/components/unstyled/sign-up-button" - }, - { - "title": "``", - "href": "/docs/references/components/unstyled/sign-out-button" - } - ] - ] - } - ] - ] - } - ], [ { "title": "SDK Reference", @@ -1677,7 +1488,7 @@ "href": "/docs/references/nextjs/clerk-middleware" }, { - "title": "App Router references", + "title": "App Router", "collapse": false, "items": [ [ @@ -1701,7 +1512,7 @@ ] }, { - "title": "Pages Router references", + "title": "Pages Router", "collapse": false, "items": [ [ @@ -1715,23 +1526,6 @@ } ] ] - }, - { - "title": "Demo repositories", - "items": [ - [ - { - "title": "App Router demo repository", - "sdk": ["nextjs"], - "href": "https://github.com/clerk/clerk-nextjs-demo-app-router" - }, - { - "title": "Pages Router demo repository", - "sdk": ["nextjs"], - "href": "https://github.com/clerk/clerk-nextjs-demo-pages-router" - } - ] - ] } ] ] @@ -2094,10 +1888,6 @@ { "title": "Overview", "href": "/docs/references/android/overview" - }, - { - "title": "`getToken()`", - "href": "/docs/references/android/get-token" } ] ] @@ -2130,7 +1920,7 @@ }, { "title": "Client-side helpers", - "collapse": true, + "collapse": false, "items": [ [ { @@ -2190,30 +1980,20 @@ "href": "/docs/references/ios/get-token" }, { - "title": "iOS Components", - "hideTitle": true, - "skip": true, - "items": [ - [ - { - "title": "`AuthView`", - "href": "/docs/references/ios/auth-view" - }, - { - "title": "`UserButton`", - "href": "/docs/references/ios/user-button" - }, - { - "title": "`UserProfileView`", - "href": "/docs/references/ios/user-profile-view" - }, - { - "title": "`ClerkTheme`", - "href": "/docs/references/ios/clerk-theme" - } - ] - ], - "collapse": true + "title": "`AuthView`", + "href": "/docs/references/ios/auth-view" + }, + { + "title": "`UserButton`", + "href": "/docs/references/ios/user-button" + }, + { + "title": "`UserProfileView`", + "href": "/docs/references/ios/user-profile-view" + }, + { + "title": "`ClerkTheme`", + "href": "/docs/references/ios/clerk-theme" } ] ] @@ -3095,41 +2875,58 @@ ] ] }, + { + "title": "Demo repositories", + "items": [ + [ + { + "title": "App Router demo repository", + "sdk": ["nextjs"], + "href": "https://github.com/clerk/clerk-nextjs-demo-app-router" + }, + { + "title": "Pages Router demo repository", + "sdk": ["nextjs"], + "href": "https://github.com/clerk/clerk-nextjs-demo-pages-router" + } + ] + ] + }, { "title": "Composables", "icon": "cpu", "items": [ [ { - "title": "useUser()", + "title": "`useUser()`", "href": "/docs/references/composables/use-user" }, { - "title": "useClerk()", + "title": "`useClerk()`", "href": "/docs/references/composables/use-clerk" }, { - "title": "useAuth()", + "title": "`useAuth()`", "href": "/docs/references/composables/use-auth" }, { - "title": "useSignIn()", + "title": "`useSignIn()`", "href": "/docs/references/composables/use-sign-in" }, { - "title": "useSignUp()", + "title": "`useSignUp()`", "href": "/docs/references/composables/use-sign-up" }, { - "title": "useSession()", + "title": "`useSession()`", "href": "/docs/references/composables/use-session" }, { - "title": "useSessionList()", + "title": "`useSessionList()`", "href": "/docs/references/composables/use-session-list" }, { - "title": "useOrganization()", + "title": "`useOrganization()`", "href": "/docs/references/composables/use-organization" } ] @@ -3139,6 +2936,195 @@ ] } ], + [ + { + "title": "UI components", + "icon": "box", + "items": [ + [ + { + "title": "Overview", + "href": "/docs/references/components/overview" + }, + { + "title": "``", + "href": "/docs/references/components/clerk-provider" + }, + { + "title": "Authentication components", + "collapse": false, + "items": [ + [ + { + "title": "``", + "href": "/docs/references/components/authentication/sign-in" + }, + { + "title": "``", + "href": "/docs/references/components/authentication/sign-up" + }, + { + "title": "``", + "href": "/docs/references/components/authentication/google-one-tap" + }, + { + "title": "``", + "href": "/docs/references/components/authentication/task-choose-organization" + }, + { + "title": "``", + "href": "/docs/references/components/authentication/waitlist" + } + ] + ] + }, + { + "title": "User components", + "collapse": false, + "items": [ + [ + { + "title": "``", + "href": "/docs/references/components/user/user-button" + }, + { + "title": "``", + "href": "/docs/references/components/user/user-profile" + } + ] + ] + }, + { + "title": "Organization components", + "collapse": false, + "items": [ + [ + { + "title": "``", + "href": "/docs/references/components/organization/create-organization" + }, + { + "title": "``", + "href": "/docs/references/components/organization/organization-profile" + }, + { + "title": "``", + "href": "/docs/references/components/organization/organization-switcher" + }, + { + "title": "``", + "href": "/docs/references/components/organization/organization-list" + } + ] + ] + }, + { + "title": "Billing components", + "collapse": false, + "items": [ + [ + { + "title": "``", + "href": "/docs/references/components/billing/pricing-table" + }, + { + "title": "``", + "href": "/docs/references/components/billing/checkout-button", + "tag": "(Beta)" + }, + { + "title": "``", + "href": "/docs/references/components/billing/plan-details-button", + "tag": "(Beta)" + }, + { + "title": "``", + "href": "/docs/references/components/billing/subscription-details-button", + "tag": "(Beta)" + } + ] + ] + }, + { + "title": "Control components", + "collapse": false, + "items": [ + [ + { + "title": "``", + "href": "/docs/references/components/control/authenticate-with-redirect-callback" + }, + { + "title": "``", + "href": "/docs/references/components/control/clerk-loaded" + }, + { + "title": "``", + "href": "/docs/references/components/control/clerk-loading" + }, + { + "title": "``", + "href": "/docs/references/components/control/protect" + }, + { + "title": "``", + "href": "/docs/references/components/control/redirect-to-sign-in" + }, + { + "title": "``", + "href": "/docs/references/components/control/redirect-to-sign-up" + }, + { + "title": "``", + "href": "/docs/references/components/control/redirect-to-user-profile" + }, + { + "title": "``", + "href": "/docs/references/components/control/redirect-to-organization-profile" + }, + { + "title": "``", + "href": "/docs/references/components/control/redirect-to-create-organization" + }, + { + "title": "``", + "href": "/docs/references/components/control/signed-in" + }, + { + "title": "``", + "href": "/docs/references/components/control/signed-out" + } + ] + ] + }, + { + "title": "Unstyled components", + "collapse": false, + "items": [ + [ + { + "title": "``", + "href": "/docs/references/components/unstyled/sign-in-button" + }, + { + "title": "``", + "href": "/docs/references/components/unstyled/sign-in-with-metamask" + }, + { + "title": "``", + "href": "/docs/references/components/unstyled/sign-up-button" + }, + { + "title": "``", + "href": "/docs/references/components/unstyled/sign-out-button" + } + ] + ] + } + ] + ] + } + ], [ { "title": "API Reference", diff --git a/docs/references/android/get-token.mdx b/docs/references/android/get-token.mdx deleted file mode 100644 index 5156bb2554..0000000000 --- a/docs/references/android/get-token.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: '`getToken()`' -description: Use Clerk's Android SDK to retrieve a token for a JWT template that is defined in the Clerk Dashboard. -sdk: android ---- - -The `getToken()` method retrieves the user's [session token](/docs/guides/sessions/session-tokens) or a [custom JWT template](/docs/guides/sessions/jwt-templates). - -This method uses a cache so a network request will only be made if the token in memory has expired. The TTL for a Clerk token is one minute. - -Tokens can only be generated if the user is signed in. - -```kotlin {{ filename: 'Session.kt' }} -suspend fun Session.fetchToken( - options: SessionGetTokenOptions = SessionGetTokenOptions() -): TokenResource? { - return SessionTokenFetcher().getToken(this, options) -} -``` - -## Parameters - - - - `options` - - [`GetTokenOptions`](#get-token-options) - - Options that can be passed as parameters to the `getToken()` function. - - -### `GetTokenOptions` - - - - `template` - - `String?` - - The name of the JWT template from the [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=jwt-templates) to generate a new token from. For example: 'firebase', 'grafbase', or your custom template's name. - - --- - - - `expirationBuffer` - - `Long` - - If the cached token will expire within `{expirationBuffer}` seconds, fetch a new token instead. Max is 60 seconds. Defaults to 10 seconds. - - --- - - - `skipCache` - - `Boolean` - - Whether to skip the cache lookup and force a refresh of the token instead. Useful if the token claims are time-sensitive or depend on data that can be updated (e.g. user fields). Defaults to false. - - -## Example - -```kotlin -val session = Clerk.session - -scope.launch { - val token = session?.fetchToken()?.onSuccess { tokenResource -> - headers["Authorization"] = "Bearer ${tokenResource.jwt}" - } -} -```