The Client type exposes the following members.

Methods

  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetCacheDir
Getter for the cache location
Public methodGetCacheItemExpirySeconds
Getter for the cache item expiry
Public methodGetCloudUrl
Getter for service URL setting.
Public methodGetDeviceData(NameValueCollection)
Get the device data by passing in a collection of headers. The most important header is 'User-Agent', without this no device detection can take place. The other headers are used to supplement the 'User-Agent' and are useful to find devices that are not yet part of DeviceAtlas.
Public methodGetDeviceData(HttpRequest)
Get the device data by passing in a HttpRequest object. The HTTP headers are extracted from this. The most important header is 'User-Agent', without this no device detection can take place. The other headers are used to supplement the 'User-Agent' and are useful to find devices that are not yet part of DeviceAtlas.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodStatic memberGetInstance
Get the instance for the Client
Public methodGetLicenceKey
Getter for licence key
Public methodGetSendExtraHeaders
Getter for the sendExtraHeaders setting. Defaults to false. If this TRUE then extra client headers are sent with each request to the service. If this is FALSE then only select headers essential for detection are sent.
Public methodGetTestMode
Getter for testMode setting. If this is TRUE then a test User-Agent will be used for the query.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUseCache
Getter for useCache setting.
Public methodGetVersion
Get the API version
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSetCacheDir
Setter for the cache location
Public methodSetCacheItemExpirySeconds
Setter for the cache item expiry
Public methodSetCloudUrl
Setter for service URL setting. This only needs to be changed if the built in service URL is no longer active.
Public methodSetLicenceKey
Setter for licence key
Public methodSetSendExtraHeaders
Setter for the sendExtraHeaders setting. Defaults to false. If this TRUE then extra client headers are sent with each request to the service. If this is FALSE then only select headers essential for detection are sent.
Public methodSetTestMode
Setter for testMode setting. Defaults to false. If this is TRUE then a test User-Agent will be used for the query.
Public methodSetUseCache
Setter for useCache setting. Defaults to true.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)

Fields

  NameDescription
Public fieldStatic memberKEY_PROPERTIES
The properties key used in results array
Public fieldStatic memberKEY_SOURCE
The source key used in results array
Public fieldStatic memberKEY_USERAGENT
The useragent key used in results array
Public fieldStatic memberSOURCE_CACHE
The cache source of data in results array
Public fieldStatic memberSOURCE_CLOUD
The cloud source of data in results array
Public fieldStatic memberSOURCE_NONE
No source of data in results array. This only occurs if there has been an error.

See Also