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 | Properties | List of all members
NdefLibrary.Ndef.NdefSpMimeTypeRecord Class Reference

The Payload of the Type Record is a UTF-8-formatted string that describes a MIME type [RFC 2046] which describes the type of the object that can be reached through the URI. More...

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

Public Member Functions

 NdefSpMimeTypeRecord ()
 Create an empty mime type record, to be used within a Smart Poster message. More...
 
 NdefSpMimeTypeRecord (NdefRecord other)
 Create a mime type 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) type record. More...
 

Properties

string NfcMimeType [get, set]
 MIME type of the linked content. 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...
 

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...
 

Detailed Description

The Payload of the Type Record is a UTF-8-formatted string that describes a MIME type [RFC 2046] which describes the type of the object that can be reached through the URI.

(In practice this is limited to URLs only, much like the Size Record.) The Local Type Name for the Type Record is "t".

The length of the payload string is the same as the length of the payload, so there is no need for separate length information or termination.

The Type Record MAY be used by the device to determine whether it can process the referenced file or not. For example, an NFC tag could trigger a media file playback from an URL. If the Type Record references an unknown media type, the reader device (e.g. a cell phone) does not need to even initiate the playback.

The Type Record is optional to support.

(Information taken from NFC Forum Smart Poster NDEF record specifications)

Constructor & Destructor Documentation

◆ NdefSpMimeTypeRecord() [1/2]

NdefLibrary.Ndef.NdefSpMimeTypeRecord.NdefSpMimeTypeRecord ( )

Create an empty mime type record, to be used within a Smart Poster message.

◆ NdefSpMimeTypeRecord() [2/2]

NdefLibrary.Ndef.NdefSpMimeTypeRecord.NdefSpMimeTypeRecord ( NdefRecord  other)

Create a mime type record based on the record passed through the argument.

Internalizes and parses the payload of the original record. The original record has to be an action record as well.

Parameters
otherMime type record to copy into this record.

Member Function Documentation

◆ IsRecordType()

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

Checks if the record sent via the parameter is indeed a (mime) type 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) type record, false if it's a different record.

Property Documentation

◆ NfcMimeType

string NdefLibrary.Ndef.NdefSpMimeTypeRecord.NfcMimeType
getset

MIME type of the linked content.


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