Type Definitions
cbType()
cliPropsType
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
caOwner |
string | Owner's name of the target CA. |
|
caLocalName |
string | Local name of the target CA. |
|
appPublisher |
string | The publisher of this app. |
|
appLocalName |
string | The local name of the app. |
|
session |
string |
<optional> |
The name of the session. |
token |
string |
<optional> |
Authentication token for the |
cacheKey |
string |
<optional> |
A key to cache server side rendering. |
keepToken |
boolean |
<optional> |
A flag to keep the token in the URL. |
Type:
- Object
ctxType
Type:
- Object.<string, Object>
jsonType
Type:
- Object | Array | string | number | null | boolean
msgType
Type:
- Object.<string, jsonType>
sessionOptionsType
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
ca |
string | Name of the target CA, of the form
|
|
from |
string | Name of the source CA, or equal to |
|
token |
string |
<optional> |
Authentication token for the |
session |
string |
<optional> |
The logical session id. |
appPublisher |
string |
<optional> |
The publisher of this app. |
appLocalName |
string |
<optional> |
The local name of the app. |
disableBackchannel |
boolean |
<optional> |
No notifications are needed, disable the backchannel. |
maxRetries |
number |
<optional> |
Number of error retries before closing a
session. If progress, they reset every |
retryTimeoutMsec |
number |
<optional> |
Time between retries in miliseconds. |
timeoutMsec |
number |
<optional> |
Max time in miliseconds for a request before assuming an irrecoverable error, and closing the session. |
cacheKey |
string |
<optional> |
Custom key to cache server side rendering. |
initUser |
boolean |
<optional> |
Whether the owner in |
log |
function |
<optional> |
Custom function to log messages. |
newToken |
function |
<optional> |
Custom function to negotiate an authentication token. |
newURL |
function |
<optional> |
Custom function to redirect the session. |
newUser |
function |
<optional> |
Custom function to register a new user. |
maxQueueLength |
boolean |
<optional> |
The maximum queue length of non-started
requests. If exceeded the oldest non-started request is dequeued,
propagating in its callback an error with |
timeAdjuster |
Object |
<optional> |
Custom object to synchronize clocks with the
cloud. See |
password |
string |
<optional> |
See |
accountsURL |
string |
<optional> |
See |
unrestrictedToken |
boolean |
<optional> |
See |
durationInSec |
number |
<optional> |
See |
securityClient |
Object |
<optional> |
See |
timeSmooth |
number |
<optional> |
See |
timeMaxRTT |
number |
<optional> |
See |
timeMaxWindow |
number |
<optional> |
See |
Type:
- Object
specType
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
name |
string | ||
module |
string | null | ||
description |
string |
<optional> |
|
env |
Object | ||
components |
Array.<specType> |
<optional> |
Type:
- Object
specURLType
Properties:
Name | Type | Description |
---|---|---|
appProtocol |
string |
|
appPublisher |
string | The publisher of this app. |
appLocalName |
string | The local name of the app. |
appSuffix |
string | A URL suffix, e.g., |
myId |
string | Name of the |
Type:
- Object
timeAdjusterOptionsType
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
timeSmooth |
number |
<optional> |
Low pass filter coefficient.
Defaults to |
timeMaxRTT |
number |
<optional> |
Maximum round trip time in msec before we ignore it. |
timeMaxWindow |
number |
<optional> |
Size of the historical window. The algorithm picks the quickest roundtrip in that window. |
Type:
- Object
tokenFactoryOptionsType
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
password |
string |
<optional> |
The password for the authentication service. |
accountsURL |
string |
<optional> |
The url for an authentication service. |
unrestrictedToken |
boolean |
<optional> |
True if the desired token authenticates to all apps. |
durationInSec |
number |
<optional> |
Time in seconds from |
securityClient |
Object |
<optional> |
A client implementation of the
authentication protocol. See |
Type:
- Object