diff --git a/website/docs/sdks/proxy-ios.md b/website/docs/sdks/proxy-ios.md index 9b3135bd80..182094dfcb 100644 --- a/website/docs/sdks/proxy-ios.md +++ b/website/docs/sdks/proxy-ios.md @@ -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.