CNdefRecord Class Reference

#include <mw/ndefrecord.h>

Link against: ndef.lib

class CNdefRecord : public CBase, public MNfcRawData

Inherits from

CNdefRecord
- CBase
- MNfcRawData

Public Member Enumerations
enum	TNdefMessagePart { ENdefMessageBegin, ENdefMessageMiddle, ENdefMessageEnd, ENdefMessageSingle }
enum	TNdefRecordChunk { ENotChunked, EChunkBegin, EChunkMiddle, EChunkEnd }
enum	TNdefRecordFlag { EMessageBegin, EMessageEnd, EChunk, EShortRecord, EIdLength }
enum	TNdefRecordTnf { EEmpty, ENfcWellKnown, EMime, EUri, ..., EReserved }

Public Member Functions
virtual	~CNdefRecord()
IMPORT_C void	AppendPayloadL(const TDesC8 &)
IMPORT_C void	AppendPayloadL(const CNdefMessage &)
IMPORT_C CNdefMessage *	ConstructNestedNdefMessageL(TUint)
virtual IMPORT_C TUint	ExportRawDataL(TDes8 &, TUint)
IMPORT_C CNdefRecord::TNdefRecordChunk	GetChunk()
IMPORT_C const TDesC8 &	GetId()
IMPORT_C CNdefRecord::TNdefMessagePart	GetMessagePart()
IMPORT_C const TDesC8 &	GetPayload()
IMPORT_C TUint	GetPayloadSize()
IMPORT_C CNdefRecord::TNdefRecordTnf	GetTnf()
IMPORT_C const TDesC8 &	GetType()
virtual IMPORT_C TUint	ImportRawDataL(const TDesC8 &, TUint)
IMPORT_C CNdefRecord *	NewL(TNdefRecordTnf, TNdefRecordChunk)
IMPORT_C CNdefRecord *	NewL(TNdefRecordTnf, const TDesC8 &, TNdefRecordChunk)
IMPORT_C CNdefRecord *	NewLC(TNdefRecordTnf, TNdefRecordChunk)
IMPORT_C CNdefRecord *	NewLC(TNdefRecordTnf, const TDesC8 &, TNdefRecordChunk)
IMPORT_C void	RemoveId()
IMPORT_C void	RemovePayload()
IMPORT_C void	RemoveType()
IMPORT_C void	SetIdL(const TDesC8 &)
IMPORT_C void	SetMessagePart(TNdefMessagePart)
IMPORT_C void	SetTypeL(const TDesC8 &)
virtual IMPORT_C TUint	SizeL()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

NFC Forum defined NDEF record.

?more_complete_description

Since: S60 ?S60_version

Member Enumeration Documentation

Enum TNdefMessagePart

Defines which part of a message a single record is.

Enumerator	Value	Description
ENdefMessageBegin	0
ENdefMessageMiddle	1
ENdefMessageEnd	2
ENdefMessageSingle	3

Enum TNdefRecordChunk

Defines which part of chunked data a single record is.

Enumerator	Value	Description
ENotChunked	0
EChunkBegin	1
EChunkMiddle	2
EChunkEnd	3

Enum TNdefRecordFlag

NDEF record flags.

Enumerator	Value	Description
EMessageBegin	0x80
EMessageEnd	0x40
EChunk	0x20
EShortRecord	0x10
EIdLength	0x08

Enum TNdefRecordTnf

NDEF record TNF values.

Enumerator	Value	Description
EEmpty	0x00
ENfcWellKnown	0x01
EMime	0x02
EUri	0x03
ENfcExternal	0x04
EUnknown	0x05
EUnchanged	0x06
EReserved	0x07

Constructor & Destructor Documentation

~CNdefRecord ( )

~CNdefRecord

(

)

[virtual]

Destructor.

Since: S60 ?S60_version

Member Function Documentation

AppendPayloadL ( const TDesC8 & )

IMPORT_C void

AppendPayloadL

(

const TDesC8 &

aBuf

)

Appends payload to the NDEF record. May leave with one of the system wide error codes.

Since: S60 ?S60_version

Parameters
aBuf	8-bit descriptor containing the payload.

AppendPayloadL ( const CNdefMessage & )

IMPORT_C void

AppendPayloadL

(

const CNdefMessage &

aMessage

)

Appends binary presentation of a NDEF Message to the payload of this NDEF record. May leave with one of the system wide error codes.

Since: S60 ?S60_version

Parameters
aMessage	NDEF Message

ConstructNestedNdefMessageL ( TUint )

IMPORT_C CNdefMessage *

ConstructNestedNdefMessageL

(

TUint

aPos

)

const

Constructs a new NDEF Message from the payload of this NDEF record. May leave with one of the system wide error codes.

Since: S60 ?S60_version

Parameters
aPos	Byte position to start reading from.

Return Value: Pointer to the newly created NDEF Message.

ExportRawDataL ( TDes8 &, TUint )

IMPORT_C TUint	ExportRawDataL	(	TDes8 &	aBuf,
			TUint	aPos
		)	const [virtual]

Reimplemented from MNfcRawData::ExportRawDataL(TDes8 &,TUint)const

From MNfcRawData.

Since: S60 ?S60_version

GetChunk ( )

IMPORT_C CNdefRecord::TNdefRecordChunk

GetChunk

(

)

const

Tells whether payload is a chunk or not.

Since: S60 ?S60_version

Return Value: Chunking information for this record.

GetId ( )

IMPORT_C const TDesC8 &

GetId

(

)

const

Gets the identification string.

Since: S60 ?S60_version

Return Value: 8-bit descriptor containing the identifier string.

GetMessagePart ( )

IMPORT_C CNdefRecord::TNdefMessagePart

GetMessagePart

(

)

const

Returns the position of the record in a message.

Since: S60 ?S60_version

Return Value: Position in a message

GetPayload ( )

IMPORT_C const TDesC8 &

GetPayload

(

)

const

Returns a 8-bit descriptor which points to the payload of this NDEF record.

Since: S60 ?S60_version

Return Value: 8-bit descriptor containing the payload.

GetPayloadSize ( )

IMPORT_C TUint

GetPayloadSize

(

)

const

Returns the size of the payload in bytes.

Since: S60 ?S60_version

Return Value: Size of payload in bytes.

GetTnf ( )

IMPORT_C CNdefRecord::TNdefRecordTnf

GetTnf

(

)

const

Returns the Type Name Format of the NDEF record.

Since: S60 ?S60_version

Return Value: Type Name Format

GetType ( )

IMPORT_C const TDesC8 &

GetType

(

)

const

Gets the type string.

Since: S60 ?S60_version

Return Value: 8-bit descriptor containing the type string.

ImportRawDataL ( const TDesC8 &, TUint )

IMPORT_C TUint	ImportRawDataL	(	const TDesC8 &	aBuf,
			TUint	aPos
		)	[virtual]

Reimplemented from MNfcRawData::ImportRawDataL(const TDesC8 &,TUint)

From MNfcRawData.

Since: S60 ?S60_version

NewL ( TNdefRecordTnf, TNdefRecordChunk )

IMPORT_C CNdefRecord *	NewL	(	TNdefRecordTnf	aTnf = EEmpty,
			TNdefRecordChunk	aChunk = ENotChunked
		)	[static]

Creates a new instance of this class. May leave with one of the system wide error codes.

Since: S60 ?S60_version

Parameters
aTnf	Type Name Format.
aChunk	Which part of a chunk series this record is.

Return Value: Pointer to the newly created instance.

NewL ( TNdefRecordTnf, const TDesC8 &, TNdefRecordChunk )

IMPORT_C CNdefRecord *	NewL	(	TNdefRecordTnf	aTnf,
			const TDesC8 &	aType,
			TNdefRecordChunk	aChunk = ENotChunked
		)	[static]

Creates a new instance of this class. May leave with one of the system wide error codes.

Since: S60 ?S60_version

Parameters
aTnf	Type Name Format.
aType	Type string.
aChunk	Which part of a chunk series this record is.

Return Value: Pointer to the newly created instance.

NewLC ( TNdefRecordTnf, TNdefRecordChunk )

IMPORT_C CNdefRecord *	NewLC	(	TNdefRecordTnf	aTnf = EEmpty,
			TNdefRecordChunk	aChunk = ENotChunked
		)	[static]

Creates a new instance of this class and leaves a pointer to it into the CleanupStack. May leave with one of the system wide error codes.

Since: S60 ?S60_version

Parameters
aTnf	Type Name Format.
aChunk	Which part of a chunk series this record is.

Return Value: Pointer to the newly created instance.

NewLC ( TNdefRecordTnf, const TDesC8 &, TNdefRecordChunk )

IMPORT_C CNdefRecord *	NewLC	(	TNdefRecordTnf	aTnf,
			const TDesC8 &	aType,
			TNdefRecordChunk	aChunk = ENotChunked
		)	[static]

Creates a new instance of this class and leaves a pointer to it into the CleanupStack. May leave with one of the system wide error codes.

Since: S60 ?S60_version

Parameters
aTnf	Type Name Format.
aType	Type string.
aChunk	Which part of a chunk series this record is.

Return Value: Pointer to the newly created instance.

RemoveId ( )

IMPORT_C void

RemoveId

(

)

Removes the identification string.

Since: S60 ?S60_version

RemovePayload ( )

IMPORT_C void

RemovePayload

(

)

Removes the payload.

Since: S60 ?S60_version

RemoveType ( )

IMPORT_C void

RemoveType

(

)

Removes the type string.

Since: S60 ?S60_version

SetIdL ( const TDesC8 & )

IMPORT_C void

SetIdL

(

const TDesC8 &

aId

)

Sets the identification string. May leave with one of the system wide error codes.

Since: S60 ?S60_version

Parameters
aId	8-bit descriptor containing the identifier string.

SetMessagePart ( TNdefMessagePart )

IMPORT_C void

SetMessagePart

(

TNdefMessagePart

aPart

)

Sets the position of the record in a message. Note that this does not check whether message begin/end and chunking flags are legally combined.

Since: S60 ?S60_version

Parameters
aPart	Message part

SetTypeL ( const TDesC8 & )

IMPORT_C void

SetTypeL

(

const TDesC8 &

aType

)

Sets the type string. May leave with one of the system wide error codes.

Since: S60 ?S60_version

Parameters
aType	8-bit descriptor containing the type string.

SizeL ( )

IMPORT_C TUint

SizeL

(

)

const [virtual]

Reimplemented from MNfcRawData::SizeL()const

From MNfcRawData.

Since: S60 ?S60_version