Back to index

d-push  2.0
Public Member Functions
IImportChanges Interface Reference
Inheritance diagram for IImportChanges:
Inheritance graph
[legend]
Collaboration diagram for IImportChanges:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 LoadConflicts ($contentparameters, $state)
 
Methods for to import contents
 ImportMessageChange ($id, $message)
 Imports a single message.
 ImportMessageDeletion ($id)
 Imports a deletion.
 ImportMessageReadFlag ($id, $flags)
 Imports a change in 'read' flag This can never conflict.
 ImportMessageMove ($id, $newfolder)
 Imports a move of a message.
 ImportFolderChange ($folder)
 
Methods to import hierarchy
 ImportFolderDeletion ($id, $parent=false)
 Imports a folder deletion.
 Config ($state, $flags=0)
 Constructor.
 GetState ()
 Reads and returns the current state.

Detailed Description

Definition at line 46 of file iimportchanges.php.


Member Function Documentation

IChanges::Config ( state,
flags = 0 
) [inherited]

Constructor.

Exceptions:
StatusExceptionInitializes the state and flags
Parameters:
string$state
int$flagspublic
Returns:
boolean status flag
Exceptions:
StatusException

Implemented in ImportChangesCombined, ImportChangesICS, ExportChangesICS, ChangesMemoryWrapper, ExportChangesCombined, ImportChangesStream, and DiffState.

IChanges::GetState ( ) [inherited]

Reads and returns the current state.

public

Returns:
string

Implemented in ImportChangesCombined, ExportChangesICS, ImportChangesICS, ExportChangesCombined, ChangesMemoryWrapper, DiffState, and ImportChangesStream.


Methods to import hierarchy

Imports a change on a folder

Parameters:
object$folderSyncFolder

public

Returns:
boolean/string status/id of the folder
Exceptions:
StatusException

Implemented in ImportChangesICS, ImportChangesDiff, ChangesMemoryWrapper, ImportChangesStream, and ImportChangesCombined.

IImportChanges::ImportFolderDeletion ( id,
parent = false 
)

Imports a folder deletion.

Parameters:
string$id
string$parentid

public

Returns:
boolean/int success/SYNC_FOLDERHIERARCHY_STATUS
Exceptions:
StatusException

Implemented in ImportChangesICS, ImportChangesDiff, ChangesMemoryWrapper, ImportChangesCombined, and ImportChangesStream.

IImportChanges::ImportMessageChange ( id,
message 
)

Imports a single message.

Parameters:
string$id
SyncObject$messagepublic
Returns:
boolean/string failure / id of message
Exceptions:
StatusException

Implemented in ImportChangesICS, ChangesMemoryWrapper, ImportChangesCombined, ImportChangesDiff, and ImportChangesStream.

Imports a deletion.

This may conflict if the local object has been modified

Parameters:
string$idpublic
Returns:
boolean
Exceptions:
StatusException

Implemented in ImportChangesICS, ChangesMemoryWrapper, ImportChangesDiff, ImportChangesStream, and ImportChangesCombined.

IImportChanges::ImportMessageMove ( id,
newfolder 
)

Imports a move of a message.

This occurs when a user moves an item to another folder

Parameters:
string$id
string$newfolderdestination folder

public

Returns:
boolean
Exceptions:
StatusException

Implemented in ImportChangesICS, ImportChangesDiff, ImportChangesStream, ImportChangesCombined, and ChangesMemoryWrapper.

IImportChanges::ImportMessageReadFlag ( id,
flags 
)

Imports a change in 'read' flag This can never conflict.

Parameters:
string$id
int$flagspublic
Returns:
boolean
Exceptions:
StatusException

Implemented in ImportChangesICS, ImportChangesDiff, ImportChangesStream, ImportChangesCombined, and ChangesMemoryWrapper.

IImportChanges::LoadConflicts ( contentparameters,
state 
)


Methods for to import contents

Loads objects which are expected to be exported with the state Before importing/saving the actual message from the mobile, a conflict detection should be done

Parameters:
ContentParameters$contentparameters
string$statepublic
Returns:
boolean
Exceptions:
StatusException

Implemented in ImportChangesICS, ChangesMemoryWrapper, ImportChangesCombined, ImportChangesDiff, and ImportChangesStream.


The documentation for this interface was generated from the following file: