WURFL InFuze Module for golang : User Guide
=======================================

WURFL InFuze for golang is a GO language module wrapping the WURFL C API and encapsulating it in two golang types to provide a fast and intuitive
interface. It is compatible on Linux and macOS platforms for `golang 1.7` or higher.

Installing libwurfl
-------------------

In order for the Module to work it is **ESSENTIAL** that the `libwurfl` library is installed on your system.
`libwurfl` is provided in your Customer Vault/FileX.

If you have not already installed libwurfl,
instructions can be found [here](https://docs.scientiamobile.com/documentation/infuze/infuze-c-api-user-guide).
Release notes for each API can be found [here](https://docs.scientiamobile.com/documentation/changelog/infuze-api-change-log).


Installation on Linux and macOS
-----------------------------

InFuze for golang is available as a binary package. To install it, untar the contents in your GOPATH folder. For example:

```
# cd $GOPATH
# tar xvzf golang-src-wurfl-1.12.10.0.tar.gz
```

WURFL Data Snapshot
-----
To perform lookups, you will need a copy of your WURFL data snapshot (also referred to as the `wurfl.xml`). While there is one included in the release package, it is intended to be a sample and will not contain all of your licensed capabilities. Your licensed WURFL data snapshot can be accessed by [following these directions](https://docs.scientiamobile.com/guides/wurfl-snapshot-generator).
It's strongly recommended, as first thing, to download the latest version of your WURFL data snapshot as shown in the example below.

Usage
-----

Here is an example to get started:

```
package main

import (
    "fmt"
    "scientiamobile/wurfl"
)



func main() {

    var wengine *wurfl.Wurfl
    var device *wurfl.Device

    // Download WURFL data file
    // substitute https://data.scientiamobile.com/xxxxxxx/wurfl.zip with your data URL from ScientiaMobile Vault
    // the second parameter is the destination folder where the zip file will be extracted. It must be writable by the process.
    wurfl.Download("https://data.scientiamobile.com/xxxxxxx/wurfl.zip", ".")

    wengine, err := wurfl.Create("./wurfl.zip", nil, nil, -1, wurfl.WurflCacheProviderLru, "100000")

    if err != nil {
        fmt.Println(err)
    }

    ua := "Dalvik/1.6.0 (Linux; U; Android 4.3; SM-N900T Build/JSS15J)"

    device, err = wengine.LookupUserAgent(ua)

    deviceid, err := device.GetDeviceID()

    fmt.Println(deviceid)

    fmt.Println(device.GetCapability("device_os"))
    fmt.Println(device.GetVirtualCapability("is_android"))

    device.Destroy()
    wengine.Destroy()
}
```

Create the WURFL Engine once, then lookup UserAgent and get the static and virtual capabilities needed in your implementation (**NOTE:** virtual capabilities are calculated at runtime).

If you already have a HTTP request, you can directly pass it to the WURFL API by using `wengine.LookupRequest()`. Alternately you can test passing a HTTP request to the WURFL API by creating a mock request, stuffing it with the desired test headers and passing them to the WURFL API as mentioned in the previous sentence. This is particularly useful for detecting requests with User-Agent Client Hints. In either case you can retrieve the resolved device as shown below. The static and virtual capabilities can then be requested as shown in the first snippet.

```
    req, _ := http.NewRequest("GET", "http://example.com", nil)
    UserAgent := "Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/10.0.0.0 Mobile Safari/537.36"
    req.Header.Add("User-Agent", UserAgent)
    req.Header.Add("Sec-CH-UA", "\" Not A;Brand\";v=\"99\", \"Chromium\";v=\"110\", \"Google Chrome\";v=\"110\"")
    req.Header.Add("Sec-CH-UA-Full-Version", "110.0.4430.91")
    req.Header.Add("Sec-CH-UA-Platform", "Android")
    req.Header.Add("Sec-CH-UA-Platform-Version", "11")
    req.Header.Add("Sec-CH-UA-Model", "SM-M315F")

    device, err = wengine.LookupRequest(req)
```
Additional documentation on User-Agent Client Hints and how to collect them is available [here](https://docs.scientiamobile.com/guides/implementing-useragent-clienthints).

### <a name="updater"></a>
WURFL Updater
-------------

If you want to keep your `wurfl.zip` uptodate with the ScientiaMobile data release schedule, then you might want to use the Updater features.

After creating your WURFL Engine, set your personal WURFL Snapshot URL
(in the form "https://data.scientiamobile.com/xxxxx/wurfl.zip", available in your [customer vault](https://my.scientiamobile.com/myaccount)):

```
uerr := wengine.SetUpdaterDataURL(Url)
if uerr != nil {
    fmt.Printf("SetUpdaterDataUrl returned : %s\n", uerr.Error())
}
```

Specify the periodicity you would like for update checks:

```
_ = wengine.SetUpdaterDataFrequency(wurfl.WurflUpdaterFrequencyDaily)
```

Do note that a wurfl.zip file must already be present in a writable path in order for the updater to check the file and determine whether or not it needs to update the file. You can either manually download this file by going to your WURFL Snapshot URL or by [following these directions](https://docs.scientiamobile.com/guides/wurfl-snapshot-generator).

Start the updater:

```
uerr = wengine.UpdaterStart()
if uerr != nil {
  fmt.Printf("UpdaterStart returned : %s\n", uerr.Error())
}
```

Updater will run a daily check for the latest release of the `wurfl.zip` file, download it, and update the running engine to the latest version - all during normal application operations.


Checking User-Agent frozenness and HTTP headers quality
---------------------------------

Starting from version 1.12.5.0 the `Wurfl` struct provides two new methods: `IsUserAgentFrozen()`, `GetHeaderQuality()`.

`IsUserAgentFrozen(ua string)` returns a boolean value which, if true, means that the input User-Agent string won't be updated by the sender browser.

`GetHeaderQuality()` returns an enumeration value that describes the HTTP headers quality. It has three possible values:

  - **HeaderQualityFull**: all the headers needed for a successful WURFL detection are present. Eg. a header with all UA-CH header fields present
  - **HeaderQualityBasic**: only some of the headers needed for a successful WURFL detection are present.
  - **HeaderQualityNone**: no UA-CH headers are present

API Reference
-------------


# wurfl
`import "scientiamobile/wurfl"`

* [Overview](#pkg-overview)
* [Index](#pkg-index)

## <a name="pkg-overview">Overview</a>
Package wurfl - WURFL InFuze Golang module

Package wurfl - WURFL InFuze Golang module
wurfl is a golang package wrapping the WURFL C API and encapsulating it in
2 golang types to provide a fast and intuitive interface.
It is released for linux/macos platforms.




## <a name="pkg-index">Index</a>
* [Constants](#pkg-constants)
* [Variables](#pkg-variables)
* [func APIVersion() string](#APIVersion)
* [func Download(url string, folder string) error](#Download)
* [type Device](#Device)
  * [func (d *Device) Destroy()](#Device.Destroy)
  * [func (d *Device) GetCapabilities(caps []string) map[string]string](#Device.GetCapabilities)
  * [func (d *Device) GetCapability(cap string) string](#Device.GetCapability)
  * [func (d *Device) GetCapabilityAsInt(cap string) (int, error)](#Device.GetCapabilityAsInt)
  * [func (d *Device) GetDeviceID() (string, error)](#Device.GetDeviceID)
  * [func (d *Device) GetMatchType() int](#Device.GetMatchType)
  * [func (d *Device) GetNormalizedUserAgent() (string, error)](#Device.GetNormalizedUserAgent)
  * [func (d *Device) GetOriginalUserAgent() (string, error)](#Device.GetOriginalUserAgent)
  * [func (d *Device) GetParentID() string](#Device.GetParentID)
  * [func (d *Device) GetRootID() string](#Device.GetRootID)
  * [func (d *Device) GetStaticCap(cap string) (string, error)](#Device.GetStaticCap)
  * [func (d *Device) GetStaticCaps(caps []string) (map[string]string, error)](#Device.GetStaticCaps)
  * [func (d *Device) GetUserAgent() (string, error)](#Device.GetUserAgent)
  * [func (d *Device) GetVirtualCap(vcap string) (string, error)](#Device.GetVirtualCap)
  * [func (d *Device) GetVirtualCapabilities(caps []string) map[string]string](#Device.GetVirtualCapabilities)
  * [func (d *Device) GetVirtualCapability(vcap string) string](#Device.GetVirtualCapability)
  * [func (d *Device) GetVirtualCapabilityAsInt(vcap string) (int, error)](#Device.GetVirtualCapabilityAsInt)
  * [func (d *Device) GetVirtualCaps(caps []string) (map[string]string, error)](#Device.GetVirtualCaps)
  * [func (d *Device) IsRoot() bool](#Device.IsRoot)
* [type DeviceHandler](#DeviceHandler)
* [type HeaderQuality](#HeaderQuality)
  * [func (hq HeaderQuality) String() string](#HeaderQuality.String)
* [type Updater](#Updater)
* [type Wurfl](#Wurfl)
  * [func Create(Wurflxml string, Patches []string, CapFilter []string, EngineTarget int, CacheProvider int, CacheExtraConfig string) (*Wurfl, error)](#Create)
  * [func (w *Wurfl) Destroy()](#Wurfl.Destroy)
  * [func (w *Wurfl) GetAPIVersion() string](#Wurfl.GetAPIVersion)
  * [func (w *Wurfl) GetAllCaps() []string](#Wurfl.GetAllCaps)
  * [func (w *Wurfl) GetAllDeviceIds() []string](#Wurfl.GetAllDeviceIds)
  * [func (w *Wurfl) GetAllVCaps() []string](#Wurfl.GetAllVCaps)
  * [func (w *Wurfl) GetAttr(attr int) (int, error)](#Wurfl.GetAttr)
  * [func (w *Wurfl) GetEngineTarget() string](#Wurfl.GetEngineTarget)
  * [func (w *Wurfl) GetHeaderQuality(r *http.Request) (HeaderQuality, error)](#Wurfl.GetHeaderQuality)
  * [func (w *Wurfl) GetInfo() string](#Wurfl.GetInfo)
  * [func (w *Wurfl) GetLastLoadTime() string](#Wurfl.GetLastLoadTime)
  * [func (w *Wurfl) GetLastUpdated() string](#Wurfl.GetLastUpdated)
  * [func (w *Wurfl) GetUpdaterUserAgent() string](#Wurfl.GetUpdaterUserAgent)
  * [func (w *Wurfl) GetUserAgentPriority() string](#Wurfl.GetUserAgentPriority)
  * [func (w *Wurfl) GoStringToCStringUsingMap(capname string) *C.char](#Wurfl.GoStringToCStringUsingMap)
  * [func (w *Wurfl) HasCapability(cap string) bool](#Wurfl.HasCapability)
  * [func (w *Wurfl) HasVirtualCapability(vcap string) bool](#Wurfl.HasVirtualCapability)
  * [func (w *Wurfl) IsUserAgentFrozen(ua string) bool](#Wurfl.IsUserAgentFrozen)
  * [func (w *Wurfl) LookupDeviceID(DeviceID string) (*Device, error)](#Wurfl.LookupDeviceID)
  * [func (w *Wurfl) LookupDeviceIDWithImportantHeaderMap(DeviceID string, IHMap map[string]string) (*Device, error)](#Wurfl.LookupDeviceIDWithImportantHeaderMap)
  * [func (w *Wurfl) LookupDeviceIDWithRequest(DeviceID string, r *http.Request) (*Device, error)](#Wurfl.LookupDeviceIDWithRequest)
  * [func (w *Wurfl) LookupRequest(r *http.Request) (*Device, error)](#Wurfl.LookupRequest)
  * [func (w *Wurfl) LookupUserAgent(ua string) (*Device, error)](#Wurfl.LookupUserAgent)
  * [func (w *Wurfl) LookupWithImportantHeaderMap(IHMap map[string]string) (*Device, error)](#Wurfl.LookupWithImportantHeaderMap)
  * [func (w *Wurfl) SetAttr(attr int, value int) error](#Wurfl.SetAttr)
  * [func (w *Wurfl) SetLogPath(LogFile string) error](#Wurfl.SetLogPath)
  * [func (w *Wurfl) SetUpdaterDataFrequency(Frequency int) error](#Wurfl.SetUpdaterDataFrequency)
  * [func (w *Wurfl) SetUpdaterDataURL(DataURL string) error](#Wurfl.SetUpdaterDataURL)
  * [func (w *Wurfl) SetUpdaterDataURLTimeout(ConnectionTimeout int, DataTransferTimeout int) error](#Wurfl.SetUpdaterDataURLTimeout)
  * [func (w *Wurfl) SetUpdaterLogPath(LogFile string) error](#Wurfl.SetUpdaterLogPath)
  * [func (w *Wurfl) SetUpdaterUserAgent(userAgent string) error](#Wurfl.SetUpdaterUserAgent)
  * [func (w *Wurfl) SetUserAgentPriority(prio int)](#Wurfl.SetUserAgentPriority)
  * [func (w *Wurfl) UpdaterRunonce() error](#Wurfl.UpdaterRunonce)
  * [func (w *Wurfl) UpdaterStart() error](#Wurfl.UpdaterStart)
  * [func (w *Wurfl) UpdaterStop() error](#Wurfl.UpdaterStop)
* [type WurflHandler](#WurflHandler)


#### <a name="pkg-files">Package files</a>
[interface.go]
[wurfl.go]


## <a name="pkg-constants">Constants</a>
``` go
const (
    WurflEngineTargetHighAccuray             = C.WURFL_ENGINE_TARGET_HIGH_ACCURACY
    WurflEngineTargetHighPerformance         = C.WURFL_ENGINE_TARGET_HIGH_PERFORMANCE
    WurflEngineTargetDefault                 = C.WURFL_ENGINE_TARGET_DEFAULT
    WurflEngineTargetFastDesktopBrowserMatch = C.WURFL_ENGINE_TARGET_FAST_DESKTOP_BROWSER_MATCH
)
```
Engine Target possible values
DEPRECATED as of 1.9.5.0

``` go
const (
    WurflUserAgentPriorityOverrideSideloadedBrowserUserAgent = C.WURFL_USERAGENT_PRIORITY_OVERRIDE_SIDELOADED_BROWSER_USERAGENT
    WurflUserAgentPriorityUsePlainUserAgent                  = C.WURFL_USERAGENT_PRIORITY_USE_PLAIN_USERAGENT
)
```
UserAgent priority possible values
DEPRECATED as of 1.9.5.0

``` go
const (
    // WurflAttrExtraHeadersExperimental is deprecated since 1.12.5.0 and should not be used.
    WurflAttrExtraHeadersExperimental = C.WURFL_ATTR_EXTRA_HEADERS_EXPERIMENTAL
    // WurflAttrCapabilityFallbackCache attribute controls the capability fallback cache (needs libwurfl version 1.12.9.3 or above)
    WurflAttrCapabilityFallbackCache = C.WURFL_ATTR_CAPABILITY_FALLBACK_CACHE
)
```
``` go
const (
    // WurflAttrCapabilityFallbackCacheDefault is the default setting for capability fallback cache
    WurflAttrCapabilityFallbackCacheDefault = C.WURFL_ATTR_CAPABILITY_FALLBACK_CACHE_DEFAULT
    // WurflAttrCapabilityFallbackCacheDisabled disables the capability fallback cache
    WurflAttrCapabilityFallbackCacheDisabled = C.WURFL_ATTR_CAPABILITY_FALLBACK_CACHE_DISABLED
    // WurflAttrCapabilityFallbackCacheLimited sets the capability fallback cache to limited mode
    WurflAttrCapabilityFallbackCacheLimited = C.WURFL_ATTR_CAPABILITY_FALLBACK_CACHE_LIMITED
)
```
To control capability fallback cache, needs libwurfl version 1.12.9.3 or above

``` go
const (
    WurflCacheProviderDefault = -1
    WurflCacheProviderNone    = C.WURFL_CACHE_PROVIDER_NONE
    WurflCacheProviderLru     = C.WURFL_CACHE_PROVIDER_LRU
    // Deprecated: use WurflCacheProviderLru instead
    WurflCacheProviderDoubleLru = C.WURFL_CACHE_PROVIDER_DOUBLE_LRU
)
```
Cache Provider possible values

``` go
const (
    WurflMatchTypeExact           = C.WURFL_MATCH_TYPE_EXACT
    WurflMatchTypeConclusive      = C.WURFL_MATCH_TYPE_CONCLUSIVE
    WurflMatchTypeRecovery        = C.WURFL_MATCH_TYPE_RECOVERY
    WurflMatchTypeCatchall        = C.WURFL_MATCH_TYPE_CATCHALL
    WurflMatchTypeHighPerformance = C.WURFL_MATCH_TYPE_HIGHPERFORMANCE
    WurflMatchTypeNone            = C.WURFL_MATCH_TYPE_NONE
    WurflMatchTypeCached          = C.WURFL_MATCH_TYPE_CACHED
)
```
Match type

``` go
const (
    WurflEnumStaticCapabilities    = C.WURFL_ENUM_STATIC_CAPABILITIES
    WurflEnumVirtualCapabilities   = C.WURFL_ENUM_VIRTUAL_CAPABILITIES
    WurflEnumMandatoryCapabilities = C.WURFL_ENUM_MANDATORY_CAPABILITIES
    WurflEnumWurflID               = C.WURFL_ENUM_WURFLID
)
```
Wurfl enumerator type

``` go
const (
    WurflUpdaterFrequencyDaily  = C.WURFL_UPDATER_FREQ_DAILY
    WurflUpdaterFrequencyWeekly = C.WURFL_UPDATER_FREQ_WEEKLY
)
```
Wurfl updater frequency


## <a name="pkg-variables">Variables</a>
``` go
var Version = "1.26"
```
Version is the current version of this package.



## <a name="APIVersion">func</a> APIVersion
``` go
func APIVersion() string
```
APIVersion returns version of internal InFuze API without an initialized engine



## <a name="Download">func</a> Download
``` go
func Download(url string, folder string) error
```
Download downloads the WURFL data file from the specified URL and saves it to the specified folder.
If the download is successful, it returns nil. Otherwise, it returns an error.




## <a name="Device">type</a> Device
``` go
type Device struct {
    Device C.wurfl_device_handle
    Wurfl  C.wurfl_handle
    // contains filtered or unexported fields
}

```
Device represent internal matched device handle










### <a name="Device.Destroy">func</a> (\*Device) Destroy
``` go
func (d *Device) Destroy()
```
Destroy device handle, should be called when when device attributes
are not needed anymore




### <a name="Device.GetCapabilities">func</a> (\*Device) GetCapabilities
``` go
func (d *Device) GetCapabilities(caps []string) map[string]string
```
GetCapabilities Get a list of Static Capabilities
Deprecated: GetCapabilities is deprecated. Use GetStaticCaps instead.




### <a name="Device.GetCapability">func</a> (\*Device) GetCapability
``` go
func (d *Device) GetCapability(cap string) string
```
GetCapability Get a single Capability
Deprecated: GetCapability is deprecated. Use GetStaticCap instead.




### <a name="Device.GetCapabilityAsInt">func</a> (\*Device) GetCapabilityAsInt
``` go
func (d *Device) GetCapabilityAsInt(cap string) (int, error)
```
GetCapabilityAsInt gets a single capability value that has a int type
It returns an error if the requested capability is not a numeric one (ie: brand_name)




### <a name="Device.GetDeviceID">func</a> (\*Device) GetDeviceID
``` go
func (d *Device) GetDeviceID() (string, error)
```
GetDeviceID Get wurfl_id string from device handle




### <a name="Device.GetMatchType">func</a> (\*Device) GetMatchType
``` go
func (d *Device) GetMatchType() int
```
GetMatchType Get type of Match occurred in lookup




### <a name="Device.GetNormalizedUserAgent">func</a> (\*Device) GetNormalizedUserAgent
``` go
func (d *Device) GetNormalizedUserAgent() (string, error)
```
GetNormalizedUserAgent Get the Normalized (processed by wurfl api) userAgent ( Only for internal use/tooling)




### <a name="Device.GetOriginalUserAgent">func</a> (\*Device) GetOriginalUserAgent
``` go
func (d *Device) GetOriginalUserAgent() (string, error)
```
GetOriginalUserAgent Get the original userAgent of matched device (the one passed to lookup)




### <a name="Device.GetParentID">func</a> (\*Device) GetParentID
``` go
func (d *Device) GetParentID() string
```
GetParentID - Retrieve the parent device id of this device.




### <a name="Device.GetRootID">func</a> (\*Device) GetRootID
``` go
func (d *Device) GetRootID() string
```
GetRootID - Retrieve the root device id of this device.




### <a name="Device.GetStaticCap">func</a> (\*Device) GetStaticCap
``` go
func (d *Device) GetStaticCap(cap string) (string, error)
```
GetStaticCap Get a single cap using new C.wurfl_device_get_static_cap()
that returns error




### <a name="Device.GetStaticCaps">func</a> (\*Device) GetStaticCaps
``` go
func (d *Device) GetStaticCaps(caps []string) (map[string]string, error)
```
GetStaticCaps Get a list of Static Capabilities




### <a name="Device.GetUserAgent">func</a> (\*Device) GetUserAgent
``` go
func (d *Device) GetUserAgent() (string, error)
```
GetUserAgent Get default UserAgent of matched device (might be different from UA passed to lookup)




### <a name="Device.GetVirtualCap">func</a> (\*Device) GetVirtualCap
``` go
func (d *Device) GetVirtualCap(vcap string) (string, error)
```
GetVirtualCap Get Virtual Cap with new C.wurfl_device_get_virtual_cap()
that manages errors




### <a name="Device.GetVirtualCapabilities">func</a> (\*Device) GetVirtualCapabilities
``` go
func (d *Device) GetVirtualCapabilities(caps []string) map[string]string
```
GetVirtualCapabilities Get a list of Virtual Capabilities
Deprecated: GetVirtualCapabilities is deprecated. Use GetVirtualCaps instead.




### <a name="Device.GetVirtualCapability">func</a> (\*Device) GetVirtualCapability
``` go
func (d *Device) GetVirtualCapability(vcap string) string
```
GetVirtualCapability Get Virtual Capability
Deprecated: GetVirtualCapability is deprecated. Use GetVirtualCap instead.




### <a name="Device.GetVirtualCapabilityAsInt">func</a> (\*Device) GetVirtualCapabilityAsInt
``` go
func (d *Device) GetVirtualCapabilityAsInt(vcap string) (int, error)
```
GetVirtualCapabilityAsInt gets a single virtual capability value that has a int type
It returns an error if the requested virtual capability is not a numeric one (ie: brand_name)




### <a name="Device.GetVirtualCaps">func</a> (\*Device) GetVirtualCaps
``` go
func (d *Device) GetVirtualCaps(caps []string) (map[string]string, error)
```
GetVirtualCaps Get a list of Virtual Capabilities




### <a name="Device.IsRoot">func</a> (\*Device) IsRoot
``` go
func (d *Device) IsRoot() bool
```
IsRoot - true if device is device root




## <a name="DeviceHandler">type</a> DeviceHandler
``` go
type DeviceHandler interface {
    GetMatchType() int
    GetVirtualCapabilities(caps []string) map[string]string
    GetVirtualCaps(caps []string) (map[string]string, error)
    GetVirtualCapability(vcap string) string
    GetVirtualCap(vcap string) (string, error)
    GetVirtualCapabilityAsInt(vcsp string) (int, error)
    GetCapabilities(caps []string) map[string]string
    GetStaticCaps(caps []string) (map[string]string, error)
    GetCapability(cap string) string
    GetStaticCap(cap string) (string, error)
    GetCapabilityAsInt(cap string) (int, error)
    IsRoot() bool
    GetRootID() string
    GetParentID() string
    GetDeviceID() (string, error)
    GetNormalizedUserAgent() (string, error)
    GetOriginalUserAgent() (string, error)
    GetUserAgent() (string, error)
    Destroy()
}
```
DeviceHandler defines API methods for the Wurfl Device handle










## <a name="HeaderQuality">type</a> HeaderQuality
``` go
type HeaderQuality int
```
HeaderQuality represents the header quality value


``` go
const (
    // HeaderQualityNone no User Agent Client Hints are present.
    HeaderQualityNone HeaderQuality = C.WURFL_ENUM_UACH_NONE
    // HeaderQualityBasic only some of the headers needed for a successful WURFL detection are present.
    HeaderQualityBasic HeaderQuality = C.WURFL_ENUM_UACH_BASIC
    // HeaderQualityFull all the headers needed for a successful WURFL detection are present.
    HeaderQualityFull HeaderQuality = C.WURFL_ENUM_UACH_FULL
)
```









### <a name="HeaderQuality.String">func</a> (HeaderQuality) String
``` go
func (hq HeaderQuality) String() string
```



## <a name="Updater">type</a> Updater
``` go
type Updater interface {
    SetUpdaterDataURL(DataURL string) error
    SetUpdaterDataFrequency(Frequency int) error
    SetUpdaterDataURLTimeout(ConnectionTimeout int, DataTransferTimeout int) error
    SetUpdaterLogPath(LogFile string) error
    UpdaterRunonce() error
    UpdaterStart() error
    UpdaterStop() error
    SetUpdaterUserAgent(userAgent string) error
    GetUpdaterUserAgent() string
}
```
Updater defines API methods for the Updater










## <a name="Wurfl">type</a> Wurfl
``` go
type Wurfl struct {
    Wurfl                C.wurfl_handle
    ImportantHeaderNames []string
    // contains filtered or unexported fields
}

```
Wurfl represents internal wurfl infuze handle







### <a name="Create">func</a> Create
``` go
func Create(Wurflxml string, Patches []string, CapFilter []string, EngineTarget int, CacheProvider int, CacheExtraConfig string) (*Wurfl, error)
```
Create the wurfl engine.Parameters :
Wurflxml : path to the wurfl.xml/zip file
Patches : slice of paths of patches files to load
CapFilter : list of capabilities used; allow to init engine without loading all 500+ caps
DEPRECATED: EngineTarget : As of 1.9.5.0 has no effect anymore
CacheProvider : WurflCacheProviderLru or WurflCacheProviderDoubleLru
CacheExtraConfig : size of single or double lru caches in the form "100000" or "100000,30000"





### <a name="Wurfl.Destroy">func</a> (\*Wurfl) Destroy
``` go
func (w *Wurfl) Destroy()
```
Destroy the wurfl engine




### <a name="Wurfl.GetAPIVersion">func</a> (\*Wurfl) GetAPIVersion
``` go
func (w *Wurfl) GetAPIVersion() string
```
GetAPIVersion returns version of internal InFuze API




### <a name="Wurfl.GetAllCaps">func</a> (\*Wurfl) GetAllCaps
``` go
func (w *Wurfl) GetAllCaps() []string
```
GetAllCaps return all capabilities names




### <a name="Wurfl.GetAllDeviceIds">func</a> (\*Wurfl) GetAllDeviceIds
``` go
func (w *Wurfl) GetAllDeviceIds() []string
```
GetAllDeviceIds returns a slice containing all WURFL device IDs




### <a name="Wurfl.GetAllVCaps">func</a> (\*Wurfl) GetAllVCaps
``` go
func (w *Wurfl) GetAllVCaps() []string
```
GetAllVCaps return all virtual capabilities names




### <a name="Wurfl.GetAttr">func</a> (\*Wurfl) GetAttr
``` go
func (w *Wurfl) GetAttr(attr int) (int, error)
```
GetAttr : get we engine attributes




### <a name="Wurfl.GetEngineTarget">func</a> (\*Wurfl) GetEngineTarget
``` go
func (w *Wurfl) GetEngineTarget() string
```
GetEngineTarget - Returns a string representing the currently set WURFL Engine Target. Possible values are "HIGH_ACCURACY", "HIGH_PERFORMANCE" or "INVALID".
DEPRECATED: will always return default value




### <a name="Wurfl.GetHeaderQuality">func</a> (\*Wurfl) GetHeaderQuality
``` go
func (w *Wurfl) GetHeaderQuality(r *http.Request) (HeaderQuality, error)
```
GetHeaderQuality return the header quality value of HTTP request headers




### <a name="Wurfl.GetInfo">func</a> (\*Wurfl) GetInfo
``` go
func (w *Wurfl) GetInfo() string
```
GetInfo - get wurfl.xml info




### <a name="Wurfl.GetLastLoadTime">func</a> (\*Wurfl) GetLastLoadTime
``` go
func (w *Wurfl) GetLastLoadTime() string
```
GetLastLoadTime - get last wurfl.xml load time




### <a name="Wurfl.GetLastUpdated">func</a> (\*Wurfl) GetLastUpdated
``` go
func (w *Wurfl) GetLastUpdated() string
```
GetLastUpdated - get last wurfl.xml update time




### <a name="Wurfl.GetUpdaterUserAgent">func</a> (\*Wurfl) GetUpdaterUserAgent
``` go
func (w *Wurfl) GetUpdaterUserAgent() string
```
GetUpdaterUserAgent - gets your scientiamobile vault https updater url




### <a name="Wurfl.GetUserAgentPriority">func</a> (\*Wurfl) GetUserAgentPriority
``` go
func (w *Wurfl) GetUserAgentPriority() string
```
GetUserAgentPriority - Tells if WURFL is using the plain user agent or the sideloaded browser user agent for device detection
DEPRECATED: will always return default value




### <a name="Wurfl.GoStringToCStringUsingMap">func</a> (\*Wurfl) GoStringToCStringUsingMap
``` go
func (w *Wurfl) GoStringToCStringUsingMap(capname string) *C.char
```
GoStringToCStringUsingMap returns a C string pointer for the given capability name using a cached map.




### <a name="Wurfl.HasCapability">func</a> (\*Wurfl) HasCapability
``` go
func (w *Wurfl) HasCapability(cap string) bool
```
HasCapability - HasVirtualCapability return true is the vcap exists




### <a name="Wurfl.HasVirtualCapability">func</a> (\*Wurfl) HasVirtualCapability
``` go
func (w *Wurfl) HasVirtualCapability(vcap string) bool
```
HasVirtualCapability - HasVirtualCapability return true is the vcap exists




### <a name="Wurfl.IsUserAgentFrozen">func</a> (\*Wurfl) IsUserAgentFrozen
``` go
func (w *Wurfl) IsUserAgentFrozen(ua string) bool
```
IsUserAgentFrozen : returns true if an useragent is frozen




### <a name="Wurfl.LookupDeviceID">func</a> (\*Wurfl) LookupDeviceID
``` go
func (w *Wurfl) LookupDeviceID(DeviceID string) (*Device, error)
```
LookupDeviceID : lookup by wurfl_ID and return Device handle




### <a name="Wurfl.LookupDeviceIDWithImportantHeaderMap">func</a> (\*Wurfl) LookupDeviceIDWithImportantHeaderMap
``` go
func (w *Wurfl) LookupDeviceIDWithImportantHeaderMap(DeviceID string, IHMap map[string]string) (*Device, error)
```
LookupDeviceIDWithImportantHeaderMap : Lookup deviceID using header values found in IHMap.
IHMap must be filled with Wurfl.ImportantHeaderNames values




### <a name="Wurfl.LookupDeviceIDWithRequest">func</a> (\*Wurfl) LookupDeviceIDWithRequest
``` go
func (w *Wurfl) LookupDeviceIDWithRequest(DeviceID string, r *http.Request) (*Device, error)
```
LookupDeviceIDWithRequest : lookup by wurfl_ID and request headers and return Device handle




### <a name="Wurfl.LookupRequest">func</a> (\*Wurfl) LookupRequest
``` go
func (w *Wurfl) LookupRequest(r *http.Request) (*Device, error)
```
LookupRequest : Lookup Request and return Device handle




### <a name="Wurfl.LookupUserAgent">func</a> (\*Wurfl) LookupUserAgent
``` go
func (w *Wurfl) LookupUserAgent(ua string) (*Device, error)
```
LookupUserAgent : lookup up useragent and return Device handle




### <a name="Wurfl.LookupWithImportantHeaderMap">func</a> (\*Wurfl) LookupWithImportantHeaderMap
``` go
func (w *Wurfl) LookupWithImportantHeaderMap(IHMap map[string]string) (*Device, error)
```
LookupWithImportantHeaderMap : Lookup using header values found in IHMap.
IHMap must be filled with Wurfl.ImportantHeaderNames values




### <a name="Wurfl.SetAttr">func</a> (\*Wurfl) SetAttr
``` go
func (w *Wurfl) SetAttr(attr int, value int) error
```
SetAttr : we engine attributes




### <a name="Wurfl.SetLogPath">func</a> (\*Wurfl) SetLogPath
``` go
func (w *Wurfl) SetLogPath(LogFile string) error
```
SetLogPath - set path of main libwurfl log file (updater has a separate log file)




### <a name="Wurfl.SetUpdaterDataFrequency">func</a> (\*Wurfl) SetUpdaterDataFrequency
``` go
func (w *Wurfl) SetUpdaterDataFrequency(Frequency int) error
```
SetUpdaterDataFrequency - set interval of update checks




### <a name="Wurfl.SetUpdaterDataURL">func</a> (\*Wurfl) SetUpdaterDataURL
``` go
func (w *Wurfl) SetUpdaterDataURL(DataURL string) error
```
SetUpdaterDataURL - set your scientiamobile vault https updater url




### <a name="Wurfl.SetUpdaterDataURLTimeout">func</a> (\*Wurfl) SetUpdaterDataURLTimeout
``` go
func (w *Wurfl) SetUpdaterDataURLTimeout(ConnectionTimeout int, DataTransferTimeout int) error
```
SetUpdaterDataURLTimeout - set connection and data transfer timeouts (in millisecs) for updater
http call. 0 for no timeout, -1 for defaults




### <a name="Wurfl.SetUpdaterLogPath">func</a> (\*Wurfl) SetUpdaterLogPath
``` go
func (w *Wurfl) SetUpdaterLogPath(LogFile string) error
```
SetUpdaterLogPath - set path of updater log file




### <a name="Wurfl.SetUpdaterUserAgent">func</a> (\*Wurfl) SetUpdaterUserAgent
``` go
func (w *Wurfl) SetUpdaterUserAgent(userAgent string) error
```
SetUpdaterUserAgent - set your scientiamobile vault https updater url




### <a name="Wurfl.SetUserAgentPriority">func</a> (\*Wurfl) SetUserAgentPriority
``` go
func (w *Wurfl) SetUserAgentPriority(prio int)
```
SetUserAgentPriority - Sets which UA wurfl is using (plain or sideloaded)
DEPRECATED. Since 1.9.5.0 has no effect anymore




### <a name="Wurfl.UpdaterRunonce">func</a> (\*Wurfl) UpdaterRunonce
``` go
func (w *Wurfl) UpdaterRunonce() error
```
UpdaterRunonce - start updater process once and wait for termination




### <a name="Wurfl.UpdaterStart">func</a> (\*Wurfl) UpdaterStart
``` go
func (w *Wurfl) UpdaterStart() error
```
UpdaterStart - start the updater thread




### <a name="Wurfl.UpdaterStop">func</a> (\*Wurfl) UpdaterStop
``` go
func (w *Wurfl) UpdaterStop() error
```
UpdaterStop - stop the updater thread




## <a name="WurflHandler">type</a> WurflHandler
``` go
type WurflHandler interface {
    GetAPIVersion() string
    Download(url string, folder string) error
    SetLogPath(LogFile string) error
    IsUserAgentFrozen(ua string) bool
    LookupDeviceIDWithImportantHeaderMap(DeviceID string, IHMap map[string]string) (DeviceHandler, error)
    LookupWithImportantHeaderMap(IHMap map[string]string) (DeviceHandler, error)
    LookupDeviceIDWithRequest(DeviceID string, r *http.Request) (DeviceHandler, error)
    LookupRequest(r *http.Request) (DeviceHandler, error)
    LookupUserAgent(ua string) (DeviceHandler, error)
    GetAllDeviceIds() []string
    LookupDeviceID(DeviceID string) (DeviceHandler, error)
    Destroy()
    GetAllVCaps() []string
    GetAllCaps() []string
    GetInfo() string
    GetHeaderQuality(r *http.Request) (HeaderQuality, error)
    GetLastLoadTime() string
    HasCapability(cap string) bool
    HasVirtualCapability(vcap string) bool
    SetAttr(attr int, value int) error
    GetAttr(attr int) (int, error)
    GetLastUpdated() string
}
```
WurflHandler defines API methods for the Wurfl Infuze handle











- - -


-------

**&copy; 2025 ScientiaMobile Inc.<br>
All Rights Reserved.**

**NOTICE:** All information contained herein is, and remains the property of ScientiaMobile Incorporated
and its suppliers, if any.  The intellectual and technical concepts contained herein are proprietary to
ScientiaMobile Incorporated and its suppliers and may be covered by U.S. and Foreign Patents, patents
in process, and are protected by trade secret or copyright law. Dissemination of this information or
reproduction of this material is strictly forbidden unless prior written permission is obtained from
ScientiaMobile Incorporated.