Home | Trees | Indices | Help |
---|
|
DeviceApi Configurations. To change the default configs of the DeviceAtlas DeviceApi create an instance of this class, set your preferred configs and pass the instance to the constructor of a DeviceApi.
Note that you may change the configs even after the Config instance has been passed to the DeviceApi.
Copyright: Copyright (c) DeviceAtlas Limited 2023. All Rights Reserved.
Author: DeviceAtlas Limited
Instance Methods | |||
|
|||
|
|||
|
|||
|
|||
bool |
|
Class Variables | |
DEFAULT_COOKIE_NAME =
|
|
DEFAULT_MAX_CACHE_ENTRIES = 4096
|
Properties | |
cookie_name Get the cookie name that the client side properties would be set to. |
|
max_cache_entries Get the max number of results to be cached. |
Method Details |
Get the cookie name that the client side properties would be set to. When using get_properties(HEADERS), the detection would automatically use the contents of this cookie if it exists. If you want the client side properties to be used add the DeviceAtlas Client-side component (JS lib) to your web-site pages. When the User-Agent or HTTP headers are set manually to get_properties() the client side properties (probably the value set to the cookie) can be manually passed to this methods as the second argument, note that this config is only used for get_properties(HEADERS). |
To change the cookie name that the client side properties would be set to. When using get_properties(HEADERS), the detection would automatically use the contents of this cookie if it exists. If you want the client side properties to be used add the DeviceAtlas Client-side component (JS lib) to your web-site pages. When the User-Agent or HTTP headers are set manually to get_properties() the client side properties (probably the value set to the cookie) can be manually passed to this method as the second argument, note that this config is only used for get_properties(HEADERS). If you set the cookie-name to None then the client side properties cookie will be ignored.
|
Set the max number of results to be cached. Depending on the frequency and distance factor of your User-Agents or headers passed to the API for detection, increasing the result cache may increase performance by preventing repeated lookups. For a large set of inputs (i.e. an almost unique set of user-agents) set to lower numbers or zero to disable.
|
Abstraction to make it easier to check if the cache is enabled on the DeviceApi instance.
|
Property Details |
cookie_nameGet the cookie name that the client side properties would be set to. When using get_properties(HEADERS), the detection would automatically use the contents of this cookie if it exists. If you want the client side properties to be used add the DeviceAtlas Client-side component (JS lib) to your web-site pages. When the User-Agent or HTTP headers are set manually to get_properties() the client side properties (probably the value set to the cookie) can be manually passed to this methods as the second argument, note that this config is only used for get_properties(HEADERS).
|
max_cache_entriesGet the max number of results to be cached.
|
Home | Trees | Indices | Help |
---|
Generated by Epydoc 3.0.1 on Tue Apr 4 10:33:31 2023 | http://epydoc.sourceforge.net |