|
24 | 24 |
|
25 | 25 | * [Connection](#Connection) ⇐ <code>ConnectionBase</code> |
26 | 26 | * _instance_ |
27 | | - * [.connect(hostname, username, password, [webSocketAdapterFactory], [xmlParserFactory])](#Connectionconnect) |
| 27 | + * [.connect(hostname, [username], [password], [webSocketAdapterFactory], [xmlParserFactory], [jwtProvider])](#Connectionconnect) |
28 | 28 | * [.disconnect()](#Connectiondisconnect) |
29 | 29 | * [.on(subscriptionType, callback, [symbol])](#Connectionon) |
30 | 30 | * [.off(subscriptionType, callback, [symbol])](#Connectionoff) |
|
41 | 41 | * [.getServer()](#ConnectiongetServer) ⇒ <code>null</code> \| <code>string</code> |
42 | 42 | * [.getPassword()](#ConnectiongetPassword) ⇒ <code>null</code> \| <code>string</code> |
43 | 43 | * [.getUsername()](#ConnectiongetUsername) ⇒ <code>null</code> \| <code>string</code> |
| 44 | + * [.getJwtProvider()](#ConnectiongetJwtProvider) ⇒ <code>null</code> \| [<code>JwtProvider</code>](#CallbacksJwtProvider) |
44 | 45 | * _constructor_ |
45 | 46 | * [new Connection([environment])](#new_Connection_new) |
46 | 47 |
|
47 | 48 |
|
48 | 49 | * * * |
49 | 50 |
|
50 | | -### connection.connect(hostname, username, password, [webSocketAdapterFactory], [xmlParserFactory]) :id=connectionconnect |
| 51 | +### connection.connect(hostname, [username], [password], [webSocketAdapterFactory], [xmlParserFactory], [jwtProvider]) :id=connectionconnect |
51 | 52 | > Establishes WebSocket connection to Barchart's servers and authenticates. Success |
52 | 53 | > or failure is reported asynchronously by the <strong>Events</strong> subscription (see |
53 | 54 | > [SubscriptionType](#enumssubscriptiontype)). Connection attempts will continue until |
|
60 | 61 | | Param | Type | Description | |
61 | 62 | | --- | --- | --- | |
62 | 63 | | hostname | < code>string</ code> | < p>Barchart hostname (contact [email protected])</ p> | |
63 | | -| username | < code>string</ code> | < p>Your username (contact [email protected])</ p> | |
64 | | -| password | < code>string</ code> | < p>Your password (contact [email protected])</ p> | |
| 64 | +| [username ] | < code>string</ code> | < p>Your username (contact [email protected])</ p> | |
| 65 | +| [password ] | < code>string</ code> | < p>Your password (contact [email protected])</ p> | |
65 | 66 | | [webSocketAdapterFactory] | [<code>WebSocketAdapterFactory</code>](/content/sdk/lib-connection-adapter?id=websocketadapterfactory) | <p>Strategy for creating a [WebSocketAdapterFactory](/content/sdk/lib-connection-adapter?id=websocketadapterfactory) instances (overrides [Environment](/content/sdk/lib-environment?id=environment) settings).</p> | |
66 | 67 | | [xmlParserFactory] | [<code>XmlParserFactory</code>](/content/sdk/lib-utilities-xml?id=xmlparserfactory) | <p>Strategy for creating a [WebSocketAdapterFactory](/content/sdk/lib-connection-adapter?id=websocketadapterfactory) instances (overrides [Environment](/content/sdk/lib-environment?id=environment) settings).</p> | |
| 68 | +| [jwtProvider] | [<code>JwtProvider</code>](#CallbacksJwtProvider) | <p>A function which returns a JWT (or a promise for a JWT) that is used as an alternative for actual credentials.</p> | |
67 | 69 |
|
68 | 70 |
|
69 | 71 | * * * |
|
268 | 270 |
|
269 | 271 | * * * |
270 | 272 |
|
| 273 | +### connection.getJwtProvider() :id=connectiongetjwtprovider |
| 274 | +> The username used to authenticate to Barchart. |
| 275 | +
|
| 276 | +**Kind**: instance method of [<code>Connection</code>](#Connection) |
| 277 | +**Overrides**: [<code>getJwtProvider</code>](#ConnectionBasegetJwtProvider) |
| 278 | +**Returns**: <code>null</code> \| [<code>JwtProvider</code>](#CallbacksJwtProvider) |
| 279 | +**Access**: public |
| 280 | + |
| 281 | +* * * |
| 282 | + |
271 | 283 | ### new Connection([environment]) :id=new_connection_new |
272 | 284 | **Kind**: constructor of [<code>Connection</code>](#Connection) |
273 | 285 |
|
|
341 | 353 |
|
342 | 354 | * [Callbacks](#Callbacks) : <code>object</code> |
343 | 355 | * _static_ |
| 356 | + * [.JwtProvider](#CallbacksJwtProvider) ⇒ <code>string</code> \| <code>Promise.<string></code> |
344 | 357 | * [.EventsCallback](#CallbacksEventsCallback) : <code>function</code> |
345 | 358 | * [.TimestampCallback](#CallbacksTimestampCallback) : <code>function</code> |
346 | 359 | * [.MarketUpdateCallback](#CallbacksMarketUpdateCallback) : <code>function</code> |
347 | 360 | * [.MarketDepthCallback](#CallbacksMarketDepthCallback) : <code>function</code> |
348 | 361 | * [.CumulativeVolumeCallback](#CallbacksCumulativeVolumeCallback) : <code>function</code> |
349 | 362 |
|
350 | 363 |
|
| 364 | +* * * |
| 365 | + |
| 366 | +### Callbacks.JwtProvider :id=callbacksjwtprovider |
| 367 | +> The signature of a function which returns a JWT. The JWT is |
| 368 | +> then used as an alternative for credentials (i.e. a username |
| 369 | +> and password). The function can be synchronous or asynchronous. |
| 370 | +
|
| 371 | +**Kind**: static typedef of [<code>Callbacks</code>](#Callbacks) |
| 372 | +**Returns**: <code>string</code> \| <code>Promise.<string></code> |
| 373 | +**Access**: public |
| 374 | + |
351 | 375 | * * * |
352 | 376 |
|
353 | 377 | ### Callbacks.EventsCallback :id=callbackseventscallback |
|
0 commit comments