Global

Type Definitions

cbType()

Source:

cliPropsType

Type:
  • Object
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.

token string <optional>

Authentication token for the from principal.

cacheKey string <optional>

A key to cache server side rendering.

Source:

ctxType

Type:
  • Object.<string, Object>
Source:

jsonType

Type:
  • Object | Array | string | number | null | boolean
Source:

msgType

Type:
Source:

sessionOptionsType

Type:
  • Object
Properties:
Name Type Attributes Description
ca string

Name of the target CA, of the form caOwner-caLocalName.

from string

Name of the source CA, or equal to ca if the client is the owner.

token string <optional>

Authentication token for the from principal.

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

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.

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.

timeAdjuster Object <optional>

Custom object to synchronize clocks with the cloud. See TimeAdjuster.js for details.

password string <optional>

See tokenFactoryOptionsType.

accountsURL string <optional>

See tokenFactoryOptionsType.

unrestrictedToken boolean <optional>

See tokenFactoryOptionsType.

durationInSec number <optional>

See tokenFactoryOptionsType.

securityClient Object <optional>

See tokenFactoryOptionsType.

timeSmooth number <optional>

See timeAdjusterOptionsType.

timeMaxRTT number <optional>

See timeAdjusterOptionsType.

timeMaxWindow number <optional>

See timeAdjusterOptionsType.

Source:

specType

Type:
  • Object
Properties:
Name Type Attributes Description
name string
module string | null
description string <optional>
env Object
components Array.<specType> <optional>
Source:

specURLType

Type:
  • Object
Properties:
Name Type Description
appProtocol string

http or https.

appPublisher string

The publisher of this app.

appLocalName string

The local name of the app.

appSuffix string

A URL suffix, e.g., cafjs.com.

myId string

Name of the from CA, of the form caOwner-caLocalName.

Source:

timeAdjusterOptionsType

Type:
  • Object
Properties:
Name Type Attributes Description
timeSmooth number <optional>

Low pass filter coefficient. Defaults to 1.0, i.e., no filtering.

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.

Source:

tokenFactoryOptionsType

Type:
  • Object
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 now till token expires.

securityClient Object <optional>

A client implementation of the authentication protocol. See caf_srp for an example.

Source: