Documentation

Horde_ActiveSync_Device

in package

• ActiveSync

Horde_ActiveSync_Device:: Wraps all functionality related to device data.

Tags

license

http://www.horde.org/licenses/gpl GPLv2

copyright

2010-2020 Horde LLC (http://www.horde.org)

author

Michael J Rubinsky mrubinsk@horde.org

Table of Contents

ANNOUNCED_VERSION  = 'announcedVersion'

BLOCKED  = 'blocked'

IMEI  = 'Settings:IMEI'

MODEL  = 'Settings:Model'

MULTIPLEX  = 'multiplex'

MULTIPLEX_CALENDAR  = 2

MULTIPLEX_CONTACTS  = 1

MULTIPLEX_NOTES  = 8

MULTIPLEX_TASKS  = 4

NAME  = 'Settings:FriendlyName'

OPERATOR  = 'Settings:MobileOperator'

OS  = 'Settings:OS'

OS_LANGUAGE  = 'Settings:OSLanguage'

PHONE_NUMBER  = 'Settings:PhoneNumber'

QUIRK_INCORRECTLY_SENDS_EMPTY_PICTURE_TAG  = 2

iOS sends an empty picture tag on every edit of contacts whose pictures did not originate on the client itself.

QUIRK_NEEDS_SUPPORTED_PICTURE_TAG  = 1

Quirk to specify if the client fails to property ghost the POOMCONTACTS:Picture field. If this quirk is present, it means we should add the POOMCONTACTS:Picture field to the SUPPORTED array for this client.

QUIRK_SUPPORTS_TNEF  = 3

These client can support TNEF data without decoding it first.

TYPE_ANDROID  = 'android'

TYPE_BLACKBERRY  = 'blackberry'

TYPE_GMAIL  = 'gmail'

TYPE_IPAD  = 'ipad'

TYPE_IPHONE  = 'iphone'

TYPE_IPOD  = 'ipod'

TYPE_NINE  = 'nine'

TYPE_TOUCHDOWN  = 'touchdown'

TYPE_UNKNOWN  = 'unknown'

TYPE_WEBOS  = 'webos'

TYPE_WP  = 'windowsphone'

VERSION  = 'version'

$announcedVersion  : string

$blocked  : bool

$clientType  : string

$deviceType  : string

$id  : string

$multiplex  : int

$policykey  : string

$properties  : array<string|int, mixed>

$rwstatus  : int

$supported  : array<string|int, mixed>

$user  : string

$userAgent  : string

$_clientType  : string

Local override/cache of detected clientType.

$_dirty  : array<string|int, mixed>

Dirty flag

$_iOSVersion  : string

Cache of OS version.

$_multiplexSet  : bool

Flag to indicate self::multiplex was set externally.

$_properties  : array<string|int, mixed>

Device properties.

$_state  : Horde_ActiveSync_State_Base

State handler

__construct()  : mixed

Const'r

__get()  : mixed

Getter

__isset()  : mixed

Magic isset

__set()  : mixed

Setter

__toString()  : mixed

enforceProvisioning()  : bool

Check if we should enforce provisioning on this device.

getFormattedDeviceProperties()  : array<string|int, mixed>

Return an array of DEVICEINFO data, with keys suitable for displaying.

getLastSyncTimestamp()  : int

Return the last time the device issued a SYNC request.

getMajorVersion()  : int

Return the major version number of the OS (or client app) as reported by the client.

getMinorVersion()  : int

Return the minor version number of the OS (or client app) as reported by the client.

hasQuirk()  : bool

Return if this client has the described quirk.

isNonProvisionable()  : bool

Returns if the current device is an expected non-provisionable device.

needsVersionUpdate()  : bool

Indicates if we need to announce new EAS version string to the client.

normalizePoomContactsDates()  : Horde_Date

Return the number of hours to offset a POOMCONTACTS:BIRTHDAY or ANNIVERSARY field in an attempt to work around a bug in the protocol - the protocol states that "the time portion SHOULD be ignored, so that synchronizing between different timezones does not change the date" (MS-ASCNTC 2.2.2.6). However, it appears that next to zero clients actually honor this.

save()  : mixed

Save the dirty device info data.

setDeviceProperties()  : mixed

Set the device's DEVICEINFO data.

_getClientType()  : string

Attempt to determine the *client* application as opposed to the device, which may or may not be the client.

_getIosVersion()  : mixed

Detects the iOS version in M.m format and caches locally.

_isIos()  : bool

Return if this client is an iOS device. Different versions require different checks.

_isNine()  : bool

Helper method to sniff out the 9Folders client, "Nine".

_sniffMultiplex()  : mixed

Basic sniffing for determining if devices can support non-multiplexed collections.