> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fetchski-attract.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get locale path and manage clipboard

> Returns the path to a locale home-page or optional document and makes the clipboard available in the given locale.

```ts AdonisJS wrap theme={"dark"}
import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const switchLocale = await site.internationalization().switchLocale({ locale: 'fr' })
```

```json Same hostname response wrap theme={"dark"}
{
  "redirectTo": "/fr/page-slug"
}
```

```json Different hostname response wrap theme={"dark"}
{
  "redirectTo": "https://fr.example.com/french-example-page?aposCrossDomainSessionToken=generated_token"
}
```

## In your app

A controller answers a route on your app: it calls `switchLocale()` and returns the answer.

**1. Add the controller**

```ts app/controllers/switch_locale_controller.ts theme={"dark"}
import { inject } from '@adonisjs/core'
import { SiteClient } from '@fetchski/attract-cms-sdk'

@inject()
export default class SwitchLocaleController {
  constructor(protected site: SiteClient) {}

  async handle() {
    return this.site.internationalization().switchLocale({ locale: 'fr' })
  }
}
```

The other values are the example’s: take yours from the request, a form or your database.

**2. Add the route**

```ts start/routes.ts theme={"dark"}
import router from '@adonisjs/core/services/router'

const SwitchLocaleController = () => import('#controllers/switch_locale_controller')

router.post('/i18n/locale', [SwitchLocaleController])
```

Put it behind your auth middleware (`.use(middleware.auth())`): it acts with your key’s access.

**3. Call it**

Your own page’s form or script sends `POST /i18n/locale` and gets back its answer as JSON. Test it, below, calls it.

Used for cross-locale navigation.

> [accordion] Required parameters
>
> One object, e.g. `switchLocale({ locale })`; leave out the optional fields.
>
> **locale** `string` *required*
>
> **Required.** Target locale code.

> [accordion] Optional parameters
>
> **contextDocId** `string | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Optional document ID for the path.
>
> **clipboard** `string | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Optional clipboard content for cross-domain situations.

> [accordion] Returns
>
> A `SwitchLocaleResponse`. Locale path retrieved successfully. One of these: tell them apart by their fields.
>
> **SameHostnameResponse**
>
> **redirectTo** `string`
>
> **Always sent.** Path to redirect to within same hostname. Matches `^/(?!/).*`.
>
> **DifferentHostnameResponse**
>
> **redirectTo** `string`
>
> **Always sent.** Full URL to redirect to with cross-domain session token. Format: an absolute URL. Matches `^[A-Za-z][A-Za-z0-9+.-]*://`.

> [accordion] Errors
>
> Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below. Your exception handler turns them into your app’s own answers, once for every call (see [Map SDK errors to responses](https://docs.fetchski-attract.com/adonisjs/calling-the-api.md#map-sdk-errors-to-responses)); catch only what you want to react to here.
>
> **ValidationFailed** `400`
>
> The site refused what was sent: `errors` lists each field’s problem, `siteMessage` the first.
>
> **Retried first:** No. **Read:** `errors` (field → messages), `siteMessage`.
>
> **AuthenticationFailed** `401`
>
> The API key is missing or refused (malformed, revoked, expired), or a signature its signing mode needs is missing or stale.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **Forbidden** `403`
>
> The key may not do this: a scope it lacks, or an address outside its allowlist. `siteMessage` names it.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **SiteError** `5xx`
>
> The site failed (or something in front of it did). Its logs say why.
>
> **Retried first:** No: a write may have landed. **Read:** `siteMessage`, `errorName`, `data`.
>
> **SiteUnreachable** `no answer`
>
> No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).
>
> **Retried first:** Only when nothing reached the site (`neverConnected()`); never after a timeout, when it may have landed. **Read:** `reason`, `neverConnected`.
>
> **RequestNotSent** `not sent`
>
> The client refused to send it (e.g. a path segment of `..`); the site never saw it.
>
> **Retried first:** No. **Read:** `reason` (what to change).
>
> **SiteRequestFailed** `any other`
>
> Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).
>
> **Retried first:** No. **Read:** `reason`, `status`.
>
> **UnknownSite** `setup`
>
> `sites.forSite('acme')` named a slug `config/attract.ts` doesn’t list (with the keys in the database: no row in `attract_api_keys`).
>
> **Retried first:** No: nothing was sent. **Read:** `message`, `slug`.
>
> **SiteConfigurationError** `setup`
>
> The site’s entry is wrong: a malformed `baseUrl` or key, a key filed under another slug, or no default site. `node ace attract:check` names the fix.
>
> **Retried first:** No: nothing was sent. **Read:** `message` (what to fix).

## Behavior

* **Retries:** a write is sent again only after a 429 (refused before it acted) or when it never reached the site. After a timeout or a 5xx it may have landed: check before you send it again.
* **Timeout:** 15 s per attempt by default; raise `timeout` (milliseconds) in `config/attract.ts` for longer.

## Test it

It calls the controller above with the SDK faked: `fakeAttract()` puts the fake in the container for this one test, and it answers every call with a valid example, so nothing leaves your machine and no key is read. Save it as `tests/unit/internationalization_switch_locale.spec.ts`, then run your tests:

```ts tests/unit/internationalization_switch_locale.spec.ts theme={"dark"}
import { test } from '@japa/runner'
import app from '@adonisjs/core/services/app'
import { fakeAttract } from '@fetchski/attract-cms-adonis/testing'
import SwitchLocaleController from '#controllers/switch_locale_controller'

test('internationalization.switchLocale', async () => {
  const site = fakeAttract()

  const controller = await app.container.make(SwitchLocaleController)
  await controller.handle()

  site.assertCalled('internationalization.switchLocale')
})
```

```bash Terminal theme={"dark"}
node ace test
```

## Related

> [card] [List the site’s languages](https://docs.fetchski-attract.com/adonisjs/reference/internationalization/get-locales.md)
>
> `site.internationalization().getLocales()`

> [card] [Check document existence in locale](https://docs.fetchski-attract.com/adonisjs/reference/internationalization/exist-in-locale.md)
>
> `site.internationalization().existInLocale()`

> [card] [POST /@apostrophecms/i18n/locale](https://docs.fetchski-attract.com/api-reference/internationalization/get-locale-path-and-manage-clipboard.md)
>
> The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.