Class FRDevice

FRDevice - Collects user device metadata

Example:

// Instantiate new device object (w/optional config, if needed)
const device = new forgerock.FRDevice(
  // optional configuration
);
// override any instance methods, if needed
// e.g.: device.getDisplayMeta = () => {};

// Call getProfile with required argument obj of boolean properties
// of location and metadata
const profile = await device.getProfile({
  location: isLocationRequired,
  metadata: isMetadataRequired,
});

Hierarchy (view full)

Constructors

constructor

Properties

config

Methods

reduceToObject reduceToString getBrowserMeta getBrowserPluginsNames getDeviceName getDisplayMeta getHardwareMeta getIdentifier getInstalledFonts getLocationCoordinates getOSMeta getProfile getTimezoneOffset

Constructors

constructor

Properties

config

config: BaseProfileConfig = ...

Methods

reduceToObject

reduceToString

getBrowserMeta

  • getBrowserMeta(): {
        [key: string]: string;
    }

  • Returns {
        [key: string]: string;
    }

    • [key: string]: string

getBrowserPluginsNames

getDeviceName

getDisplayMeta

  • getDisplayMeta(): {
        [key: string]: string | number | null;
    }

  • Returns {
        [key: string]: string | number | null;
    }

    • [key: string]: string | number | null

getHardwareMeta

  • getHardwareMeta(): {
        [key: string]: string;
    }

  • Returns {
        [key: string]: string;
    }

    • [key: string]: string

getIdentifier

getInstalledFonts

getLocationCoordinates

getOSMeta

  • getOSMeta(): {
        [key: string]: string;
    }

  • Returns {
        [key: string]: string;
    }

    • [key: string]: string

getProfile

getTimezoneOffset

Settings

Member Visibility

Theme

On This Page

constructorconfigreduceToObjectreduceToStringgetBrowserMetagetBrowserPluginsNamesgetDeviceNamegetDisplayMetagetHardwareMetagetIdentifiergetInstalledFontsgetLocationCoordinatesgetOSMetagetProfilegetTimezoneOffset