Source Plugin

Collaboration diagram for Source Plugin:

Modules
	File Source Plugin
	Provides OpenAB::PIMContactItem items from vCard files. Supports both folders of vCards and files containing multiple vCards.
	Google Contacts Source Plugin
	Provides OpenAB::PIMContactItem items from Google Contacts.
	PBAP Source Plugin
	Provides OpenAB::PIMContactItem items using PBAP protocol.

Detailed Description

Source Interface: Source

Overview

The Source plugin interface provides all the required functionalities to provide PIM items. Source plugins are expected to provide stream of PIM items that can be used by Sync::Sync plugins (OpenAB_Sync::Sync). Each source can provide only one type of PIM Item (OpenAB::PIMItemType)

API Details

Source functionalities

Providing PIM item stream is main functionality required from Source:

• Source::getItem ( Source::suspend)
• Source::resume ( Source::cancel)
• Source::getTotalCount ( Source::init)

initialization will use parameters provided during creation of Source instance (Parameters, OpenAB::PluginManager::getPluginInstance). Each Source plugin can have its own specific parameters. To retrieve all item call Source::getItem function until it will return Source::eGetItemRetEnd.