Collapse all Symbian^3 Application Developer Library

MPresenceBuddyInfo2 Class Reference

class MPresenceBuddyInfo2

Interface buddy presence info.

Since: S60 v5.1

Public Member Functions
	~MPresenceBuddyInfo2 ()
TAvailabilityValues	Availability ()
TPtrC	AvailabilityText ()
TPtrC8	Avatar ()
TPtrC	BuddyId ()
TBool	EqualsIdentity (const MPresenceBuddyInfo2 &)
void	ExternalizeL ( RWriteStream &)
TPtrC8	GetAnyField (const TDesC16 &)
void	GetFieldKeysL ( CDesCArrayFlat &)
void	InternalizeL ( RReadStream &)
IMPORT_C MPresenceBuddyInfo2 *	NewL ()
IMPORT_C MPresenceBuddyInfo2 *	NewLC ()
void	RemoveField (const TDesC &)
void	SetAnyFieldL (const TDesC16 &, const TDesC8 &)
void	SetAvailabilityL ( TAvailabilityValues , const TDesC &)
void	SetAvatarL (const TDesC8 &)
void	SetIdentityL (const TDesC &)
void	SetStatusMessageL (const TDesC &)
TPtrC	StatusMessage ()

Public Member Enumerations
enum	TAvailabilityValues { EUnknownAvailability = 0, ENotAvailable = 1, EBusy = 2, EAvailable = 3 }

Constructor & Destructor Documentation

~MPresenceBuddyInfo2()

~MPresenceBuddyInfo2

(

)

[inline, virtual]

Public destructor. Objects can be deleted through this interface.

Member Functions Documentation

Availability()

TAvailabilityValues

Availability

(

)

[pure virtual]

Gets buddy's availability

AvailabilityText()

TPtrC

AvailabilityText

(

)

[pure virtual]

Gets buddy's availability text

Avatar()

TPtrC8

Avatar

(

)

[pure virtual]

Gets buddy's avatar

BuddyId()

TPtrC

BuddyId

(

)

const [pure virtual]

Gets buddy's identity

EqualsIdentity(const MPresenceBuddyInfo2 &)

TBool

EqualsIdentity

(

const MPresenceBuddyInfo2 &

aOtherInstance

)

const [pure virtual]

Return true if identity is same with other instance.

Parameters

const MPresenceBuddyInfo2 & aOtherInstance

other instance of this object.

ExternalizeL(RWriteStream &)

void

ExternalizeL

(

RWriteStream &

aStream

)

const [pure virtual]

Externalize

Parameters

RWriteStream & aStream

write stream

GetAnyField(const TDesC16 &)

TPtrC8

GetAnyField

(

const TDesC16 &

aKey

)

[pure virtual]

Gets any key value parameter for the buddy

Parameters

const TDesC16 & aKey

field name

GetFieldKeysL(CDesCArrayFlat &)

void

GetFieldKeysL

(

CDesCArrayFlat &

aKeys

)

[pure virtual]

Gets all the keys that are in use

Parameters

CDesCArrayFlat & aKeys

array where the keys are written to.

InternalizeL(RReadStream &)

void

InternalizeL

(

RReadStream &

aStream

)

[pure virtual]

Internalize

Parameters

RReadStream & aStream

read stream

NewL()

IMPORT_C MPresenceBuddyInfo2 *

NewL

(

)

[static]

Factory method to instantiate MPresenceBuddyInfo2

NewLC()

IMPORT_C MPresenceBuddyInfo2 *

NewLC

(

)

[static]

Factory method to instantiate MPresenceBuddyInfo2

RemoveField(const TDesC &)

void

RemoveField

(

const TDesC &

aKey

)

[pure virtual]

Removes the field

Parameters

const TDesC & aKey

field name

SetAnyFieldL(const TDesC16 &, const TDesC8 &)

void	SetAnyFieldL	(	const TDesC16 &	aKey,
			const TDesC8 &	aValue
		)	[pure virtual]

Sets any key value parameter for the buddy

Parameters

const TDesC16 & aKey	field name
const TDesC8 & aValue	field value

SetAvailabilityL(TAvailabilityValues, const TDesC &)

void	SetAvailabilityL	(	TAvailabilityValues	aAvailability,
			const TDesC &	aAvailabilityText
		)	[pure virtual]

Sets buddy's availability

Parameters

TAvailabilityValues aAvailability	avalability value
const TDesC & aAvailabilityText	avalability text, same as KAvailability field

SetAvatarL(const TDesC8 &)

void

SetAvatarL

(

const TDesC8 &

aAvatar

)

[pure virtual]

Sets buddy's avatar

Parameters

const TDesC8 & aAvatar

avatar, same as KAvatar field

SetIdentityL(const TDesC &)

void

SetIdentityL

(

const TDesC &

aBuddyId

)

[pure virtual]

Sets buddy's identity

Parameters

const TDesC & aBuddyId

buddy id

SetStatusMessageL(const TDesC &)

void

SetStatusMessageL

(

const TDesC &

aStatusMessage

)

[pure virtual]

Sets buddy's status text

Parameters

const TDesC & aStatusMessage

status text, same as KStatusMessage field

StatusMessage()

TPtrC

StatusMessage

(

)

[pure virtual]

Gets buddy's status text.

Member Enumerations Documentation

Enum TAvailabilityValues

Common enumerated availability values for "availability" presence information field.

Since: S60 v5.1

Enumerators

EUnknownAvailability = 0	Presentity status is unknown.
ENotAvailable = 1	Presentity is not available for communication.
EBusy = 2	Presentity is currently busy. Presentity may or may not be available for for communication.
EAvailable = 3	Presentity is available for communication.