Class DeviceApi

The DeviceAtlas device detection API provides a way to detect devices based on the HTTP headers. Using these headers, the API returns device properties such as screen width, screen height, is mobile, vendor, model etc. If you want to use the DeviceAtlas API in a servlet container then it is strongly recommended to use DeviceApiWeb instead of this library.

The DeviceApiWeb is preferred when you want to perform real-time detection of a user's device in a servlet container.

The DeviceApi is preferred when you want to perform device outside of a servlet container or from an off-line User-Agent list or header set.

getProperties(Map<String, String> headers, String clientSide).

To get the most accurate results: 1- Pass all of the HTTP headers. 2- Use the DeviceAtlas Client-side component and pass the result.

When you have limited data you can also use these alternatives:

getProperties(Map<String, String> headers).

getProperties(String userAgent, String clientSide).

getProperties(String userAgent).

Example usage:

Map<String, String> headers = new HashMap<>();
headers.put("user-agent", "...");
headers.put("accept-language", "...");
// add any other available header...

DeviceApi deviceApi = new DeviceApi();
try {
    DeviceApi.loadDataFromFile("/path/to/datafile.json");
// get all properties from the headers
Properties props = DeviceApi.getProperties(headers);

// .... use the properties ....
if (props.contains("isMobilePhone", true)) {
    // it is a mobile phone
}
if (props.containsKey("model")) {
    String deviceModel = props.get("model").asString();
}
if (props.containsKey("yearReleased")) {
    int deviceModel = props.get("yearReleased").asInteger();
}

} catch (...) {
    ...
}

Copyright (c) DeviceAtlas Limited 2021. All Rights Reserved.

Author

DeviceAtlas Limited