Interface ConnectOptions

Younify Connect SDK startup options.

Set the properties of this object to configure the sdk. The key and tokenHandler properties are required. The accessToken and refreshToken properties are required for linking and fetching service content for the user and can be set at a later time if unknown at startup. The tokens can be created from the backend api. The tokenHandler must be set to handle updated tokens and requests from the sdk to renew tokens from the backend api.

interface ConnectOptions {
    accessToken?: null | string;
    extra?: null | object;
    key: null | string;
    logLevel: LogLevel;
    logListener?: null | LogListener;
    refreshToken?: null | string;
    tokenHandler: null | TokenHandler;
}

Properties

accessToken? extra? key logLevel logListener? refreshToken? tokenHandler

Properties

Optional accessToken

accessToken?: null | string

The user's access token if known at startup.

Optional extra

extra?: null | object

Extra options.

key

key: null | string

Required key.

logLevel

logLevel: LogLevel

Minimum log level. Log statements below logLevel will not be sent to logListener.

Optional logListener

logListener?: null | LogListener

Optional log listener for receiving log events.

Optional refreshToken

refreshToken?: null | string

The user's refresh token if known at startup.

tokenHandler

tokenHandler: null | TokenHandler

Optional token handler for handling token events and renewals.

Settings

Member Visibility

Theme

On This Page

accessTokenextrakeylogLevellogListenerrefreshTokentokenHandler