WURFL OnSite .NET API: User Guide
=================================
Installation
------------
To enable WURFL on your application you must register for a free
account on scientiamobile.com and **download the latest release from
your [File Manager](https://filex.scientiamobile.com/user/index#products/onsite).**
The `Wurfl.dll` file must be added as a reference to any WURFL project, while the `Wurfl.Aspnet.Extensions.dll` file must be referenced only in `ASP.NET`
projects where you plan to use WURFL. For example, you don't strictly need to reference `Wurfl.Aspnet.Extensions.dll` if you're using WURFL
from within a `Console Application`.
> **Note:** As of version 1.12.11.0 we support :
Install-Package WURFLOnSite
(Install-Package WURFLOnSite.NETCore
for .NET Core projects)
Variable Name | Type | Description |
---|---|---|
**is_app** | boolean | Tells you if the Requesting HTTP Client is an App or not. |
**is_smartphone** | boolean | This is a virtual capability that will tell you if a device is a Smartphone for some arbitrary (and subject to change) definition of Smartphone by ScientiaMobile. The virtual capability returns true or false. Patch files can use the `is_smartphone` control capability to override the value returned by the virtual capability. Control capability `is_smartphone` can take value `default`, `force_true` and `force_false`. private |
**is_mobile** | boolean | This is just an ALIAS for `is_wireless_device`. There's no control capability associated to this virtual capability. private |
**is_full_desktop** | boolean | This is just an ALIAS for `ux_full_desktop`. There's no control capability associated to this virtual capability. private |
**is_windows_phone** | boolean | Check if device runs any version of Windows Phone OS. This virtual capability relies on the `device_os` (`product_info` group) capability. private |
**is_ios** | boolean | Check if device runs any version of iOS. This virtual capability relies on the `device_os` (`product_info` group) capability. private |
**is_android** | boolean | Check if device runs any version of Android OS. This virtual capability relies on the `device_os` (`product_info` group) capability. private |
**is_touchscreen** | boolean | This virtual capability tells you whether a device has a touch screen. There is no control capability. Mostly an alias for `pointing_method` == `touchscreen` (`product_info` group) capability. private |
**is_largescreen** | boolean | True if the device has a horizontal and vertical screen resolution greater than 480 pixels. Relies on the `resolution_width` and `resolution_height` (`display` group) capabilities. private |
**is_wml_preferred** | boolean | True if the device is better served with WML. Capability relies on `preferred_markup` (`markup` group). private |
**is_xhtmlmp_preferred** | boolean | True if the device is better served with XHTML MP (Mobile Profile). Capability relies on `preferred_markup` (markup group). private |
**is_html_preferred** | boolean | True if the device is better served with HTML. Capability relies on `preferred_markup` (markup group). private |
**advertised_device_os** | string | This virtual capability will infer the name of the Device OS based on user-agent string analysis (and possibly the analysis of other HTTP headers and WURFL capabilities). private |
**advertised_device_os_version** | string | This virtual capability will infer the version of the Device OS based on user-agent string analysis (and possibly the analysis of other HTTP headers and WURFL capabilities). private |
**advertised_browser** | string | This virtual capability will infer the name of the browser based on user-agent string analysis (and possibly the analysis of other HTTP headers and WURFL capabilities). private |
**advertised_browser_version** | string | This virtual capability will infer the version of the browser based on user-agent string analysis (and possibly the analysis of other HTTP headers and WURFL capabilities). private |
**form_factor** | enumerable | This virtual capability will return one of the following values that identify a client's form factor: `Desktop`, `Tablet`, `Smartphone`, `Feature Phone`, `Smart-TV`, `Robot`, `Other non-Mobile`, `Other Mobile` private |
**complete_device_name** | string | Concatenates brand name, model name and marketing name (where available) of a device into a single string. private |
**is_phone** | boolean | This is a virtual capability that will tell you if a device is a mobile phone . The virtual capability returns true or false. Patch files can use the `is_phone` control capability to override the value returned by the virtual capability. Control capability `is_phone` can take value `default`, `force_true` and `force_false`. private |
**is_app_webview** | boolean | This virtual capability returns true if a HTTP request is from an app based webview. private |
**device_name** | string | Concatenates brand name and marketing name of a device into a single string. If marketing name is not available, model name is used instead. private |
**advertised_app_name** | string | This virtual capability will return the name of the application that generated the User-Agent or the HTTP request. private |
**is_robot** | boolean |