OpenAB  1.0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
GoogleSource Class Reference

#include <Google.hpp>

Inheritance diagram for GoogleSource:
Collaboration diagram for GoogleSource:

Public Member Functions

 GoogleSource (const std::string &login, const OpenAB::SecureString &password, const std::string &filter)
 Constructor. More...
 
 GoogleSource (const std::string &clientId, const OpenAB::SecureString &clientSecret, const OpenAB::SecureString &refreshToken, const std::string &filter)
 
virtual ~GoogleSource ()
 
enum OpenAB_Source::Source::eInit init ()
 Initializes Source. More...
 
enum
OpenAB_Source::Source::eGetItemRet 
getItem (OpenAB::SmartPtr< OpenAB::PIMItem > &item)
 Gets PIM Item from Source. If Source is suspended getItem() should block until Source will be resumed or cancelled. More...
 
enum
OpenAB_Source::Source::eSuspendRet 
suspend ()
 Suspends Source, if such operation is supported. More...
 
enum
OpenAB_Source::Source::eResumeRet 
resume ()
 Resumes Source, if such operation is supported. More...
 
enum
OpenAB_Source::Source::eCancelRet 
cancel ()
 Cancels Source, if such operation is supported. After canceling Source next call to getVCard() should return eGetItemRetError status. More...
 
int getTotalCount () const
 Returns total count of items available from Source, if such information is available. More...
 
- Public Member Functions inherited from OpenAB_Source::Source
 Source (OpenAB::PIMItemType t)
 Constructor. More...
 
virtual ~Source ()
 Destructor, virtual by default. More...
 
OpenAB::PIMItemType getItemType () const
 Returns type of PIM Item supported by Source. More...
 

Additional Inherited Members

- Public Types inherited from OpenAB_Source::Source
enum  eInit { eInitOk, eInitFail }
 
enum  eSuspendRet { eSuspendRetOk, eSuspendRetFail, eSuspendRetNotSupported }
 
enum  eResumeRet { eResumeRetOk, eResumeRetFail, eResumeRetNotSupported }
 
enum  eCancelRet { eCancelRetOk, eCancelRetFail, eCancelRetNotSupported }
 
enum  eGetItemRet { eGetItemRetOk, eGetItemRetEnd, eGetItemRetError }
 

Constructor & Destructor Documentation

GoogleSource::GoogleSource ( const std::string &  login,
const OpenAB::SecureString password,
const std::string &  filter 
)

Constructor.

GoogleSource::GoogleSource ( const std::string &  clientId,
const OpenAB::SecureString clientSecret,
const OpenAB::SecureString refreshToken,
const std::string &  filter 
)
GoogleSource::~GoogleSource ( )
virtual

Member Function Documentation

enum OpenAB_Source::Source::eCancelRet GoogleSource::cancel ( )
virtual

Cancels Source, if such operation is supported. After canceling Source next call to getVCard() should return eGetItemRetError status.

Returns
the status code

Implements OpenAB_Source::Source.

enum OpenAB_Source::Source::eGetItemRet GoogleSource::getItem ( OpenAB::SmartPtr< OpenAB::PIMItem > &  item)
virtual

Gets PIM Item from Source. If Source is suspended getItem() should block until Source will be resumed or cancelled.

Parameters
[out]itemitem received from Source
Returns
the status code
Note
item is returned as smart pointer, its contents will be deleted automatically when no more references to it will exist, it's not advised to dereference and use direct pointer

Implements OpenAB_Source::Source.

int GoogleSource::getTotalCount ( ) const
virtual

Returns total count of items available from Source, if such information is available.

Returns
total count of items available or -1 if such information is unavailable

Implements OpenAB_Source::Source.

enum OpenAB_Source::Source::eInit GoogleSource::init ( )
virtual

Initializes Source.

Returns
the status code

Implements OpenAB_Source::Source.

enum OpenAB_Source::Source::eResumeRet GoogleSource::resume ( )
virtual

Resumes Source, if such operation is supported.

Returns
the status code

Implements OpenAB_Source::Source.

enum OpenAB_Source::Source::eSuspendRet GoogleSource::suspend ( )
virtual

Suspends Source, if such operation is supported.

Returns
the status code

Implements OpenAB_Source::Source.


The documentation for this class was generated from the following files: