Skip to content

Commit aa1bccd

Browse files
Merge pull request #322 from ably/laura/endpoint-doc-string
Add endpoint doc string
2 parents 47e44d8 + 5859b7b commit aa1bccd

1 file changed

Lines changed: 1 addition & 0 deletions

File tree

textile/api-docstrings.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ Passes additional client-specific properties to the REST [`constructor()`]{@link
111111
| defaultTokenParams: TokenParams? ||| TO3j11 | When a [`TokenParams`]{@link TokenParams} object is provided, it overrides the client library defaults when issuing new Ably Tokens or Ably [`TokenRequest`s]{@link TokenRequest}. |
112112
| echoMessages: Bool default true ||| RTC1a, TO3h | If `false`, prevents messages originating from this connection being echoed back on the same connection. The default is `true`. |
113113
| environment: String? ||| RSC15b, TO3k1 | Enables a [custom environment](https://ably.com/docs/platform-customization) to be used with the Ably service. |
114+
| endpoint: String? ||| REC1b, TO3k8 | Set a routing policy or FQDN to connect to Ably. See [platform customization](https://ably.com/docs/platform-customization). |
114115
| logHandler: ||| platform specific - TO3c | Controls the log output of the library. This is a function to handle each line of log output. |
115116
| logLevel: ||| platform specific - TO3b | Controls the verbosity of the logs output from the library. Levels include `verbose`, `debug`, `info`, `warn` and `error`. |
116117
| logExceptionReportingUrl: String default "[library specific]" ||| TO3m (deprecated) | DEPRECATED: this property is deprecated and will be removed in a future version. Defaults to a string value for an Ably error reporting DSN (Data Source Name), which is typically a URL in the format `https://[KEY]:[SECRET]@errors.ably.io/[ID]`. When set to `null`, `false` or an empty string (depending on what is idiomatic for the platform), exception reporting is disabled. |

0 commit comments

Comments
 (0)