Interface useOnlineIdentityProps

interface useOnlineIdentityProps {
    create: ((params, path) => IdentityOnlineWithAuthentication);
    getAuthenticationRequired: ((forPath) => boolean);
    getTokenExpiresInSeconds: ((forPath) => number);
}

Properties

create getAuthenticationRequired getTokenExpiresInSeconds

Properties

create

create: ((params, path) => IdentityOnlineWithAuthentication)

Function used for creating a new online identity. Will save an internal reference to the identity inside of the hook in order to manage the authentication state for the identity.

Type declaration

    • (params, path): IdentityOnlineWithAuthentication

    • Parameters

      Returns IdentityOnlineWithAuthentication

getAuthenticationRequired

getAuthenticationRequired: ((forPath) => boolean)

Retrieves the authentication required state for any of the identities created with the hook.

Type declaration

    • (forPath): boolean

    • Parameters

      • forPath: string

      Returns boolean

getTokenExpiresInSeconds

getTokenExpiresInSeconds: ((forPath) => number)

Retrieves the token expiration time for an identity if one has been notified by the SDK, for any identity created with the hook.

Type declaration

    • (forPath): number

    • Parameters

      • forPath: string

      Returns number

Settings

Member Visibility

Theme

On This Page

creategetAuthenticationRequiredgetTokenExpiresInSeconds