blueZync

Synchronize Bluetooth phone with Thunderbird

Users

Developers

Links

SourceForge.net
Develpers' detailed documentation for the Thunderbird Extension for synchronizing a bluetooth phone with Thunderbird/Lightning/Sunbird.
A part of blueZync.

IBZOpenSync Interface Reference

Inheritance diagram for IBZOpenSync:

BZOpenSync List of all members.

Detailed Description

Wrapper around the OpenSync library.


Public Member Functions

void CreateGroup (in ACString groupName, in ACString pluginName1, in ACString xmlConfig1, in ACString pluginName2, in ACString xmlConfig2)
 Create new OpenSync group.
void Finalize ()
 Finalize use of OpenSync library.
void GetConflict (in PRUint32 iConflict, out ACString data1, out ACString data2)
 Get data for conflict.
boolean GetFinished ()
 Has thread finished?
void GetGroup (in ACString groupName, out ACString pluginName1, out ACString xmlConfig1, out ACString pluginName2, out ACString xmlConfig2)
 Get OpenSync group.
nsIArray GetGroups ()
 Get list of OpenSync groups.
ACString GetLastError ()
 Get last error.
PRInt32 GetNumberOfConflicts ()
 Get number of conflicts reported.
nsIArray GetPlugins ()
 Get list of OpenSync plugins.
ACString GetStatus ()
 Get current status of thread.
boolean HasGroup (in ACString groupName)
 Check of OpenSync has a group with the given name.
void Initialize (in ACString pathToGroupDir)
 Initialize OpenSync library.
void ResolveConflict (in PRUint32 iConflict, in PRInt16 iresolution)
 Resolve conflict.
void StartDiscover (in ACString groupName)
 Start discovery of object formats for group.
void StartSync (in ACString groupName)
 Start synchronizing group.
void UpdateGroup (in ACString groupName, in ACString newGroupName, in ACString pluginName1, in ACString xmlConfig1, in ACString pluginName2, in ACString xmlConfig2)
 Update OpenSync group.

Member Function Documentation

void IBZOpenSync::CreateGroup ( in ACString  groupName,
in ACString  pluginName1,
in ACString  xmlConfig1,
in ACString  pluginName2,
in ACString  xmlConfig2 
)

Create new OpenSync group.

The group will have exactly two members

  • first member is usually thunderbird
  • second member is usually bluetooth device

Parameters:
groupName name of the new group (must be unique)
pluginName1 name of the plugin for first group member (usually mozilla-sync)
xmlConfig1 string with the XML configuration for first group member
pluginName2 name of the plugin for second group member
xmlConfig2 string with the XML configuration for second group member

void IBZOpenSync::Finalize (  ) 

Finalize use of OpenSync library.

void IBZOpenSync::GetConflict ( in PRUint32  iConflict,
out ACString  data1,
out ACString  data2 
)

Get data for conflict.

Parameters:
iConflict conflict number (0 to GetNumberOfConflicts-1)
data1 data for first group member (usually mozilla-sync)
data2 data for second group member

boolean IBZOpenSync::GetFinished (  ) 

Has thread finished?

Returns:
true if thread has finished; false if thread is still not done

void IBZOpenSync::GetGroup ( in ACString  groupName,
out ACString  pluginName1,
out ACString  xmlConfig1,
out ACString  pluginName2,
out ACString  xmlConfig2 
)

Get OpenSync group.

Get group information: plugin names and configuration.

  • only works for groups with two members

Parameters:
groupName name of the group
pluginName1 name of the plugin for first group member (usually mozilla-sync)
xmlConfig1 string with the XML configuration for first group member
pluginName2 name of the plugin for second group member
xmlConfig2 string with the XML configuration for second group member

nsIArray IBZOpenSync::GetGroups (  ) 

Get list of OpenSync groups.

Returns:
list of OpenSync groups found Each item in the list is the name of the group as a nsISupportsCString

ACString IBZOpenSync::GetLastError (  ) 

Get last error.

Returns:
description of last error encountered

PRInt32 IBZOpenSync::GetNumberOfConflicts (  ) 

Get number of conflicts reported.

Returns:
-1 if conflicts not reported yet; 0 if no conflicts; >0 number of conflicts reported

nsIArray IBZOpenSync::GetPlugins (  ) 

Get list of OpenSync plugins.

Returns:
list of OpenSync plugins found Each item in the list is the name of the plugin as a nsISupportsCString

ACString IBZOpenSync::GetStatus (  ) 

Get current status of thread.

Returns:
current status of thread

boolean IBZOpenSync::HasGroup ( in ACString  groupName  ) 

Check of OpenSync has a group with the given name.

Parameters:
groupName name of the group we want to check for
Returns:
TRUE if group found; otherwise FALSE

void IBZOpenSync::Initialize ( in ACString  pathToGroupDir  ) 

Initialize OpenSync library.

Parameters:
pathToGroupDir path to where OpenSync groups are stored

void IBZOpenSync::ResolveConflict ( in PRUint32  iConflict,
in PRInt16  iresolution 
)

Resolve conflict.

Parameters:
iConflict conflict number (0 to GetNumberOfConflicts-1)
iresolution -1: ignore; 0: duplicate; 1: first group member; 2: second group member

void IBZOpenSync::StartDiscover ( in ACString  groupName  ) 

Start discovery of object formats for group.

Parameters:
groupName name of the group to discover

void IBZOpenSync::StartSync ( in ACString  groupName  ) 

Start synchronizing group.

Parameters:
groupName name of the group to synchronize

void IBZOpenSync::UpdateGroup ( in ACString  groupName,
in ACString  newGroupName,
in ACString  pluginName1,
in ACString  xmlConfig1,
in ACString  pluginName2,
in ACString  xmlConfig2 
)

Update OpenSync group.

Update group with plugin names and configuration.

  • only works for groups with two members

Parameters:
groupName name of the new group
newGroupName rename group to this name
pluginName1 name of the plugin for first group member (usually mozilla-sync)
xmlConfig1 string with the XML configuration for first group member
pluginName2 name of the plugin for second group member
xmlConfig2 string with the XML configuration for second group member

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