Skip to content

Commit

Permalink
docs: iOS proxy: add info about client keys and environments.
Browse files Browse the repository at this point in the history
  • Loading branch information
thomasheartman committed Dec 6, 2021
1 parent b46afd8 commit acedb24
Showing 1 changed file with 20 additions and 6 deletions.
26 changes: 20 additions & 6 deletions website/docs/sdks/proxy-ios.md
Expand Up @@ -48,13 +48,27 @@ var unleash = UnleashProxyClientSwift.UnleashClient(
unleash.start()
```

In the example above we import the UnleashProxyClientSwift and instantiate the client. You need to provide the following parameters:
In the example above we import the `UnleashProxyClientSwift` and instantiate the client. You need to provide the following parameters:

- unleashUrl: the full url to your proxy instance [String]
- clientKey: the proxy key [String]
- refreshInterval: the polling interval in seconds [Int]
- appName: the application name identifier [String]
- environment: the application env [String]
- `unleashUrl` (`String`)

the full URL to your proxy instance

- `clientKey` (`String`)

one of the configured [proxy keys / proxy secrets](unleash-proxy#configuration-variables)

- `refreshInterval` (`Int`)

the polling interval in seconds.

- `appName` (`String`)

the application name; only used to identify your application.

- `environment` (`String`)

the application environment. This corresponds to the environment field in [the Unleash Context](../user_guide/unleash-context.md). Note that this is separate from the newer [Environments feature](../user_guide/environments.md).

Running `unleash.start()` will make the first request against the proxy and retrieve the feature toggle configuration, and set up the polling interval in the background.

Expand Down

0 comments on commit acedb24

Please sign in to comment.