Symbian^3 Product 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 &)
voidExternalizeL(RWriteStream &)
TPtrC8 GetAnyField(const TDesC16 &)
voidGetFieldKeysL(CDesCArrayFlat &)
voidInternalizeL(RReadStream &)
IMPORT_C MPresenceBuddyInfo2 *NewL()
IMPORT_C MPresenceBuddyInfo2 *NewLC()
voidRemoveField(const TDesC &)
voidSetAnyFieldL(const TDesC16 &, const TDesC8 &)
voidSetAvailabilityL(TAvailabilityValues, const TDesC &)
voidSetAvatarL(const TDesC8 &)
voidSetIdentityL(const TDesC &)
voidSetStatusMessageL(const TDesC &)
TPtrC StatusMessage()
Public Member Enumerations
enumTAvailabilityValues { 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 & aOtherInstanceother instance of this object.

ExternalizeL(RWriteStream &)

voidExternalizeL(RWriteStream &aStream)const [pure virtual]

Externalize

Parameters

RWriteStream & aStreamwrite stream

GetAnyField(const TDesC16 &)

TPtrC8 GetAnyField(const TDesC16 &aKey)[pure virtual]

Gets any key value parameter for the buddy

Parameters

const TDesC16 & aKeyfield name

GetFieldKeysL(CDesCArrayFlat &)

voidGetFieldKeysL(CDesCArrayFlat &aKeys)[pure virtual]

Gets all the keys that are in use

Parameters

CDesCArrayFlat & aKeysarray where the keys are written to.

InternalizeL(RReadStream &)

voidInternalizeL(RReadStream &aStream)[pure virtual]

Internalize

Parameters

RReadStream & aStreamread 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 &)

voidRemoveField(const TDesC &aKey)[pure virtual]

Removes the field

Parameters

const TDesC & aKeyfield name

SetAnyFieldL(const TDesC16 &, const TDesC8 &)

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

Sets any key value parameter for the buddy

Parameters

const TDesC16 & aKeyfield name
const TDesC8 & aValuefield value

SetAvailabilityL(TAvailabilityValues, const TDesC &)

voidSetAvailabilityL(TAvailabilityValuesaAvailability,
const TDesC &aAvailabilityText
)[pure virtual]

Sets buddy's availability

Parameters

TAvailabilityValues aAvailabilityavalability value
const TDesC & aAvailabilityTextavalability text, same as KAvailability field

SetAvatarL(const TDesC8 &)

voidSetAvatarL(const TDesC8 &aAvatar)[pure virtual]

Sets buddy's avatar

Parameters

const TDesC8 & aAvataravatar, same as KAvatar field

SetIdentityL(const TDesC &)

voidSetIdentityL(const TDesC &aBuddyId)[pure virtual]

Sets buddy's identity

Parameters

const TDesC & aBuddyIdbuddy id

SetStatusMessageL(const TDesC &)

voidSetStatusMessageL(const TDesC &aStatusMessage)[pure virtual]

Sets buddy's status text

Parameters

const TDesC & aStatusMessagestatus 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.

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.