Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
Code Issues Projects Releases Wiki Activity

docs: iOS proxy: add info about client keys and environments.

Browse Source
This commit is contained in:
Thomas Heartman 2021-12-06 13:24:59 +01:00
parent b46afd8887
commit acedb240ca
1 changed files with 20 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
website/docs/sdks/proxy-ios.md
View File

@ -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.