CBCardEngine Class Reference

API published in: S60 1st Ed
API deprecated in: S60 5th Ed

Link against: bcardeng.lib

Capability Information

Required Capabilities

ReadUserData WriteUserData

#include <bcardeng.h>

Detailed Description

The business card engine is able to import and export vCards and Compact Business Cards to and from Phonebook.

Public Member Functions
IMPORT_C  ~CBCardEngine ()
  Destructor.
IMPORT_C void  ImportBusinessCardL (CPbkContactItem &aDestItem, RReadStream &aSourceStream)
  Reads a vCard record from a stream into a Phonebook contact item.
IMPORT_C void  ExportBusinessCardL (RWriteStream &aDestStream, CPbkContactItem &aSourceItem)
  Writes a vCard record with information from a Phonebook contact item.
IMPORT_C TBool  ImportCompactBusinessCardL (CPbkContactItem &aDestItem, RReadStream &aSourceStream)
  Reads a Compact Business Card record from a stream into a Phonebook contact item.
IMPORT_C TBool  SupportsFieldType (TPbkFieldId aFieldId)
  Checks if given field is supported by the vCard format.

Static Public Member Functions
static IMPORT_C CBCardEngine *  NewL (CPbkContactEngine *aEngine)
  Creates a new instance of this class.

Constructor & Destructor Documentation

IMPORT_C CBCardEngine::~CBCardEngine (   ) 
 

Destructor.

Member Function Documentation

IMPORT_C void CBCardEngine::ExportBusinessCardL (  RWriteStream &  aDestStream,
CPbkContactItem &  aSourceItem
) 
 

Writes a vCard record with information from a Phonebook contact item.

Parameters:
aDestStream  A stream where the vCard data is written to. The data written to the stream is not Committed by this method.
aSourceItem  Phonebook contact item where the information should be read from
IMPORT_C void CBCardEngine::ImportBusinessCardL (  CPbkContactItem &  aDestItem,
RReadStream &  aSourceStream
) 
 

Reads a vCard record from a stream into a Phonebook contact item.

Parameters:
aDestItem  Phonebook contact item where the information should be written to. The item should be writable. The caller should commit the changes.
aSourceStream  A stream where the vCard data is read from
IMPORT_C TBool CBCardEngine::ImportCompactBusinessCardL (  CPbkContactItem &  aDestItem,
RReadStream &  aSourceStream
) 
 

Reads a Compact Business Card record from a stream into a Phonebook contact item.

Parameters:
aDestItem  Phonebook contact item where the information must be written to. The item must be writable. The caller should commit the changes.
aSourceStream  A stream where the Compact Business Card is read from
Returns:
ETrue on success
static IMPORT_C CBCardEngine* CBCardEngine::NewL (  CPbkContactEngine *  aEngine  )  [static]
 

Creates a new instance of this class.

Parameters:
aEngine  An open Phonebook Engine object which CBCardEngine uses to import and export vCard data.
IMPORT_C TBool CBCardEngine::SupportsFieldType (  TPbkFieldId  aFieldId  ) 
 

Checks if given field is supported by the vCard format.

Parameters:
aFieldId  Field id type
Returns:
ETrue if given field is supported, EFalse otherwise
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top