NFC / NDEF Library for Proximity APIs  4.1.0
Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
NdefLibrary.Ndef.NdefVcardRecordBase Class Reference

Stores a business card (vCard) in a MIME type record, allowing users to immediately add a contact to their address book. More...

Inheritance diagram for NdefLibrary.Ndef.NdefVcardRecordBase:
NdefLibrary.Ndef.NdefRecord

Public Member Functions

 NdefVcardRecordBase ()
 Create an empty MIME/vCard Record. More...
 
 NdefVcardRecordBase (NdefRecord other)
 Create a MIME/vCard record based on the record passed through the argument. More...
 
- Public Member Functions inherited from NdefLibrary.Ndef.NdefRecord
 NdefRecord ()
 Create an empty record, not setting any information. More...
 
 NdefRecord (TypeNameFormatType tnf, byte[] type)
 Create a new record with the specified type name format and type. Doesn't set the payload and ID. More...
 
 NdefRecord (NdefRecord other)
 Create a new record, copying the information of the record sent through the parameter. More...
 
Type CheckSpecializedType (bool checkForSubtypes)
 Checks the type name format and type of this record and returns the appropriate specialized class, if one is available and known for this record type. More...
 
virtual bool CheckIfValid ()
 Checks if the contents of the record are valid; throws an exception if a problem is found, containing a textual description of the issue. More...
 

Static Public Member Functions

static bool IsRecordType (NdefRecord record)
 Checks if the record sent via the parameter is indeed a MIME/vCard record. Only checks the type and type name format, doesn't analyze if the payload is valid. More...
 

Static Public Attributes

static readonly byte [] VcardType = Encoding.UTF8.GetBytes("text/x-vCard")
 Type of the NDEF MIME / vCard record. More...
 

Additional Inherited Members

- Public Types inherited from NdefLibrary.Ndef.NdefRecord
enum  TypeNameFormatType {
  TypeNameFormatType.Empty = 0x00, TypeNameFormatType.NfcRtd = 0x01, TypeNameFormatType.Mime = 0x02, TypeNameFormatType.Uri = 0x03,
  TypeNameFormatType.ExternalRtd = 0x04, TypeNameFormatType.Unknown = 0x05, TypeNameFormatType.Unchanged = 0x06, TypeNameFormatType.Reserved = 0x07
}
 Standardized type name formats, as defined by the NDEF record specification from the Nfc Forum. More...
 
- Protected Attributes inherited from NdefLibrary.Ndef.NdefRecord
byte [] _type
 Byte array storing raw contents of the type. Use Type property to access it whenever possible. More...
 
byte [] _payload
 Byte array storing raw contents of the payload. Use Payload property to access it whenever possible. More...
 
- Properties inherited from NdefLibrary.Ndef.NdefRecord
TypeNameFormatType TypeNameFormat [get, set]
 Indicates the structure of the value of the TYPE field. More...
 
virtual byte [] Type [get, set]
 An identifier describing the type of the payload. More...
 
byte [] Id [get, set]
 An identifier in the form of a URI reference. More...
 
virtual byte [] Payload [get, set]
 The application data carried within an NDEF record. More...
 

Detailed Description

Stores a business card (vCard) in a MIME type record, allowing users to immediately add a contact to their address book.

This base class provides the general record layout as well as the functionality to store the vcf format as a payload with the correct NDEF record type. To interface with platform specific contact classes in order to directly import / export a contact from the address book, use the derived classes in the NDEF Extension Library.

Constructor & Destructor Documentation

◆ NdefVcardRecordBase() [1/2]

NdefLibrary.Ndef.NdefVcardRecordBase.NdefVcardRecordBase ( )

Create an empty MIME/vCard Record.

◆ NdefVcardRecordBase() [2/2]

NdefLibrary.Ndef.NdefVcardRecordBase.NdefVcardRecordBase ( NdefRecord  other)

Create a MIME/vCard record based on the record passed through the argument.

Internalizes and parses the payload of the original record. The original record has to be a MIME/vCard Record as well.

Parameters
otherRecord to copy into this vCard record.
Exceptions
NdefExceptionThrown if attempting to create a vCard record based on an incompatible record type.

Member Function Documentation

◆ IsRecordType()

static bool NdefLibrary.Ndef.NdefVcardRecordBase.IsRecordType ( NdefRecord  record)
static

Checks if the record sent via the parameter is indeed a MIME/vCard record. Only checks the type and type name format, doesn't analyze if the payload is valid.

Parameters
recordRecord to check.
Returns
True if the record has the correct type and type name format to be a MIME/vCard record, false if it's a different record.

Member Data Documentation

◆ VcardType

readonly byte [] NdefLibrary.Ndef.NdefVcardRecordBase.VcardType = Encoding.UTF8.GetBytes("text/x-vCard")
static

Type of the NDEF MIME / vCard record.


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