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

Smart class that uses the smallest possible NDEF record type for storing the requested information - either a simple URI record, or a Smart Poster record. More...

Inheritance diagram for NdefLibrary.Ndef.NdefSmartUriRecord:
NdefLibrary.Ndef.NdefSpRecord NdefLibrary.Ndef.NdefRecord NdefLibrary.Ndef.NdefGeoRecord NdefLibrary.Ndef.NdefMailtoRecord NdefLibrary.Ndef.NdefSmsRecord NdefLibrary.Ndef.NdefSocialRecord NdefLibrary.Ndef.NdefTelRecord

Public Member Functions

 NdefSmartUriRecord ()
 Create an empty Smart Uri Record. More...
 
 NdefSmartUriRecord (NdefRecord other)
 Create a Smart Uri record based on the record passed through the argument. More...
 
- Public Member Functions inherited from NdefLibrary.Ndef.NdefSpRecord
 NdefSpRecord ()
 Create an empty Smart Poster (Sp) record. More...
 
 NdefSpRecord (NdefRecord other)
 Create a Smart Poster record based on the record passed through the argument. More...
 
void SetPayloadAndParse (byte[] payload, bool parseNewPayload)
 Sets the payload of the base class to the byte array from the parameter and optionally parses its contents. More...
 
bool HasSpData ()
 Returns true if this record contains data that requires a Smart Poster and could not be stored in a simple URI record. More...
 
override 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...
 
void SetUri (NdefUriRecord newUri)
 Set the URI based on another URI record instead of specifying the URI itself. More...
 
void AddTitle (NdefTextRecord newTitle)
 Add an (optional) title to the Smart Poster. More...
 
int TitleCount ()
 Returns how many title text records are stored in the Smart Poster. More...
 
NdefTextRecord Title (int index)
 Retrieve a specific title text record from the list. More...
 
bool ActionInUse ()
 Returns if the action has been defined for this Smart Poster instance. More...
 
bool SizeInUse ()
 Returns if the size has been defined for this Smart Poster instance. More...
 
bool MimeTypeInUse ()
 Returns if the mime type has been defined for this Smart Poster instance. More...
 
bool ImageInUse ()
 Returns if the Smart Poster contains an image (not supported yet). 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...
 

Properties

override byte [] Type [get]
 An identifier describing the type of the payload. Override to return correct type depending on data stored - either U(RI) or Sp (Smart Poster). More...
 
override byte [] Payload [get]
 The application data carried within an NDEF record. More...
 
- Properties inherited from NdefLibrary.Ndef.NdefSpRecord
string Uri [get, set]
 Mandatory URI of the Smart Poster More...
 
List< NdefTextRecord > Titles [get]
 List of all title texts for different languages used in the Smart Poster. More...
 
NdefSpActRecord.NfcActionType NfcAction [get, set]
 The action defines how the reader should handle the Smart Poster record. More...
 
uint NfcSize [get, set]
 Size of the linked content. More...
 
string NfcMimeType [get, set]
 MIME type of the linked object. More...
 
NdefMimeImageRecordBase NfcImage [get, set]
 Icon / Image data contained in the Smart Poster. 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...
 
- Static Public Member Functions inherited from NdefLibrary.Ndef.NdefSpRecord
static bool IsRecordType (NdefRecord record)
 Checks if the record sent via the parameter is indeed a Smart Poster. Only checks the type and type name format, doesn't analyze if the payload is valid. More...
 
- Static Public Attributes inherited from NdefLibrary.Ndef.NdefSpRecord
static readonly byte [] SmartPosterType = { (byte)'S', (byte)'p' }
 Type of the NDEF Smart Poster record (well-known, type 'Sp'). More...
 
- Protected Attributes inherited from NdefLibrary.Ndef.NdefSpRecord
NdefUriRecord RecordUri
 URI sub-record of this Smart Poster. Use Uri property to access if possible. 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

Smart class that uses the smallest possible NDEF record type for storing the requested information - either a simple URI record, or a Smart Poster record.

At construction and when only setting the URI, this class will stay a URI record. As soon as you set a Smart Poster feature, the payload and type will transform into a Smart Poster.

Constructor & Destructor Documentation

◆ NdefSmartUriRecord() [1/2]

NdefLibrary.Ndef.NdefSmartUriRecord.NdefSmartUriRecord ( )

Create an empty Smart Uri Record.

◆ NdefSmartUriRecord() [2/2]

NdefLibrary.Ndef.NdefSmartUriRecord.NdefSmartUriRecord ( NdefRecord  other)

Create a Smart Uri record based on the record passed through the argument.

Internalizes and parses the payload of the original record. The original record can be a Smart Poster or a URI record.

Parameters
otherRecord to copy into this SmartUri record.

Property Documentation

◆ Payload

override byte [] NdefLibrary.Ndef.NdefSmartUriRecord.Payload
get

The application data carried within an NDEF record.

Override because this can either be the whole Smart Poster payload, or just the URI record payload.

◆ Type

override byte [] NdefLibrary.Ndef.NdefSmartUriRecord.Type
get

An identifier describing the type of the payload. Override to return correct type depending on data stored - either U(RI) or Sp (Smart Poster).


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