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.NdefSpSizeRecord Class Reference

The Size Record contains a four-byte, 32-bit, unsigned integer, which contains the size of object that the URI field refers to. More...

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

Public Member Functions

 NdefSpSizeRecord ()
 Create an empty size record, to be used within a Smart Poster message. Automatically creates the payload and sets it to size 0. More...
 
 NdefSpSizeRecord (NdefRecord other)
 Create a size 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 size record. More...
 

Properties

uint NfcSize [get, set]
 Size 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 Size Record contains a four-byte, 32-bit, unsigned integer, which contains the size of object that the URI field refers to.

Note that in practice this is limited to URLs (http://, ftp:// and similar). The Size Record's Local Type Name is "s".

The size is expressed in network byte order (most significant byte first). For example, if Byte 0 contains 0x12, Byte 1 contains 0x34, Byte 2 contains 0x56, and Byte 3 0x78, the size of the referred object is 0x12345678 bytes.

The size record MAY be used by the device to determine whether it can accommodate the referenced file or not. For example, an NFC tag could trigger the download of an application to a cell phone. Using a combination of the Type Record and the Size Record, the mobile phone could determine whether it can accommodate such a program or not.

The Size Record is for informational purposes only. Since the object size in the network may vary (for example, due to updates), this value should be used as a guideline only.

The Size Record is optional to support.

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

Constructor & Destructor Documentation

◆ NdefSpSizeRecord() [1/2]

NdefLibrary.Ndef.NdefSpSizeRecord.NdefSpSizeRecord ( )

Create an empty size record, to be used within a Smart Poster message. Automatically creates the payload and sets it to size 0.

◆ NdefSpSizeRecord() [2/2]

NdefLibrary.Ndef.NdefSpSizeRecord.NdefSpSizeRecord ( NdefRecord  other)

Create a size 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
otherSize record to copy into this record.

Member Function Documentation

◆ IsRecordType()

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

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

Property Documentation

◆ NfcSize

uint NdefLibrary.Ndef.NdefSpSizeRecord.NfcSize
getset

Size of the linked content.


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