> ## 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 TypeScript wrap theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
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 function makes the call on the client it is given, so your code passes the real one and a test passes a fake.

**1. Add the function**

```ts src/attract/switch-locale.ts theme={"dark"}
import type { SiteClient } from '@fetchski/attract-cms-sdk';

export async function switchLocale(site: SiteClient) {
  return site.internationalization().switchLocale({ locale: 'fr' });
}
```

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

**2. Call it**

A script makes the client once and calls the function:

```ts scripts/switch-locale.ts theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { switchLocale } from '../src/attract/switch-locale.ts';

const site = createSiteClient();
console.log(await switchLocale(site));
```

```bash Terminal theme={"dark"}
node --env-file=.env scripts/switch-locale.ts
```

A route handler, a job or a queue worker calls it the same way.

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; catch only what you want to react to (see [Errors and testing](https://docs.fetchski-attract.com/typescript/errors.md)).
>
> **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 your sites (`createSiteClients()`) don’t have.
>
> **Retried first:** No: nothing was sent. **Read:** `message`, `slug`.
>
> **SiteConfigurationError** `setup`
>
> The client’s settings are wrong: no `FETCHSKI_ATTRACT_URL` (or `baseUrl`), or a malformed API key.
>
> **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) on the client for longer.

## Test it

It calls the function above with a fake client: the fake answers every call with a valid example, so nothing leaves your machine and no settings or key are needed. Run it with `node --test`.

```ts tests/internationalization-switchLocale.test.ts theme={"dark"}
import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { switchLocale } from '../src/attract/switch-locale.ts';

test('internationalization.switchLocale', async () => {
  const site = fakeSite();
  await switchLocale(site);
  site.assertCalled('internationalization.switchLocale');
});
```

## Related

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

> [card] [Check document existence in locale](https://docs.fetchski-attract.com/typescript/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.