Class adobeDPS-DeviceService

Extends:: adobeDPS-DeviceService -> adobeDPS-Service -> adobeDPS-Class
Platforms:: iOS, Android, Windows

Service for accessing information about the device.
Accessible from adobeDPS.deviceService

Constructor

adobeDPS-DeviceService()

[inner] Create an instance of the DeviceService.

Static Fields

	Field	Defined By
	adobeDPS-DeviceService.instance The singleton of the DeviceService.	DeviceService

Fields

	Field	Defined By
	updatedSignal : adobeDPS-Signal Signal to indicate that this service has been updated.	DeviceService
	deviceId : String The unique id of this device.	DeviceService
	os : String The operating system running on this device.	DeviceService
	deviceName : String The name of this device according to /system/build.prop.	DeviceService
	isPurchasingEnabled : Boolean Whether in-app purchasing is currently enabled.	DeviceService
	isOnline : Boolean Whether the device is connected to the internet or not.	DeviceService
	networkType : adobeDPS-NetworkType The type of the network the device is connected to.	DeviceService
	networkTypes : adobeDPS-NetworkType Network types enum accessor.	DeviceService
	pushNotificationToken : String The push notification token of this device.	DeviceService
	omnitureVisitorId : String The Omniture visitor id of this device.	DeviceService
	identifierForVendor : String Uniquely identifies a device to the app's vendor.	DeviceService
	advertisingIdentifier : String An alphanumeric string unique to each device, used only for serving advertisements.	DeviceService
	isAdvertisingTrackingEnabled : Boolean A Boolean value that indicates whether the user has limited ad tracking on the device (user setting on iOS devices).	DeviceService
	backgroundRefreshState : adobeDPS-BackgroundRefreshState The state of the Background App Refresh setting on the device.	DeviceService
	backgroundRefreshStates : adobeDPS-BackgroundRefreshState Background App Refresh state types enum accessor.	DeviceService

Methods

	Method	Defined By
	enableAdvertisingFramework(errorCallback:Function) Function used to enable the Advertising Framework.	DeviceService
	toString() Gets the string representation of this instance.	Class

Class Detail

adobeDPS-DeviceService()

[inner] Create an instance of the DeviceService.
- This is an internal constructor and shouldn't be called by regular users.

Static Field Details

adobeDPS-DeviceService.instance

The singleton of the DeviceService.

Platforms:: iOS, Android, Windows

Field Details

updatedSignal : adobeDPS-Signal

Signal to indicate that this service has been updated. It will pass an array of Strings containing the names of the properties that have been updated.
Callback Signature: updatedHandler([String, ...])

Platforms:: iOS, Android, Windows

deviceId : String

The unique id of this device.

Platforms:: iOS, Android, Windows

os : String

The operating system running on this device.

Platforms:: iOS, Android, Windows

deviceName : String

The name of this device according to /system/build.prop. This value will only be available on Android devices.

Platforms:: iOS, Android, Windows

isPurchasingEnabled : Boolean

Whether in-app purchasing is currently enabled. If this is false, you will not be able to initiate purchases.

Platforms:: iOS, Android, Windows

isOnline : Boolean

Whether the device is connected to the internet or not. Note: HTML5's navigator.onLine property and "offline" and "online" events should be used in most cases. This property exists for certain platforms that don't have such functionality.

Platforms:: iOS, Android, Windows

networkType : adobeDPS-NetworkType

The type of the network the device is connected to.

Platforms:: iOS, Android, Windows

networkTypes : adobeDPS-NetworkType

Network types enum accessor.
This is where you should access the adobeDPS-NetworkType enums from.

Platforms:: iOS, Android, Windows

pushNotificationToken : String

The push notification token of this device.

Platforms:: iOS

omnitureVisitorId : String

The Omniture visitor id of this device.

Platforms:: iOS, Android, Windows

identifierForVendor : String

Uniquely identifies a device to the app's vendor.

Platforms:: iOS

advertisingIdentifier : String

An alphanumeric string unique to each device, used only for serving advertisements.
Note: Supported on iOS only.
Usage: Prior to checking this property, you must call enableAdvertisingFramework() first in order to specifically enable the Advertising Framework on iOS. If you do not, the property will always return an empty string. See the Apple documentation for the ASIdentifierManager Class and the Apple iOS Programming Guide under Basics > Privacy for additional details on proper usage of advertisingIdentifier in your application. This identifier has restricted usage for privacy reasons, and failure to comply with Apple usage guidelines may result in your app being rejected for publication in the Apple App Store.

Platforms:: iOS

isAdvertisingTrackingEnabled : Boolean

A Boolean value that indicates whether the user has limited ad tracking on the device (user setting on iOS devices).
Note: Supported on iOS only.
Usage: Prior to checking this property, you must call enableAdvertisingFramework() first in order to specifically enable the Advertising Framework on iOS. If you do not, the property will always return false. See the Apple documentation for the ASIdentifierManager Class and the Apple iOS Programming Guide under Basics > Privacy for additional details on proper usage of advertisingTrackingEnabled in your application. This property has restricted usage for privacy reasons, and failure to comply with Apple usage guidelines may result in your app being rejected for publication in the Apple App Store.

Platforms:: iOS

backgroundRefreshState : adobeDPS-BackgroundRefreshState

The state of the Background App Refresh setting on the device. Reflects whether the app can be launched into the background to fetch new content.
Note: For iOS6 this property represents the Newsstand setting.

Platforms:: iOS

backgroundRefreshStates : adobeDPS-BackgroundRefreshState

Background App Refresh state types enum accessor.
This is where you should access the adobeDPS-BackgroundRefreshState enums from.

Platforms:: iOS

Method Details

enableAdvertisingFramework(errorCallback:Function)

Function used to enable the Advertising Framework. It's necessary to call this method if you are using advertising and wish to be able to use advertising info provided by system. This method will need to be called when the webview is initialized so the advertising properties can be updated accordingly. When the call is successful, the advertising properties will be updated and the signal will be sent to all the registered update handlers. If the call fails, the message will be sent to the supplied errorCallback handler and the advertising properties will not be updated.
Note:Supported on iOS only

Parameters
errorCallback	Function	The callback function that handles the error when operation fails. Callback Signature: errorHandler(errorCode, errorMessage)

Platforms:: iOS

Adobe DPS - Reading SDK 2.32

Class adobeDPS-DeviceService

Constructor

Static Fields

Fields

Methods