API Documentation
\

\Horde_SyncMl_DataStore

The Horde_SyncMl_DataStore class describes one of the possible datastores (i.e. databases) of the device.

Most important attributes are the preferred MIME Types for sending and receiving data for this datastore: $Tx_Pref and $Rx_Pref.

Copyright 2005-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Summary

Methods
Properties
Constants
getPreferredRXContentType()
getPreferredRXContentTypeVersion()
$SourceRef
$DisplayName
$MaxGUIDSize
$Rx_Pref
$Rx
$Tx_Pref
$Tx
$DSMem
$SyncCap
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$SourceRef

$SourceRef : string

The local URI of the datastore.

Type

string

$DisplayName

$DisplayName : string

The display name of the datastore

Type

string

$MaxGUIDSize

$MaxGUIDSize : integer

The maximum size of a global unique identifier for the datastore in bytes.

Type

integer

$Rx_Pref

$Rx_Pref : array

The preferred types and versions of a content type received by the device.

The content types (CTType) are the keys, the versions (VerCT) are the values.

Type

array

$Rx

$Rx : array

The supported types and versions of a content type received by the device.

The content types (CTType) are the keys, the versions (VerCT) are the values.

Type

array

$Tx_Pref

$Tx_Pref : array

The preferred types and versions of a content type transmitted by the device.

The content types (CTType) are the keys, the versions (VerCT) are the values.

Type

array

$Tx

$Tx : array

The supported types and versions of a content type transmitted by the device.

The content types (CTType) are the keys, the versions (VerCT) are the values.

Type

array

$DSMem

$DSMem :

The maximum memory and item identifier for the datastore.

Not implemented yet.

Type

$SyncCap

$SyncCap : array

The synchronization capabilities of the datastore.

The synchronization types (SyncType) are stored in the keys of the hash.

Type

array

Methods

getPreferredRXContentType()

getPreferredRXContentType() : string

Returns the preferred content type the client wants to receive.

Returns

string —

The device's preferred content type or null if not specified (which is not allowed).

getPreferredRXContentTypeVersion()

getPreferredRXContentTypeVersion() : string

Returns the version of the preferred content type the client wants to receive.

Returns

string —

The device's preferred content type version or null if not specified (which is not allowed).