diff --git a/NdefLibrary/doc/html/NdefLibraryLogo.png b/NdefLibrary/doc/html/NdefLibraryLogo.png new file mode 100644 index 0000000..0bee5f3 Binary files /dev/null and b/NdefLibrary/doc/html/NdefLibraryLogo.png differ diff --git a/NdefLibrary/doc/html/annotated.html b/NdefLibrary/doc/html/annotated.html new file mode 100644 index 0000000..a303c91 --- /dev/null +++ b/NdefLibrary/doc/html/annotated.html @@ -0,0 +1,151 @@ + + +
+ + + ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
▼NNdefLibrary | |
▼NNdef | |
CNdefAndroidAppRecord | Creates the Android-specific Android Application Record. |
▼CNdefBtSecureSimplePairingRecord | Create an NDEF record for Bluetooth Carrier Handover according to the "Secure Simple Pairing" mechanism defined by the Bluetooth SIG. |
▼CBtClassOfDevice | Defines the Class of Device information data. This is to be used to provide a graphical representation to the user as part of UI involving operations with Bluetooth devices. For example, it may provide a particular icon to represent the device. |
CMinorDeviceClassType | Information class that specifies required information to correclty parse and create a minor device class based on one or more encoded values. The exact format of the minor device class depends on the major device class in use, and this class enables to look up the encoding and lets this implementation take care of most of the complex underlying work that needs to be done. |
CBtServiceClasses | Utility class to handle the Bluetooth Service Classes defined in the OOB data of the Secure Simple Pairing Record. |
CNdefException | Exception occured when parsing or assembling NDEF messages, records and their respective payloads. |
CNdefExceptionMessages | A strongly-typed resource class, for looking up localized strings, etc. |
CNdefGeoRecord | Store longitude and latitude on a tag, to allow the user to view a map when tapping the tag. |
CNdefHandoverAlternativeCarrierRecord | The Alternative Carrier record is used within the payload of the Handover Select record to describe a single alternative carrier. |
CNdefHandoverErrorRecord | The Error Record is used in the Handover Select Record to indicate that the Handover Selector failed to successfully process the most recently received Handover Request Message. It SHALL NOT be used elsewhere. |
CNdefHandoverSelectRecord | Handover Select Record for the Connection Handover Standard. Its payload contains at least one reference to an Alternative Carrier record that defines a possible carrier for a connection handover. |
CNdefHandoverVersion | Utility class that handles the correct format for storing version information in Handover records. The handover version contains a major and minor version. This implementation conforms to the specification with major version 1 and minor version 3. |
CNdefIcalendarRecordBase | |
CNdefLaunchAppRecord | Handles the Windows LaunchApp record format. |
CNdefMailtoRecord | Convenience class for creating records that open the email app on the user's device, with a specified recipient address, subject and body text. |
CNdefMessage | An NDEF message is composed of one or more NDEF records. |
CNdefMimeImageRecordBase | Stores a MIME type and image data for individual use or as a part of another record like the Smart Poster. |
CNdefNokiaAccessoriesRecord | URI NDEF Record with the custom nokia-accessories URI scheme, as used for example in the Nokia Wireless Charging Stand. |
CNdefRecord | An NDEF record contains a payload described by a type, a length, and an optional identifier. |
CNdefSmartUriRecord | 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 |
CNdefSmsRecord | Convenience class for formatting SMS information into an NDEF record, depending on added info either URI or Smart Poster. |
CNdefSocialRecord | Link to one of the supported social networks by simply selecting the network and specifying the username. |
CNdefSpActRecord | The Action record is a Local Type specific to the Smart Poster. |
CNdefSpMimeTypeRecord | 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. |
CNdefSpRecord | Handles the Smart Poster meta-record and is able to both parse and assemble a smart poster according to the specification. |
CNdefSpSizeRecord | The Size Record contains a four-byte, 32-bit, unsigned integer, which contains the size of object that the URI field refers to. |
CNdefTelRecord | Convenience class for formatting telephone call information into an NDEF record, depending on added info either URI or Smart Poster. |
CNdefTextRecord | The Text record as specified by the NFC Forum URI record type definition. |
CNdefUriRecord | The URI record as specified by the NFC Forum URI record type definition. |
CNdefVcardRecordBase | Stores a business card (vCard) in a MIME type record, allowing users to immediately add a contact to their address book. |
CNdefWindowsSettingsRecord | Convenience class for formatting URI records that launch specific setting pages on Windows 10. |
CNdefWpSettingsRecord | Convenience class for formatting URI records that launch specific setting pages on Windows Phone 8. Please use the NdefWindowsSettingsRecord for Windows 10 and Windows 10 Mobile. |
CGeoCoordinate | Custom GeoCoordinate class to allow for cross-platform portability. |
▼NNdefLibraryUwp | |
▼NNdef | |
CNdefMimeImageRecord | Extended MIME / Image record for the WinRT APIs that integrates with the platform's image handling to support convenient conversion to and from various formats (WriteableBitmap, PNG, JPEG, etc.) |
CNdefVcardRecord | Work with contact / vCard / vcf information in an NDEF record, and convert the WinRT Contact storage to / from a valid vCard representation. |
▼NNdefLibraryWin | |
▼NNdef | |
CNdefIcalendarRecord | A platform-specific class for Windows 8.1 that is able to convert the Windows Appointment class into a valid iCalendar structure and back again |
CNdefMimeImageRecord | Extended MIME / Image record for the WinRT APIs that integrates with the platform's image handling to support convenient conversion to and from various formats (WriteableBitmap, PNG, JPEG, etc.) |
CNdefVcardRecord | Work with contact / vCard / vcf information in an NDEF record, and convert the WinRT Contact storage to / from a valid vCard representation. |
▼NNdefLibraryWp | |
▼NNdef | |
CNdefVcardRecord | Work with contact / vCard / vcf information in an NDEF record, and convert the Windows Phone Contact or ContactInformation classes to / from a valid vCard representation. |
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.GeoCoordinate, including all inherited members.
+Latitude | NdefLibrary.GeoCoordinate | |
Longitude | NdefLibrary.GeoCoordinate |
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
Custom GeoCoordinate class to allow for cross-platform portability. + More...
++Properties | |
double | Latitude [get, set] |
The latitude in degrees. More... | |
double | Longitude [get, set] |
The longitude in degrees. More... | |
Custom GeoCoordinate class to allow for cross-platform portability.
+Windows Phone and Windows 8 use different namespaces & class name for the GeoCoordinate class. WP: System.Device.Location.GeoCoordinate, Win8: Windows.Devices.Geolocation.Geocoordinate
+
+
|
+ +getset | +
The latitude in degrees.
+ +
+
|
+ +getset | +
The longitude in degrees.
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefAndroidAppRecord, including all inherited members.
+_payload | NdefLibrary.Ndef.NdefRecord | protected |
_type | NdefLibrary.Ndef.NdefRecord | protected |
CheckIfValid() | NdefLibrary.Ndef.NdefRecord | virtual |
CheckSpecializedType(bool checkForSubtypes) | NdefLibrary.Ndef.NdefRecord | |
Id | NdefLibrary.Ndef.NdefRecord | |
IsRecordType(NdefRecord record) | NdefLibrary.Ndef.NdefAndroidAppRecord | static |
NdefAndroidAppRecord() | NdefLibrary.Ndef.NdefAndroidAppRecord | |
NdefAndroidAppRecord(NdefRecord other) | NdefLibrary.Ndef.NdefAndroidAppRecord | |
NdefRecord() | NdefLibrary.Ndef.NdefRecord | |
NdefRecord(TypeNameFormatType tnf, byte[] type) | NdefLibrary.Ndef.NdefRecord | |
NdefRecord(NdefRecord other) | NdefLibrary.Ndef.NdefRecord | |
PackageName | NdefLibrary.Ndef.NdefAndroidAppRecord | |
Payload | NdefLibrary.Ndef.NdefRecord | |
Type | NdefLibrary.Ndef.NdefRecord | |
TypeNameFormat | NdefLibrary.Ndef.NdefRecord | |
TypeNameFormatType enum name | NdefLibrary.Ndef.NdefRecord |
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
Creates the Android-specific Android Application Record. + More...
++Public Member Functions | |
NdefAndroidAppRecord () | |
Create an empty Android Application Record. More... | |
NdefAndroidAppRecord (NdefRecord other) | |
Create an Android Application Record 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 an Android Application Record. Only checks the type and type name format, doesn't analyze if the payload is valid. More... | |
+Properties | |
string | PackageName [get, set] |
Name of the android package. 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... | |
Creates the Android-specific Android Application Record.
+Through specifying the package name, this record directly launches an app on an Android phone (4.0+). If the app isn't installed on the phone, it will open the store and search for the app.
+To pass custom data to the app, you would typically add other records to the NDEF message.
+If creating a multi-record NDEF message, it's recommended to put this record to the end of the message.
+NdefLibrary.Ndef.NdefAndroidAppRecord.NdefAndroidAppRecord | +( | +) | ++ |
Create an empty Android Application Record.
+ +NdefLibrary.Ndef.NdefAndroidAppRecord.NdefAndroidAppRecord | +( | +NdefRecord | +other | ) | ++ |
Create an Android Application Record 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 Android Application Record as well.
+other | Record to copy into this AAR record. |
NdefException | Thrown if attempting to create an Android Application Record based on an incompatible record type. |
+
|
+ +static | +
Checks if the record sent via the parameter is indeed an Android Application Record. Only checks the type and type name format, doesn't analyze if the payload is valid.
+record | Record to check. |
+
|
+ +getset | +
Name of the android package.
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefBtSecureSimplePairingRecord, including all inherited members.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
Create an NDEF record for Bluetooth Carrier Handover according to the "Secure Simple Pairing" mechanism defined by the Bluetooth SIG. + More...
++Classes | |
class | BtClassOfDevice |
Defines the Class of Device information data. This is to be used to provide a graphical representation to the user as part of UI involving operations with Bluetooth devices. For example, it may provide a particular icon to represent the device. More... | |
class | BtServiceClasses |
Utility class to handle the Bluetooth Service Classes defined in the OOB data of the Secure Simple Pairing Record. More... | |
+Public Types | |
enum | OobDataTypes : byte { + IncompleteList16BitServiceClassUuids = (byte)0x02, +CompleteList16BitServiceClassUuids = (byte)0x03, +IncompleteList32BitServiceClassUuids = (byte)0x04, +CompleteList32BitServiceClassUuids = (byte)0x05, + + IncompleteList128BitServiceClassUuids = (byte)0x06, +CompleteList128BitServiceClassUuids = (byte)0x07, +ShortenedLocalName = (byte)0x08, +CompleteLocalName = (byte)0x09, + + ClassOfDevice = (byte)0x0D, +SimplePairingHashC = (byte)0x0E, +SimplePairingRandomizerR = (byte)0x0F + + } |
IDs of OOB Data according to the Bluetooth Generic Access Profile (GAP). More... | |
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... | |
+Public Member Functions | |
NdefBtSecureSimplePairingRecord () | |
Create an empty Bluetooth Secure Simple Pairing / Carrier Configuration record. More... | |
NdefBtSecureSimplePairingRecord (NdefRecord other) | |
Create a Bluetooth Secure Simple Pairing / Carrier Configuration 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 Bluetooth Secure Simple Pairing / Carrier Configuration Record. Only checks the type and type name format, doesn't analyze if the payload is valid. More... | |
+Static Public Attributes | |
static readonly byte[] | BtOobType = Encoding.UTF8.GetBytes("application/vnd.bluetooth.ep.oob") |
Type of the Bluetooth Carrier Configuration Record. More... | |
+Properties | |
byte[] | BtDeviceAddress [get, set] |
Bluetooth device address. More... | |
string | BtDeviceAddressString [get, set] |
Get / set the Bluetooth device address as a hex string instead of the byte array. The address string is in a format like "00:0c:78:51:c4:06". More... | |
string | CompleteLocalName [get, set] |
The complete local device name / friendly name of the Bluetooth device. This is usually shown to the user during a Bluetooth search or when attempting to establish a connection to the device. More... | |
BtClassOfDevice | ClassOfDevice [get, set] |
The Bluetooth Class of Device information, which is used to provide a graphical representation to the user as part of UI involving operations with Bluetooth devices. More... | |
BtServiceClasses | ServiceClasses [get, set] |
Defines the supported Bluetooth services of the device. More... | |
byte[] | SimplePairingHashC [get, set] |
The optional Simple Pairing Hash C can be used to facilitate the pairing process. More... | |
byte[] | SimplePairingRandomizerR [get, set] |
The optional Simple Pairing Randomizer to facilitate pairing. 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 | |
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... | |
Create an NDEF record for Bluetooth Carrier Handover according to the "Secure Simple Pairing" mechanism defined by the Bluetooth SIG.
+This record is usually written on static NFC tags that facilitate Bluetooth handover, as found in speakers or headsets. It enables devices to establish a Bluetooth connection by tapping the NFC tag, without having to manually start a device & service search.
+The record has to define at least the Bluetooth device address. In addition, it usually contains additional optional Bluetooth OOB (Out-Of-Band) data - for example the friendly device name, information about the device class as well as supported services.
+In some cases, also a pairing hash and randomizer can be supplied.
+The class represents a complete implementation, including all currently standardized services and device classes as per May 20th, 2014 and defined at: https://www.bluetooth.org/en-us/specification/assigned-numbers In addition, it provides convenient look-up functions and definitions to work with the numerous different defined classes and services.
+The record is implemented according to the specification published by the NFC Forum. The record is defined as a Media-type per RFC2046, its payload by the Extended Inquiry Response (EIR) format specified in the Bluetooth Core Specification, Volume 3, Part C, Section 8.
+For information regards to compatibility with the Windows platform: http://msdn.microsoft.com/en-us/library/windows/hardware/dn482419%28v=vs.85%29.aspx Supported protocols in Windows: http://msdn.microsoft.com/en-us/library/windows/hardware/jj866066%28v=vs.85%29.aspx
+
+
|
+ +strong | +
IDs of OOB Data according to the Bluetooth Generic Access Profile (GAP).
+The OOB (Bluetooth Out Of Band) data consists of several data blocks. Each data block first specifies the data block length, then this ID, and then the data type specific payload data (e.g., the local device name). https://www.bluetooth.org/en-us/specification/assigned-numbers/generic-access-profile
+ +NdefLibrary.Ndef.NdefBtSecureSimplePairingRecord.NdefBtSecureSimplePairingRecord | +( | +) | ++ |
Create an empty Bluetooth Secure Simple Pairing / Carrier Configuration record.
+ +NdefLibrary.Ndef.NdefBtSecureSimplePairingRecord.NdefBtSecureSimplePairingRecord | +( | +NdefRecord | +other | ) | ++ |
Create a Bluetooth Secure Simple Pairing / Carrier Configuration 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 Bluetooth Carrier Configuration Record as well.
+other | Record to copy into this Secure Simple Pairing record. |
NdefException | Thrown if attempting to create an Secure Simple Pairing Record based on an incompatible record type. |
+
|
+ +static | +
Checks if the record sent via the parameter is indeed a Bluetooth Secure Simple Pairing / Carrier Configuration Record. Only checks the type and type name format, doesn't analyze if the payload is valid.
+record | Record to check. |
+
|
+ +static | +
Type of the Bluetooth Carrier Configuration Record.
+ +
+
|
+ +getset | +
Bluetooth device address.
+Encoded in little endian order. For example, the Bluetooth Address 00:0c:78:51:c4:06 would be encoded as 0x06 0xC4 0x51 0x78 0x0C 0x00.
+ +
+
|
+ +getset | +
Get / set the Bluetooth device address as a hex string instead of the byte array. The address string is in a format like "00:0c:78:51:c4:06".
+ +
+
|
+ +getset | +
The Bluetooth Class of Device information, which is used to provide a graphical representation to the user as part of UI involving operations with Bluetooth devices.
+For example, the UI may show a particular icon to represent the device, which is chosen based on the class of device defined by this property.
+ +
+
|
+ +getset | +
The complete local device name / friendly name of the Bluetooth device. This is usually shown to the user during a Bluetooth search or when attempting to establish a connection to the device.
+ +
+
|
+ +getset | +
Defines the supported Bluetooth services of the device.
+The service classes can be represented as 16 / 32 / 128 bit UUIDs. For standardized services, usually 16 bit UUIDs are used. The class contains a convenient enumeration for the currently standardized service classes.
+ +
+
|
+ +getset | +
The optional Simple Pairing Hash C can be used to facilitate the pairing process.
+The Hash C should be generated anew for each pairing - this is usually not possible on passive & static NFC Forum tags.
+ +
+
|
+ +getset | +
The optional Simple Pairing Randomizer to facilitate pairing.
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefBtSecureSimplePairingRecord.BtClassOfDevice, including all inherited members.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
Defines the Class of Device information data. This is to be used to provide a graphical representation to the user as part of UI involving operations with Bluetooth devices. For example, it may provide a particular icon to represent the device. + More...
++Classes | |
class | MinorDeviceClassType |
Information class that specifies required information to correclty parse and create a minor device class based on one or more encoded values. The exact format of the minor device class depends on the major device class in use, and this class enables to look up the encoding and lets this implementation take care of most of the complex underlying work that needs to be done. More... | |
+Public Types | |
enum | ClassOfDeviceFormatTypes : uint { Format1 = 0x00 + } |
Defines the format of the class of device information. Only two bits are used. More... | |
enum | MajorServiceClassTypes : uint { + LimitedDiscoverableMode = 1 << 0, +ReservedBit14 = 1 << 1, +ReservedBit15 = 1 << 2, +Positioning = 1 << 3, + + Networking = 1 << 4, +Rendering = 1 << 5, +Capturing = 1 << 6, +ObjectTransfer = 1 << 7, + + Audio = 1 << 8, +Telephony = 1 << 9, +Information = 1 << 10 + + } |
The different major service class flags, including the two reserved bits not yet in use. The actual service class in use can be a combination of one or more of these flags. More... | |
enum | MajorDeviceClassTypes : uint { + Miscellaneous = (uint)0x00, +Computer = (uint)0x01, +Phone = (uint)0x02, +LanNetworkAccessPoint = (uint)0x03, + + AudioVideo = (uint)0x04, +Peripheral = (uint)0x05, +Imaging = (uint)0x06, +Wearable = (uint)0x07, + + Toy = (uint)0x08, +Health = (uint)0x09, +Uncategorized = (uint)0x1F + + } |
Different major device class types currently standardized. More... | |
enum | MinorDeviceClassList : uint { + ComputerUncategorized, +ComputerDesktopWorkstation, +ComputerServerClassComputer, +ComputerLaptop, + + ComputerHandheldPcPdaClamshell, +ComputerPalmSizePcPda, +ComputerWearableComputerWatchSize, +ComputerTablet, + + PhoneUncategorized, +PhoneCellular, +PhoneCordless, +PhoneSmartphone, + + PhoneWiredModemOrVoiceGateway, +PhoneCommonIsdnAccess, +Lan1FullyAvailable, +Lan1_1To17PercentUtilized, + + Lan1_17To33PercentUtilized, +Lan1_33To50PercentUtilized, +Lan1_50To67PercentUtilized, +Lan1_67To83PercentUtilized, + + Lan1_83To99PercentUtilized, +Lan1NoServiceAvailable, +Lan2Uncategorized, +AudioVideoUncategorized, + + AudioVideoWearableHeadsetDevice, +AudioVideoHandsFreeDevice, +AudioVideoMicrophone, +AudioVideoLoudspeaker, + + AudioVideoHeadphones, +AudioVideoPortableAudio, +AudioVideoCarAudio, +AudioVideoSetTopBox, + + AudioVideoHiFiAudioDevice, +AudioVideoVcr, +AudioVideoVideoCamera, +AudioVideoCamcorder, + + AudioVideoVideoMonitor, +AudioVideoVideoDisplayAndLoudspeaker, +AudioVideoVideoConferencing, +AudioVideoGamingToy, + + Peripheral1NotKeyboardNotPointing, +Peripheral1Keyboard, +Peripheral1Pointing, +Peripheral1ComboKeyboardPointing, + + Peripheral2Uncategorized, +Peripheral2Joystick, +Peripheral2Gamepad, +Peripheral2RemoteControl, + + Peripheral2SensingDevice, +Peripheral2DigitizerTablet, +Peripheral2CardReader, +Peripheral2DigitalPen, + + Peripheral2HandheldScanner, +Peripheral2HandheldGesturalInput, +ImagingDisplay, +ImagingCamera, + + ImagingScanner, +ImagingPrinter, +ImagingUncategorized, +WearableWristwatch, + + WearablePager, +WearableJacket, +WearableHelmet, +WearableGlasses, + + ToyRobot, +ToyVehicle, +ToyDollActionFigure, +ToyController, + + ToyGame, +HealthUndefined, +HealthBloodPressureMonitor, +HealthThermometer, + + HealthWeighingScale, +HealthGlucoseMeter, +HealthPulseOximeter, +HealthHeartPulseRateMonitor, + + HealthHealthDataDisplay, +HealthStepCounter, +HealthBodyCompositionAnalyzer, +HealthPeakFlowMonitor, + + HealthMedicationMonitor, +HealthKneeProsthesis, +HealthAnkleProsthesis, +HealthGenericHealthManager, + + HealthPersonalMobilityDevice, +Unknown + + } |
Definition list of the minor device classes currently standardized for Bluetooth. More... | |
+Public Member Functions | |
void | SetMajorServiceClassFromEnum (MajorServiceClassTypes majorClass) |
Set the MajorServiceClass property by providing a single service class as specified by the MajorServiceClassTypes enum. More... | |
void | SetMajorServiceClassFromEnum (IEnumerable< MajorServiceClassTypes > majorClasses) |
Set the major service class by providing a list of service class types. The method takes care of combining those into the single MajorServiceClass property. More... | |
List< MajorServiceClassTypes > | MajorServiceClassesAsList () |
Get the current major service class(es) as a list of enum values, which makes parsing easier than having to manually check for flags. More... | |
void | SetMajorDeviceClassFromEnum (MajorDeviceClassTypes deviceClass) |
Set the major device class by directly specifying the enum value. More... | |
List< MinorDeviceClassList > | MinorDeviceClassAsEnum (int primarySecondary) |
Get all currently set minor device class values as a list for the specified primary or secondary minor device class. More... | |
List< MinorDeviceClassType > | MinorDeviceClassAsType (int primarySecondary) |
Get all currently set minor device class values as extended type info for the specified primary or secondary minor device class. More... | |
void | SetMinorDeviceClassFromEnum (List< MinorDeviceClassList > minorClassType, int primarySecondary, bool clearPrevious) |
Conveniently set a minor device class by supplying enum values, letting the implementation to figure out the exact bit encoding. More... | |
BtClassOfDevice (byte[] codData) | |
Create a new class of device instance and parse the supplied class of device data into the instance properties. More... | |
BtClassOfDevice () | |
Create an empty class of device instance. More... | |
byte[] | ToByteArray () |
Convert the data stored in this class of device instance to a byte array, for use in the payload of the parent record. More... | |
+Static Public Member Functions | |
static int | NumDeviceClassesForMajorClass (MajorDeviceClassTypes majorType) |
Get how many minor classes the supplied major class has. A major class can have 0 to 2 minor classes, depending on its type. See the Bluetooth specifications for more details. More... | |
static bool | UsesFlagsForMinorClass (MajorDeviceClassTypes majorType, int primarySecondary) |
Check whether the major type is using flags for its minor type (primary / secondary). If yes, multiple minor values can be set for a minor type. If no, only a single minor value applies. More... | |
+Static Public Attributes | |
static readonly List< MinorDeviceClassType > | MinorDeviceClasses |
Minor device class definitions. Used by the implementation to assemble and to parse the minor device class information encoded into the record. More... | |
+Properties | |
ClassOfDeviceFormatTypes | ClassOfDeviceFormat [get, set] |
The class of device format currently in use by the class of device definition. More... | |
uint | MajorServiceClass [get, set] |
Defines the major service class of the Bluetooth device. Bitmask containing one or more flags from the MajorServiceClassTypes enum. More... | |
uint | MajorDeviceClass [get, set] |
Major device class of the Bluetooth device. Can equal one of the types defined in the MajorDeviceClassTypes enum. More... | |
uint | MinorDeviceClass [get, set] |
Minor device class of the Bluetooth of the device. More... | |
Defines the Class of Device information data. This is to be used to provide a graphical representation to the user as part of UI involving operations with Bluetooth devices. For example, it may provide a particular icon to represent the device.
+For more information regarding the standardized values that are contained in the class of device, see: https://www.bluetooth.org/en-us/specification/assigned-numbers/baseband
+
+
|
+ +strong | +
Defines the format of the class of device information. Only two bits are used.
+Currently, only the format #1 is defined / standardized.
+ +
+
|
+ +strong | +
Different major device class types currently standardized.
+ +
+
|
+ +strong | +
The different major service class flags, including the two reserved bits not yet in use. The actual service class in use can be a combination of one or more of these flags.
+ +
+
|
+ +strong | +
Definition list of the minor device classes currently standardized for Bluetooth.
+The values are not mapped directly to bit-values stored in the payload. They are used to interact with the class and to conveniently set one or more minor device classes. The implementation will take care of setting the correct bits when you supply the minor device classes. Of course, you need to make sure the minor device classes fit to the major device class.
+ +NdefLibrary.Ndef.NdefBtSecureSimplePairingRecord.BtClassOfDevice.BtClassOfDevice | +( | +byte[] | +codData | ) | ++ |
Create a new class of device instance and parse the supplied class of device data into the instance properties.
+codData | Class of device payload data to parse and to internalize for use in this class through properties. |
NdefLibrary.Ndef.NdefBtSecureSimplePairingRecord.BtClassOfDevice.BtClassOfDevice | +( | +) | ++ |
Create an empty class of device instance.
+ +List<MajorServiceClassTypes> NdefLibrary.Ndef.NdefBtSecureSimplePairingRecord.BtClassOfDevice.MajorServiceClassesAsList | +( | +) | ++ |
Get the current major service class(es) as a list of enum values, which makes parsing easier than having to manually check for flags.
+List<MinorDeviceClassList> NdefLibrary.Ndef.NdefBtSecureSimplePairingRecord.BtClassOfDevice.MinorDeviceClassAsEnum | +( | +int | +primarySecondary | ) | ++ |
Get all currently set minor device class values as a list for the specified primary or secondary minor device class.
+primarySecondary | Set to 1 to retrieve the minor device class values for the first minor class, or set to 2 for the second minor class (if applicable). |
List<MinorDeviceClassType> NdefLibrary.Ndef.NdefBtSecureSimplePairingRecord.BtClassOfDevice.MinorDeviceClassAsType | +( | +int | +primarySecondary | ) | ++ |
Get all currently set minor device class values as extended type info for the specified primary or secondary minor device class.
+In contrast to the MinorDeviceClassAsEnum() method, this will retrieve a list of MinorDeviceClassType objects; these contain not just the actual minor device class value(s), but also additional information about each minor device class in use. See the definition of the MinorDeviceClassType class for more details
+primarySecondary | Set to 1 to retrieve the minor device class values for the first minor class, or set to 2 for the second minor class (if applicable). |
+
|
+ +static | +
Get how many minor classes the supplied major class has. A major class can have 0 to 2 minor classes, depending on its type. See the Bluetooth specifications for more details.
+majorType | The major type to retrieve the number of minor classes for. |
void NdefLibrary.Ndef.NdefBtSecureSimplePairingRecord.BtClassOfDevice.SetMajorDeviceClassFromEnum | +( | +MajorDeviceClassTypes | +deviceClass | ) | ++ |
Set the major device class by directly specifying the enum value.
+deviceClass | The major device class as enum value. |
void NdefLibrary.Ndef.NdefBtSecureSimplePairingRecord.BtClassOfDevice.SetMajorServiceClassFromEnum | +( | +MajorServiceClassTypes | +majorClass | ) | ++ |
Set the MajorServiceClass property by providing a single service class as specified by the MajorServiceClassTypes enum.
+majorClass | The major service class to set. |
void NdefLibrary.Ndef.NdefBtSecureSimplePairingRecord.BtClassOfDevice.SetMajorServiceClassFromEnum | +( | +IEnumerable< MajorServiceClassTypes > | +majorClasses | ) | ++ |
Set the major service class by providing a list of service class types. The method takes care of combining those into the single MajorServiceClass property.
+majorClasses | A list of different major service classes. |
void NdefLibrary.Ndef.NdefBtSecureSimplePairingRecord.BtClassOfDevice.SetMinorDeviceClassFromEnum | +( | +List< MinorDeviceClassList > | +minorClassType, | +
+ | + | int | +primarySecondary, | +
+ | + | bool | +clearPrevious | +
+ | ) | ++ |
Conveniently set a minor device class by supplying enum values, letting the implementation to figure out the exact bit encoding.
+minorClassType | The minor device class value to set. If the minor device class supports setting multiple values as flags, the minorClassType list parameter can contain multiple minor device classes. Otherwise, it can only contain a single minor device class. Find out how if the minor device class uses flags, use UsesFlagsForMinorClass(). |
primarySecondary | Whether to assign the minor device class value as a primary or secondary minor device class. Set to 1 to retrieve the minor device class values for the first minor class, or set to 2 for the second minor class (if applicable). |
clearPrevious | Set to true to delete all minor device classes that are currently assigned before applying the new minor device class. This essentially sets the MinorDeviceClass property to 0 before using the logical OR operator to add the new minor device class. |
byte [] NdefLibrary.Ndef.NdefBtSecureSimplePairingRecord.BtClassOfDevice.ToByteArray | +( | +) | ++ |
Convert the data stored in this class of device instance to a byte array, for use in the payload of the parent record.
+
+
|
+ +static | +
Check whether the major type is using flags for its minor type (primary / secondary). If yes, multiple minor values can be set for a minor type. If no, only a single minor value applies.
+Currently, only the primary minor class of the Imaging major class is using flags.
+majorType | Major device class type to retrieve the information for. |
primarySecondary | Use the primary or secondary bits. |
+
|
+ +static | +
Minor device class definitions. Used by the implementation to assemble and to parse the minor device class information encoded into the record.
+For details about the individual values, see the MinorDeviceClassType class definition. The actual definitions correspond to the Bluetooth specification, as defined by: https://www.bluetooth.org/en-us/specification/assigned-numbers/baseband
+ +
+
|
+ +getset | +
The class of device format currently in use by the class of device definition.
+ +
+
|
+ +getset | +
Major device class of the Bluetooth device. Can equal one of the types defined in the MajorDeviceClassTypes enum.
+ +
+
|
+ +getset | +
Defines the major service class of the Bluetooth device. Bitmask containing one or more flags from the MajorServiceClassTypes enum.
+ +
+
|
+ +getset | +
Minor device class of the Bluetooth of the device.
+This is the original value, where multiple minor device classes can be encoded. Note that the value retrieved here does not directly correspond to the MinorDeviceClassList enum definition. To de-encode the values that are actually set to the enum, use the MinorDeviceClassAsEnum() method.
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefBtSecureSimplePairingRecord.BtClassOfDevice.MinorDeviceClassType, including all inherited members.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
Information class that specifies required information to correclty parse and create a minor device class based on one or more encoded values. The exact format of the minor device class depends on the major device class in use, and this class enables to look up the encoding and lets this implementation take care of most of the complex underlying work that needs to be done. + More...
++Properties | |
uint | MajorFieldByte [get, set] |
The major device class this instance is describing - specified as a uint value, but can be casted to the MajorDeviceClassTypes enum. More... | |
uint | MinorFieldByte [get, set] |
The value of the minor device class defined by this instance. Note that only a certain number of bits are used from this definition (specified in NumBits) and that it might be necessary to bit-shift the value for the minor device class overall definition (specified by BitOffset). More... | |
MinorDeviceClassList | MinorList [get, set] |
The minor device class represented as the enum value. Note that this enum value is not related to the actual bits set in the minor device class - these are specified by the MinorFieldByte property. More... | |
int | PrimarySecondary [get, set] |
If this instance describes the primary (1) or secondary (2) minor device class. How many device classes are available depends on the major device class. More... | |
int | NumBits [get, set] |
How many bits are used by the MinorFieldByte according to the definition. Especially if multiple minor device classes are encoded, the number of bits in use for the minor device class can be less than usual in order to leave room for other values (in the secondary class). More... | |
int | BitOffset [get, set] |
Offset to be used for bit shifting to get the MinorFieldByte to the correct position in the overall minor device class field in the payload of the OOB record. More... | |
Information class that specifies required information to correclty parse and create a minor device class based on one or more encoded values. The exact format of the minor device class depends on the major device class in use, and this class enables to look up the encoding and lets this implementation take care of most of the complex underlying work that needs to be done.
+
+
|
+ +getset | +
Offset to be used for bit shifting to get the MinorFieldByte to the correct position in the overall minor device class field in the payload of the OOB record.
+ +
+
|
+ +getset | +
The major device class this instance is describing - specified as a uint value, but can be casted to the MajorDeviceClassTypes enum.
+ +
+
|
+ +getset | +
The value of the minor device class defined by this instance. Note that only a certain number of bits are used from this definition (specified in NumBits) and that it might be necessary to bit-shift the value for the minor device class overall definition (specified by BitOffset).
+ +
+
|
+ +getset | +
The minor device class represented as the enum value. Note that this enum value is not related to the actual bits set in the minor device class - these are specified by the MinorFieldByte property.
+ +
+
|
+ +getset | +
How many bits are used by the MinorFieldByte according to the definition. Especially if multiple minor device classes are encoded, the number of bits in use for the minor device class can be less than usual in order to leave room for other values (in the secondary class).
+ +
+
|
+ +getset | +
If this instance describes the primary (1) or secondary (2) minor device class. How many device classes are available depends on the major device class.
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefBtSecureSimplePairingRecord.BtServiceClasses, including all inherited members.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
Utility class to handle the Bluetooth Service Classes defined in the OOB data of the Secure Simple Pairing Record. + More...
++Public Types | |
enum | ServiceClassTypes : ushort { + ServiceDiscoveryServerServiceClassID = 0x1000, +BrowseGroupDescriptorServiceClassID = 0x1001, +SerialPort = 0x1101, +LANAccessUsingPPP = 0x1102, + + DialupNetworking = 0x1103, +IrMCSync = 0x1104, +OBEXObjectPush = 0x1105, +OBEXFileTransfer = 0x1106, + + IrMCSyncCommand = 0x1107, +Headset = 0x1108, +CordlessTelephony = 0x1109, +AudioSource = 0x110A, + + AudioSink = 0x110B, +AV_RemoteControlTarget = 0x110C, +AdvancedAudioDistribution = 0x110D, +AV_RemoteControl = 0x110E, + + AV_RemoteControlController = 0x110F, +Intercom = 0x1110, +Fax = 0x1111, +Headset_AudioGateway = 0x1112, + + WAP = 0x1113, +WAP_CLIENT = 0x1114, +PANU = 0x1115, +NAP = 0x1116, + + GN = 0x1117, +DirectPrinting = 0x1118, +ReferencePrinting = 0x1119, +BasicImagingProfile = 0x111A, + + ImagingResponder = 0x111B, +ImagingAutomaticArchive = 0x111C, +ImagingReferencedObjects = 0x111D, +Handsfree = 0x111E, + + HandsfreeAudioGateway = 0x111F, +DirectPrintingReferenceObjectsService = 0x1120, +ReflectedUI = 0x1121, +BasicPrinting = 0x1122, + + PrintingStatus = 0x1123, +HumanInterfaceDeviceService = 0x1124, +HardcopyCableReplacement = 0x1125, +HCR_Print = 0x1126, + + HCR_Scan = 0x1127, +Common_ISDN_Access = 0x1128, +SIM_Access = 0x112D, +PhonebookAccess_PCE = 0x112E, + + PhonebookAccess_PSE = 0x112F, +PhonebookAccess = 0x1130, +HeadsetHS = 0x1131, +MessageAccessServer = 0x1132, + + MessageNotificationServer = 0x1133, +MessageAccessProfile = 0x1134, +GNSS = 0x1135, +GNSS_Server = 0x1136, + + ThreeD_Display = 0x1137, +ThreeD_Glasses = 0x1138, +ThreeD_Synchronization = 0x1139, +MPS_Profile_UUID = 0x113A, + + MPS_SC_UUID = 0x113B, +PnPInformation = 0x1200, +GenericNetworking = 0x1201, +GenericFileTransfer = 0x1202, + + GenericAudio = 0x1203, +GenericTelephony = 0x1204, +UPNP_Service = 0x1205, +UPNP_IP_Service = 0x1206, + + ESDP_UPNP_IP_PAN = 0x1300, +ESDP_UPNP_IP_LAP = 0x1301, +ESDP_UPNP_L2CAP = 0x1302, +VideoSource = 0x1303, + + VideoSink = 0x1304, +VideoDistribution = 0x1305, +HDP = 0x1400, +HDPSource = 0x1401, + + HDPSink = 0x1402 + + } |
Contains a list of currently valid Bluetooth service classes according to the specification. More... | |
+Public Member Functions | |
int | BitsPerServiceClass () |
How many bit are used for each service class according to the current DataType setting in this instance. More... | |
int | BytesPerServiceClass () |
How many bytes are used for each service class according to the current DataType setting in this instance. More... | |
void | AddServiceClassType (ServiceClassTypes newSc) |
Add a new service class to the list, specified as an enum value instead of a raw byte array. The method will take care of using the correct bit length to store the UUID, according to the setting in use for this instance. More... | |
BtServiceClasses (byte scType, byte[] scData) | |
Create a new instance of the Bluetooth Service Class and parse the supplied service class type (defines the UUID lengths) and data (contains the actual service class UUIDs). More... | |
BtServiceClasses () | |
Create an empty instance of the Bluetooth Service Class helper. More... | |
byte[] | ToByteArray () |
Convert the properties currently stored in this class instance to a byte array, which can then be used to embed this information into OOB data payload of the parent Bluetooth Secure Simple Pairing record. More... | |
+Static Public Member Functions | |
static string | UuidAs128BitString (ServiceClassTypes serviceClassType) |
Format the specified service class type enum value as a string that represents the 128 bit format conversion. More... | |
static ServiceClassTypes | UuidFrom128String (string uuid) |
Convert the specified service class string to a service class type enum value. More... | |
static ServiceClassTypes | ConvertServiceClassToType (byte[] scBytes) |
Convert the specified service class byte array to the enum type for more convenient use in your app. More... | |
+Properties | |
List< byte[]> | ServiceClasses [get, set] |
Contains the list of raw byte values specifying the individual service classes assigned. The number of bits for each contained byte array corresponds to the service list type. More... | |
List< ServiceClassTypes > | ServiceClassesAsTypes [get] |
Return the currently set service class values as a list of enum values for easier use within your own application. More... | |
OobDataTypes | DataType [get, set] |
Defines the data structure of the service classes (complete / incomplete, 16, 32 or 128 bit per service class definition) More... | |
Utility class to handle the Bluetooth Service Classes defined in the OOB data of the Secure Simple Pairing Record.
+The service class UUIDs are defined as per the Bluetooth specificiation: https://www.bluetooth.org/en-us/specification/assigned-numbers/service-discovery The values can either be defined as 16 / 32 / 128 bit values. Most common are 16 bit values, as these are currently enough to cover all standardized Bluetooth use cases. It is possible to create a higher-bit value from a lower bit value, e.g. to create a 128 bit value from a 128 bit value. From the Bluetooth Specification 4.1 [Vol 3], page 228, section 2.5.1 128_bit_value = 16_bit_value * 2^96 + Bluetooth_Base_UUID 128_bit_value = 32_bit_value * 2^96 + Bluetooth_Base_UUID A 16-bit UUID may be converted to 32-bit UUID format by zero-extending the 16-bit value to 32-bits. An equivalent method is to add the 16-bit UUID value to a zero-valued 32-bit UUID.
+
+
|
+ +strong | +
Contains a list of currently valid Bluetooth service classes according to the specification.
+The enum defines the byte values that can be directly used for the service classes. For the complete list, see: https://www.bluetooth.org/en-us/specification/assigned-numbers/service-discovery
+ +NdefLibrary.Ndef.NdefBtSecureSimplePairingRecord.BtServiceClasses.BtServiceClasses | +( | +byte | +scType, | +
+ | + | byte[] | +scData | +
+ | ) | ++ |
Create a new instance of the Bluetooth Service Class and parse the supplied service class type (defines the UUID lengths) and data (contains the actual service class UUIDs).
+scType | Specifies the service class type, which has to be defined in the OobDataTypes enum and defines the number of bits used for each service class UUID (16 / 32 / 128 bits) |
scData | Byte array continaing one or more service class UUIDs, each in the bit length specified by the scType parameter. |
NdefLibrary.Ndef.NdefBtSecureSimplePairingRecord.BtServiceClasses.BtServiceClasses | +( | +) | ++ |
Create an empty instance of the Bluetooth Service Class helper.
+ +void NdefLibrary.Ndef.NdefBtSecureSimplePairingRecord.BtServiceClasses.AddServiceClassType | +( | +ServiceClassTypes | +newSc | ) | ++ |
Add a new service class to the list, specified as an enum value instead of a raw byte array. The method will take care of using the correct bit length to store the UUID, according to the setting in use for this instance.
+newSc | New service class type to add. |
int NdefLibrary.Ndef.NdefBtSecureSimplePairingRecord.BtServiceClasses.BitsPerServiceClass | +( | +) | ++ |
How many bit are used for each service class according to the current DataType setting in this instance.
+int NdefLibrary.Ndef.NdefBtSecureSimplePairingRecord.BtServiceClasses.BytesPerServiceClass | +( | +) | ++ |
How many bytes are used for each service class according to the current DataType setting in this instance.
+
+
|
+ +static | +
Convert the specified service class byte array to the enum type for more convenient use in your app.
+scBytes | Byte array that contains the service class. Has to have a length of 2, 4 or 16 bytes. |
NdefException | Thrown if the supplied byte array does not have a valid length. |
byte [] NdefLibrary.Ndef.NdefBtSecureSimplePairingRecord.BtServiceClasses.ToByteArray | +( | +) | ++ |
Convert the properties currently stored in this class instance to a byte array, which can then be used to embed this information into OOB data payload of the parent Bluetooth Secure Simple Pairing record.
+
+
|
+ +static | +
Format the specified service class type enum value as a string that represents the 128 bit format conversion.
+serviceClassType | The service class type to represent as a string. |
+
|
+ +static | +
Convert the specified service class string to a service class type enum value.
+Only works for UUIDs that are based on the Bluetooth standard base UUID where only the first 16 / 32 bit are customized. The string needs to correspond to the schema: "xxxx-0000-1000-8000-00805f9b34fb", where xxxx is the 32-bit value used for the service class.
+uuid | String-based UUID to parse |
+
|
+ +getset | +
Defines the data structure of the service classes (complete / incomplete, 16, 32 or 128 bit per service class definition)
+If you change this value, all the currently stored service classes will be automatically recreated based on the new bit length.
+ +
+
|
+ +getset | +
Contains the list of raw byte values specifying the individual service classes assigned. The number of bits for each contained byte array corresponds to the service list type.
+ +
+
|
+ +get | +
Return the currently set service class values as a list of enum values for easier use within your own application.
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefException, including all inherited members.
+NdefException() (defined in NdefLibrary.Ndef.NdefException) | NdefLibrary.Ndef.NdefException | |
NdefException(string message) (defined in NdefLibrary.Ndef.NdefException) | NdefLibrary.Ndef.NdefException | |
NdefException(string message, Exception inner) (defined in NdefLibrary.Ndef.NdefException) | NdefLibrary.Ndef.NdefException |
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
Exception occured when parsing or assembling NDEF messages, records and their respective payloads. + More...
++Public Member Functions | |
+ | NdefException (string message) |
+ | NdefException (string message, Exception inner) |
Exception occured when parsing or assembling NDEF messages, records and their respective payloads.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefExceptionMessages, including all inherited members.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
A strongly-typed resource class, for looking up localized strings, etc. + More...
++Properties | |
static global::System.Resources.ResourceManager | ResourceManager [get] |
Returns the cached ResourceManager instance used by this class. More... | |
static global::System.Globalization.CultureInfo | Culture [get, set] |
Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. More... | |
static string | ExBtCodUnknownFormat [get] |
Looks up a localized string similar to Unknown format for class of device information.. More... | |
static string | ExBtInvalidLength [get] |
Looks up a localized string similar to Encoded Bluetooth OOB data length does not match payload length.. More... | |
static string | ExBtInvalidLengthSimplePairingHashC [get] |
Looks up a localized string similar to Invalid length of the simple pairing hash C (should be 16 octets).. More... | |
static string | ExBtInvalidLengthSimplePairingRandomizerR [get] |
Looks up a localized string similar to Invalid length of the simple pairing randomizer R (should be 16 octets).. More... | |
static string | ExBtInvalidMinimumLength [get] |
Looks up a localized string similar to OOB data does not reach minumum length of 8 bytes.. More... | |
static string | ExBtNoDeviceAddress [get] |
Looks up a localized string similar to Bluetooth Device address must be defined.. More... | |
static string | ExBtNoValidHexAddress [get] |
Looks up a localized string similar to No valid Bluetooth address in hexadecimal format.. More... | |
static string | ExBtNoValidServiceClassId [get] |
Looks up a localized string similar to No valid Bluetooth Service Class ID.. More... | |
static string | ExBtNoValidServiceClassLength [get] |
Looks up a localized string similar to Bluetooth Service Class Length invalid.. More... | |
static string | ExGeoNoHereMapsAppId [get] |
Looks up a localized string similar to HERE Maps URI schemes require an AppId.. More... | |
static string | ExHandoverAcCarrierNoData [get] |
Looks up a localized string similar to No Carrier Data Reference present in Handover Select / Alternative Carrier record.. More... | |
static string | ExHandoverDataReferenceTooLong [get] |
Looks up a localized string similar to Data Reference is too long - use the record ID in max 255 characters.. More... | |
static string | ExHandoverDataTooManyAuxiliaryReferences [get] |
Looks up a localized string similar to Too many auxiliary data references - use max 255 data references.. More... | |
static string | ExHandoverErrorInvalidData [get] |
Looks up a localized string similar to Invalid error data.. More... | |
static string | ExHandoverErrorInvalidSourceData [get] |
Looks up a localized string similar to Can not create Handover Error record based on the provided source data.. More... | |
static string | ExHandoverErrorNoData [get] |
Looks up a localized string similar to No error data present.. More... | |
static string | ExHandoverErrorNoReason [get] |
Looks up a localized string similar to No error reason present.. More... | |
static string | ExHandoverErrorUnknownReason [get] |
Looks up a localized string similar to Unknown error reason.. More... | |
static string | ExHandoverInvalidVersion [get] |
Looks up a localized string similar to Handover version must be one byte, containing major and minor fields.. More... | |
static string | ExHandoverNoCarrierDataReference [get] |
Looks up a localized string similar to The Alternative Carrier record needs to define a carrier data reference.. More... | |
static string | ExHandoverSelectMsgInvalidRecords [get] |
Looks up a localized string similar to Can not create Handover Select message - found illegal record.. More... | |
static string | ExIcalendarNoCalendarFound [get] |
Looks up a localized string similar to No calendar data found in the supplied calendar data.. More... | |
static string | ExIcalendarNoEventFound [get] |
Looks up a localized string similar to The supplied calendar information does not contain a valid event / appointment.. More... | |
static string | ExInvalidCopy [get] |
Looks up a localized string similar to Attempted to instantiate new record from incompatible record.. More... | |
static string | ExLaunchAppArgumentsEmpty [get] |
Looks up a localized string similar to Arguments for LaunchApp must not be empty.. More... | |
static string | ExLaunchAppPlatformLength [get] |
Looks up a localized string similar to Unable to assemble LaunchApp payload: length of platform / AppID tuple more than 255 characters.. More... | |
static string | ExLaunchAppPlatformMissing [get] |
Looks up a localized string similar to Unable to assemble LaunchApp payload: at least one platform / AppID tuple is required.. More... | |
static string | ExLaunchAppPlatformsEmpty [get] |
Looks up a localized string similar to At least one platform / app ID tuple needs to be defined.. More... | |
static string | ExLaunchAppWpId [get] |
Looks up a localized string similar to For a Windows Phone platform ID, please supply the 36 character product ID containing only hexadecimal characters and '-'.. More... | |
static string | ExMailtoAddressEmpty [get] |
Looks up a localized string similar to Recipient address must not be empty.. More... | |
static string | ExMailtoAddressNotValid [get] |
Looks up a localized string similar to The recipient address does not appear to be valid.. More... | |
static string | ExMessageBeginLate [get] |
Looks up a localized string similar to Ndef parse error: Message Begin flag present after first record.. More... | |
static string | ExMessageBeginMissing [get] |
Looks up a localized string similar to Ndef parse error: Expected Message Begin missing in first record.. More... | |
static string | ExMessageEndLate [get] |
Looks up a localized string similar to Ndef parse error: Message End flag present after last record.. More... | |
static string | ExMessageInvalidChunkedId [get] |
Looks up a localized string similar to Ndef parse error: Invalid chunked data, Id Length != 0.. More... | |
static string | ExMessageInvalidChunkedType [get] |
Looks up a localized string similar to Ndef parse error: Invalid chunked data, Type Length != 0.. More... | |
static string | ExMessageNoBeginOrEnd [get] |
Looks up a localized string similar to Ndef parse error: Malformed NDEF Message, missing begin or end.. More... | |
static string | ExMessagePartialChunk [get] |
Looks up a localized string similar to Ndef parse error: Partial chunk not empty or typeNameFormat not 0x06 as expected.. More... | |
static string | ExMessageUnexpectedEnd [get] |
Looks up a localized string similar to Ndef parse error: Unexpected end of message.. More... | |
static string | ExNearSpeakLanguageWrongLength [get] |
Looks up a localized string similar to Language code must be 5 characters.. More... | |
static string | ExNearSpeakNoCloudId [get] |
Looks up a localized string similar to Online ID must be set.. More... | |
static string | ExNearSpeakNoLanguage [get] |
Looks up a localized string similar to Language code must be defined.. More... | |
static string | ExNearSpeakNoText [get] |
Looks up a localized string similar to Text to speak must not be empty.. More... | |
static string | ExNearSpeakNoValidType [get] |
Looks up a localized string similar to No valid NearSpeak type identifier.. More... | |
static string | ExNokiaAccessoriesProductEmpty [get] |
Looks up a localized string similar to ProductName for Nokia Accessories record must not be empty.. More... | |
static string | ExNokiaAccessoriesSerialEmpty [get] |
Looks up a localized string similar to Serial number for Nokia Accessories must not be empty.. More... | |
static string | ExNokiaAccessoriesSerialFormat [get] |
Looks up a localized string similar to Serial number must be 19 chars, decimal numbers only.. More... | |
static string | ExRawUriNoAbbreviation [get] |
Looks up a localized string similar to The raw URI can only be retrieved if the URI is not abbreviated by the record.. More... | |
static string | ExRecordEmptyWithTypeOrPayload [get] |
Looks up a localized string similar to The Empty record must not have a payload or a type.. More... | |
static string | ExRecordNoType [get] |
Looks up a localized string similar to No Type set for record.. More... | |
static string | ExRecordUnchangedId [get] |
Looks up a localized string similar to Id must not be set for middle or terminating record (TNF = Unchanged).. More... | |
static string | ExRecordUnchangedTypeName [get] |
Looks up a localized string similar to Record with TNF Unchanged must have an empty type name.. More... | |
static string | ExSmsBodyEmpty [get] |
Looks up a localized string similar to Body text for SMS record must not be empty.. More... | |
static string | ExSmsNumberEmpty [get] |
Looks up a localized string similar to Number for SMS record must not be empty.. More... | |
static string | ExSocialNoUser [get] |
Looks up a localized string similar to Social user name must not be empty.. More... | |
static string | ExSpUriEmpty [get] |
Looks up a localized string similar to Uri of Smart Poster ust not be empty.. More... | |
static string | ExTelNumberEmpty [get] |
Looks up a localized string similar to Number for telephone record must not be empty.. More... | |
A strongly-typed resource class, for looking up localized strings, etc.
+
+
|
+ +staticgetset | +
Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class.
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Unknown format for class of device information..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Encoded Bluetooth OOB data length does not match payload length..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Invalid length of the simple pairing hash C (should be 16 octets)..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Invalid length of the simple pairing randomizer R (should be 16 octets)..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to OOB data does not reach minumum length of 8 bytes..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Bluetooth Device address must be defined..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to No valid Bluetooth address in hexadecimal format..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to No valid Bluetooth Service Class ID..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Bluetooth Service Class Length invalid..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to HERE Maps URI schemes require an AppId..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to No Carrier Data Reference present in Handover Select / Alternative Carrier record..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Data Reference is too long - use the record ID in max 255 characters..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Too many auxiliary data references - use max 255 data references..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Invalid error data..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Can not create Handover Error record based on the provided source data..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to No error data present..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to No error reason present..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Unknown error reason..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Handover version must be one byte, containing major and minor fields..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to The Alternative Carrier record needs to define a carrier data reference..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Can not create Handover Select message - found illegal record..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to No calendar data found in the supplied calendar data..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to The supplied calendar information does not contain a valid event / appointment..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Attempted to instantiate new record from incompatible record..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Arguments for LaunchApp must not be empty..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Unable to assemble LaunchApp payload: length of platform / AppID tuple more than 255 characters..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Unable to assemble LaunchApp payload: at least one platform / AppID tuple is required..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to At least one platform / app ID tuple needs to be defined..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to For a Windows Phone platform ID, please supply the 36 character product ID containing only hexadecimal characters and '-'..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Recipient address must not be empty..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to The recipient address does not appear to be valid..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Ndef parse error: Message Begin flag present after first record..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Ndef parse error: Expected Message Begin missing in first record..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Ndef parse error: Message End flag present after last record..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Ndef parse error: Invalid chunked data, Id Length != 0..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Ndef parse error: Invalid chunked data, Type Length != 0..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Ndef parse error: Malformed NDEF Message, missing begin or end..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Ndef parse error: Partial chunk not empty or typeNameFormat not 0x06 as expected..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Ndef parse error: Unexpected end of message..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Language code must be 5 characters..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Online ID must be set..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Language code must be defined..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Text to speak must not be empty..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to No valid NearSpeak type identifier..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to ProductName for Nokia Accessories record must not be empty..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Serial number for Nokia Accessories must not be empty..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Serial number must be 19 chars, decimal numbers only..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to The raw URI can only be retrieved if the URI is not abbreviated by the record..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to The Empty record must not have a payload or a type..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to No Type set for record..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Id must not be set for middle or terminating record (TNF = Unchanged)..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Record with TNF Unchanged must have an empty type name..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Body text for SMS record must not be empty..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Number for SMS record must not be empty..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Social user name must not be empty..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Uri of Smart Poster ust not be empty..
+ +
+
|
+ +staticget | +
Looks up a localized string similar to Number for telephone record must not be empty..
+ +
+
|
+ +staticget | +
Returns the cached ResourceManager instance used by this class.
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefGeoRecord, including all inherited members.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
Store longitude and latitude on a tag, to allow the user to view a map when tapping the tag. + More...
++Public Types | |
enum | NfcGeoType { + NfcGeoType.GeoUri = 0, +NfcGeoType.BingMaps, +NfcGeoType.NokiaMapsUri, +NfcGeoType.WebRedirect, + + NfcGeoType.MsDriveTo, +NfcGeoType.MsWalkTo, +NfcGeoType.HereDirections, +NfcGeoType.HereDriveGuidance, + + NfcGeoType.HereWalkGuidance, +NfcGeoType.HerePublicTransit, +NfcGeoType.HereExploreShowMap, +NfcGeoType.HereExploreShowPlace + + } |
Format of the URI on the geo tag. More... | |
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... | |
+Public Member Functions | |
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... | |
Public Member Functions inherited from NdefLibrary.Ndef.NdefSmartUriRecord | |
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... | |
+Static Public Member Functions | |
static bool | IsHereMapsType (NfcGeoType geoType) |
Check if the current geo type is one of the HERE maps schemes, as these require the AppId. 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... | |
+Properties | |
double | Longitude [get, set] |
Longitude of the coordinate to encode in the Geo URI. More... | |
double | Latitude [get, set] |
Latitude of the coordinate to encode in the Geo URI. More... | |
string | PlaceTitle [get, set] |
Title of the specified place. Used by MsDriveTo, MsWalkTo and the HERE maps schemes. More... | |
string | AppId [get, set] |
App ID - has to be present for HERE maps schemes, unfortunately. It is obviously risky to share your app ID on public NFC tags, so be careful and use the generic MsDriveTo scheme in those cases. More... | |
NfcGeoType | GeoType [get, set] |
Format to use for encoding the coordinate into a URI. More... | |
Properties inherited from NdefLibrary.Ndef.NdefSmartUriRecord | |
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 | |
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... | |
Store longitude and latitude on a tag, to allow the user to view a map when tapping the tag.
+Geo tags are not standardized by the NFC forum, therefore, this class supports three different types of writing the location to a tag.
+As this class is based on the Smart URI base class, the payload is formatted as a URI record initially. When first adding Smart Poster information (like a title), the payload instantly transforms into a Smart Poster.
+
+
|
+ +strong | +
Format of the URI on the geo tag.
+
+
|
+ +virtual | +
Checks if the contents of the record are valid; throws an exception if a problem is found, containing a textual description of the issue.
+NdefException | Thrown if no valid NDEF record can be created based on the record's current contents. The exception message contains further details about the issue. |
Reimplemented from NdefLibrary.Ndef.NdefRecord.
+ +
+
|
+ +static | +
Check if the current geo type is one of the HERE maps schemes, as these require the AppId.
+
+
|
+ +getset | +
App ID - has to be present for HERE maps schemes, unfortunately. It is obviously risky to share your app ID on public NFC tags, so be careful and use the generic MsDriveTo scheme in those cases.
+ +
+
|
+ +getset | +
Format to use for encoding the coordinate into a URI.
+ +
+
|
+ +getset | +
Latitude of the coordinate to encode in the Geo URI.
+ +
+
|
+ +getset | +
Longitude of the coordinate to encode in the Geo URI.
+ +
+
|
+ +getset | +
Title of the specified place. Used by MsDriveTo, MsWalkTo and the HERE maps schemes.
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefHandoverAlternativeCarrierRecord, including all inherited members.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
The Alternative Carrier record is used within the payload of the Handover Select record to describe a single alternative carrier. + More...
++Public Types | |
enum | CarrierPowerStates : byte { Inactive = 0x00, +Active = 0x01, +Activating = 0x02, +Unknown = 0x03 + } |
Enum to conveniently access the 2-bit field that indicates the carrier power state. More... | |
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... | |
+Public Member Functions | |
void | AddAuxiliaryDataReference (byte[] auxiliaryDataReference) |
Convenience method to add another auxiliary data reference to the list. Using this method ensures that the list is already created and updates the payload according to the changes. More... | |
NdefHandoverAlternativeCarrierRecord () | |
Create an empty Alternative Carrier Record. More... | |
NdefHandoverAlternativeCarrierRecord (NdefRecord other) | |
Create an Alternative Carrier Record based on the record passed through the argument. More... | |
bool | AssemblePayload () |
Create the payload based on the data stored in the properties. Usually called automatically when changing properties, but you might need to call this manually if you modify the list of auxiliary data references directly without using accessor method provided by this class. 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... | |
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... | |
+Static Public Member Functions | |
static bool | IsRecordType (NdefRecord record) |
Checks if the record sent via the parameter is indeed a Handover Alternate Carrier record. Checks the type and type name format. More... | |
+Static Public Attributes | |
static readonly byte[] | BtAcType = Encoding.UTF8.GetBytes("ac") |
Type of the Alternative Carrier Record. More... | |
+Properties | |
CarrierPowerStates | CarrierPowerState [get, set] |
2-bit field that indicates the carrier power state. More... | |
byte | CarrierPowerStateAsByte [get, set] |
Access the Carrier Power State property as a byte instead of the enum. Note that according to the current Bluetooth specification (1.3), only two bits of the byte are in use for the Carrier Power State. More... | |
byte[] | CarrierDataReference [get, set] |
The Carrier Data Reference is a pointer to an NDEF record that uniquely identifies the carrier technology. More... | |
string | CarrierDataReferenceAsString [get, set] |
Access the byte array that should contain chars forming a number as a string for easier manipulation from within an app. More... | |
List< byte[]> | AuxiliaryDataReferenceList [get, set] |
An Auxiliary Data Reference is a pointer to an NDEF record that gives additional information about the alternative carrier. 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 | |
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... | |
The Alternative Carrier record is used within the payload of the Handover Select record to describe a single alternative carrier.
+This record essentially describes a single alternative carrier, including its power state and a reference to where further details can be found - this is done by referencing the ID of the other NDEF record within the same handover message. The pointed record may be a Handover Carrier record or a Carrier Configuration record.
+Optional Auxiliary Data reference(s) are pointers to NDEF records that contain additional information about the alternative carrier. There are no limitations on the type of record that can be pointed to.
+
+
|
+ +strong | +
Enum to conveniently access the 2-bit field that indicates the carrier power state.
+ +NdefLibrary.Ndef.NdefHandoverAlternativeCarrierRecord.NdefHandoverAlternativeCarrierRecord | +( | +) | ++ |
Create an empty Alternative Carrier Record.
+ +NdefLibrary.Ndef.NdefHandoverAlternativeCarrierRecord.NdefHandoverAlternativeCarrierRecord | +( | +NdefRecord | +other | ) | ++ |
Create an Alternative Carrier 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 Alternative Carrier Record as well.
+other | Record to copy into this Alternative Carrier Record. |
NdefException | Thrown if attempting to create a Alternative Carrier Record based on an incompatible record type. |
void NdefLibrary.Ndef.NdefHandoverAlternativeCarrierRecord.AddAuxiliaryDataReference | +( | +byte[] | +auxiliaryDataReference | ) | ++ |
Convenience method to add another auxiliary data reference to the list. Using this method ensures that the list is already created and updates the payload according to the changes.
+If you manually modify the AuxiliaryDataReferenceList, you need to call AssemblePayload() manually when you are finished with changes and want the payload to be synchronized to the properties.
+auxiliaryDataReference | The auxiliary data reference to add. This is the record ID of another record within the Handover Select payload which contains additional information about this alternative carrier. |
bool NdefLibrary.Ndef.NdefHandoverAlternativeCarrierRecord.AssemblePayload | +( | +) | ++ |
Create the payload based on the data stored in the properties. Usually called automatically when changing properties, but you might need to call this manually if you modify the list of auxiliary data references directly without using accessor method provided by this class.
+NdefException | Thrown if unable to assemble the payload. The exception message contains further details about the issue. |
+
|
+ +virtual | +
Checks if the contents of the record are valid; throws an exception if a problem is found, containing a textual description of the issue.
+NdefException | Thrown if no valid NDEF record can be created based on the record's current contents. The exception message contains further details about the issue. |
Reimplemented from NdefLibrary.Ndef.NdefRecord.
+ +
+
|
+ +static | +
Checks if the record sent via the parameter is indeed a Handover Alternate Carrier record. Checks the type and type name format.
+record | Record to check. |
+
|
+ +static | +
Type of the Alternative Carrier Record.
+ +
+
|
+ +getset | +
An Auxiliary Data Reference is a pointer to an NDEF record that gives additional information about the alternative carrier.
+ +
+
|
+ +getset | +
The Carrier Data Reference is a pointer to an NDEF record that uniquely identifies the carrier technology.
+Reference is the record ID of a Handover Carrier record or a Carrier Configuration Record (can also be a Bluetooth Secure Simple Pairing record)
+ +
+
|
+ +getset | +
Access the byte array that should contain chars forming a number as a string for easier manipulation from within an app.
+ +
+
|
+ +getset | +
2-bit field that indicates the carrier power state.
+ +
+
|
+ +getset | +
Access the Carrier Power State property as a byte instead of the enum. Note that according to the current Bluetooth specification (1.3), only two bits of the byte are in use for the Carrier Power State.
+If setting a Carrier power state that is not known by the enum, the internal value is set to Unknown.
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefHandoverErrorRecord, including all inherited members.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
The Error Record is used in the Handover Select Record to indicate that the Handover Selector failed to successfully process the most recently received Handover Request Message. It SHALL NOT be used elsewhere. + More...
++Public Types | |
enum | ErrorReasonTypes : byte { Reserved = 0x00, +ErrorReasonTypes.TemporaryMemoryConstraints = 0x01, +ErrorReasonTypes.PermanentMemoryConstraints = 0x02, +ErrorReasonTypes.CarrierSpecificConstraints = 0x03 + } |
According to the current specification, four different error reasons are defined. Depending on the value set for the error reason, the error data has a different meaning. More... | |
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... | |
+Public Member Functions | |
NdefHandoverErrorRecord () | |
Create an empty Handover Error Record. More... | |
NdefHandoverErrorRecord (NdefRecord other) | |
Create a Handover Error record based on the record passed through the argument. More... | |
NdefHandoverErrorRecord (byte errorReason, byte[] errorData) | |
Create a Handover Error record based on the supplied error reason and error data, coming from direct byte arrays. More... | |
NdefHandoverErrorRecord (ErrorReasonTypes errorReason, uint errorData) | |
Create a Handover Error record based on the supplied error reason and error data, coming from higher level convenience types that this class will convert to the appropriate byte level representation. 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 Handover Error record. Checks the type and type name format. More... | |
+Static Public Attributes | |
static readonly byte[] | BtHandoverErrorType = { 0x65, 0x72, 0x72 } |
Type of the Handover Select / Error Record. More... | |
+Properties | |
byte | ErrorReason [get, set] |
The actual byte used to store the error reason in the Handover Error record. More... | |
ErrorReasonTypes | ErrorReasonAsType [get, set] |
Access the byte-based ErrorReason property through the enum variable for easier use within apps. More... | |
byte[] | ErrorData [get, set] |
Byte array that contains the error data - additional information about the error. Its contents depend on the error reason and are described in the error reason enum documentation. More... | |
uint | ErrorDataAsNumber [get, set] |
Access the ErrorData byte array as an Integer. 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 | |
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... | |
The Error Record is used in the Handover Select Record to indicate that the Handover Selector failed to successfully process the most recently received Handover Request Message. It SHALL NOT be used elsewhere.
+
+
|
+ +strong | +
According to the current specification, four different error reasons are defined. Depending on the value set for the error reason, the error data has a different meaning.
+NdefLibrary.Ndef.NdefHandoverErrorRecord.NdefHandoverErrorRecord | +( | +) | ++ |
Create an empty Handover Error Record.
+This record is only valid within the Handover Select record.
+ +NdefLibrary.Ndef.NdefHandoverErrorRecord.NdefHandoverErrorRecord | +( | +NdefRecord | +other | ) | ++ |
Create a Handover Error 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 Handover Error Record as well.
+other | Record to copy into this Handover Error record. |
NdefException | Thrown if attempting to create a Handover Error record based on an incompatible record type. |
NdefLibrary.Ndef.NdefHandoverErrorRecord.NdefHandoverErrorRecord | +( | +byte | +errorReason, | +
+ | + | byte[] | +errorData | +
+ | ) | ++ |
Create a Handover Error record based on the supplied error reason and error data, coming from direct byte arrays.
+This record is only valid within the Handover Select record.
+errorReason | The reason why the handover request could not be processed by the target device. The value of this defines the possible contents and content length of the second (errorData) parameter. |
errorData | Additional data for the error reason. The contents depend on the error reason, and is usually a time value. |
NdefLibrary.Ndef.NdefHandoverErrorRecord.NdefHandoverErrorRecord | +( | +ErrorReasonTypes | +errorReason, | +
+ | + | uint | +errorData | +
+ | ) | ++ |
Create a Handover Error record based on the supplied error reason and error data, coming from higher level convenience types that this class will convert to the appropriate byte level representation.
+This record is only valid within the Handover Select record.
+errorReason | The reason why the handover request could not be processed by the target device. The value of this defines the possible contents and content length of the second (errorData) parameter. |
errorData | Additional data for the error reason. The contents depend on the error reason, and is usually a time value. |
+
|
+ +static | +
Checks if the record sent via the parameter is indeed a Handover Error record. Checks the type and type name format.
+record | Record to check. |
+
|
+ +static | +
Type of the Handover Select / Error Record.
+ +
+
|
+ +getset | +
Byte array that contains the error data - additional information about the error. Its contents depend on the error reason and are described in the error reason enum documentation.
+ +
+
|
+ +getset | +
Access the ErrorData byte array as an Integer.
+Based on the current Connection Handover 1.3 specification, all possible error data values are time lengths with a different byte number / maximum duration. Therefore, this class provides this convenience accessor to the ErrorData property, which correctly converts a number stored in the ErrorData array based on the number of bytes as defined by the error reason.
+ +
+
|
+ +getset | +
The actual byte used to store the error reason in the Handover Error record.
+ +
+
|
+ +getset | +
Access the byte-based ErrorReason property through the enum variable for easier use within apps.
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefHandoverSelectRecord, including all inherited members.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
Handover Select Record for the Connection Handover Standard. Its payload contains at least one reference to an Alternative Carrier record that defines a possible carrier for a connection handover. + More...
++Public Member Functions | |
void | AddHandoverAlternativeCarrierRecord (NdefHandoverAlternativeCarrierRecord newRecord) |
Add another Alternative Carrier record as a child and create the storage list if necessary. Also automatically updates the payload. More... | |
NdefHandoverSelectRecord () | |
Create an empty Handover Select Record. More... | |
NdefHandoverSelectRecord (NdefRecord other) | |
Create a Handover Select record based on the record passed through the argument. More... | |
NdefHandoverSelectRecord (NdefHandoverVersion version) | |
Create a Handover Select record based on the specified version number. More... | |
NdefHandoverSelectRecord (NdefHandoverVersion version, NdefHandoverAlternativeCarrierRecord alternativeCarrier) | |
Create a Handover Select record based on the specified version number and supplying an alternative carrier record. More... | |
void | AssemblePayload () |
Create the payload based on the data stored in the properties. Usually called automatically when changing properties, but you might need to call this manually if you modify the list of alternative carrier records directly without using accessor method provided by this class. More... | |
void | SetAndAssignChildRecords (byte[] payloadToParse) |
Go through the records stored in this message, parse them and assign them to the individual properties. This also checks if the child records are actually valid for a Handover Select message. 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 Handover Select record. Checks the type and type name format. More... | |
+Static Public Attributes | |
static readonly byte[] | BtHsType = Encoding.UTF8.GetBytes("Hs") |
Type of the Bluetooth Carrier Configuration Record. More... | |
+Properties | |
NdefHandoverVersion | HandoverVersion [get, set] |
Indicates the connection handover specification, split up into a Major and a Minor version number. This implementation conforms to the Connection Handover specification version 1.3 by the NFC Forum. More... | |
List< NdefHandoverAlternativeCarrierRecord > | HandoverAlternativeCarrierRecords [get, set] |
After the Handover Select record, usually one or more Alternative Carrier records follow that define the possible carriers for the handover. More... | |
NdefHandoverErrorRecord | HandoverErrorRecord [get, set] |
The optional error record needs to be last in the message and can contain details if there was a problem. 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... | |
Handover Select Record for the Connection Handover Standard. Its payload contains at least one reference to an Alternative Carrier record that defines a possible carrier for a connection handover.
+This record is sent either in a connection handover process to select alternative carriers, or it can also be stored on an NFC tag to provide information about a connection handover to for example a Bluetooth carrier.
+After the version information (this record is implemented according to version 1.3 of the NFC Forum Connection Handover specification from 2014-01-16), the payload of this record essentially contains a complete NDEF message (within its payload!) that identifies alternative carriers. These are then subrecords within this record.
+At the end, one Handover error record may follow.
+NdefLibrary.Ndef.NdefHandoverSelectRecord.NdefHandoverSelectRecord | +( | +) | ++ |
Create an empty Handover Select Record.
+ +NdefLibrary.Ndef.NdefHandoverSelectRecord.NdefHandoverSelectRecord | +( | +NdefRecord | +other | ) | ++ |
Create a Handover Select 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 Handover Select Record as well.
+other | Record to copy into this Handover Select record. |
NdefException | Thrown if attempting to create a Handover Select record based on an incompatible record type. |
NdefLibrary.Ndef.NdefHandoverSelectRecord.NdefHandoverSelectRecord | +( | +NdefHandoverVersion | +version | ) | ++ |
Create a Handover Select record based on the specified version number.
+To use the Handover Select record, you also need to supply at least one Alternative Carrier record.
+version | Version to use for the handover select record. |
NdefLibrary.Ndef.NdefHandoverSelectRecord.NdefHandoverSelectRecord | +( | +NdefHandoverVersion | +version, | +
+ | + | NdefHandoverAlternativeCarrierRecord | +alternativeCarrier | +
+ | ) | ++ |
Create a Handover Select record based on the specified version number and supplying an alternative carrier record.
+version | Version to use for the handover select record. |
alternativeCarrier | A single alternative carrier record. If you want to add multiple alternative carrier records, use the AddHandoverAlternativeCarrierRecord() method. |
void NdefLibrary.Ndef.NdefHandoverSelectRecord.AddHandoverAlternativeCarrierRecord | +( | +NdefHandoverAlternativeCarrierRecord | +newRecord | ) | ++ |
Add another Alternative Carrier record as a child and create the storage list if necessary. Also automatically updates the payload.
+newRecord | Additional Alternative Carrier record to add to the list for use as children of the Handover Select record. |
void NdefLibrary.Ndef.NdefHandoverSelectRecord.AssemblePayload | +( | +) | ++ |
Create the payload based on the data stored in the properties. Usually called automatically when changing properties, but you might need to call this manually if you modify the list of alternative carrier records directly without using accessor method provided by this class.
+NdefException | Thrown if unable to assemble the payload. The exception message contains further details about the issue. |
+
|
+ +static | +
Checks if the record sent via the parameter is indeed a Handover Select record. Checks the type and type name format.
+record | Record to check. |
void NdefLibrary.Ndef.NdefHandoverSelectRecord.SetAndAssignChildRecords | +( | +byte[] | +payloadToParse | ) | ++ |
Go through the records stored in this message, parse them and assign them to the individual properties. This also checks if the child records are actually valid for a Handover Select message.
+ +
+
|
+ +static | +
Type of the Bluetooth Carrier Configuration Record.
+ +
+
|
+ +getset | +
After the Handover Select record, usually one or more Alternative Carrier records follow that define the possible carriers for the handover.
+Note: setting this list triggers updating the payload. If you modify the list directly, make sure you call AssemblePayload() to trigger another payload update. Or use the AddHandoverAlternativeCarrierRecord() method to automate this process.
+ +
+
|
+ +getset | +
The optional error record needs to be last in the message and can contain details if there was a problem.
+ +
+
|
+ +getset | +
Indicates the connection handover specification, split up into a Major and a Minor version number. This implementation conforms to the Connection Handover specification version 1.3 by the NFC Forum.
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefHandoverVersion, including all inherited members.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
Utility class that handles the correct format for storing version information in Handover records. The handover version contains a major and minor version. This implementation conforms to the specification with major version 1 and minor version 3. + More...
++Public Member Functions | |
NdefHandoverVersion () | |
Create a new handover version utility class instance, which can format the major and minor version according to the Handover specification 1.3. More... | |
NdefHandoverVersion (byte combinedVersion) | |
Create a new handover version utility class instance, which can format the major and minor version according to the Handover specification 1.3. More... | |
NdefHandoverVersion (float version) | |
Create a new handover version utility class instance, which can format the major and minor version according to the Handover specification 1.3. More... | |
+Properties | |
ushort | Major [get, set] |
4-bit field is the major version of the Connection Handover specification and SHALL be set to 1 by an implementation that conforms to this specification. More... | |
ushort | Minor [get, set] |
4-bit field is the minor version of the Connection Handover specification and SHALL be set to 3 by an implementation that conforms to this specification. More... | |
byte | Version [get, set] |
The version as a byte that contains 4 bits for the major version and 4 bit for the minor version. More... | |
Utility class that handles the correct format for storing version information in Handover records. The handover version contains a major and minor version. This implementation conforms to the specification with major version 1 and minor version 3.
+NdefLibrary.Ndef.NdefHandoverVersion.NdefHandoverVersion | +( | +) | ++ |
Create a new handover version utility class instance, which can format the major and minor version according to the Handover specification 1.3.
+ +NdefLibrary.Ndef.NdefHandoverVersion.NdefHandoverVersion | +( | +byte | +combinedVersion | ) | ++ |
Create a new handover version utility class instance, which can format the major and minor version according to the Handover specification 1.3.
+combinedVersion | The field to use for the version, contains 4 bits for minor and 4 bits for the major version. |
NdefLibrary.Ndef.NdefHandoverVersion.NdefHandoverVersion | +( | +float | +version | ) | ++ |
Create a new handover version utility class instance, which can format the major and minor version according to the Handover specification 1.3.
+version | Parse the float version into a major and minor component. |
+
|
+ +getset | +
4-bit field is the major version of the Connection Handover specification and SHALL be set to 1 by an implementation that conforms to this specification.
+When an NDEF parser reads a different value, it SHALL NOT assume backwards compatibility. Changing this property automatically also updates the combined Version property.
+ +
+
|
+ +getset | +
4-bit field is the minor version of the Connection Handover specification and SHALL be set to 3 by an implementation that conforms to this specification.
+When an NDEF parser reads a different value, it SHALL NOT assume backwards compatibility. Changing this property automatically also updates the combined Version property.
+ +
+
|
+ +getset | +
The version as a byte that contains 4 bits for the major version and 4 bit for the minor version.
+Changing this property automatically also udpates the major and minor accrssor properties.
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefIcalendarRecordBase, including all inherited members.
+_payload | NdefLibrary.Ndef.NdefRecord | protected |
_type | NdefLibrary.Ndef.NdefRecord | protected |
CheckIfValid() | NdefLibrary.Ndef.NdefRecord | virtual |
CheckSpecializedType(bool checkForSubtypes) | NdefLibrary.Ndef.NdefRecord | |
IcalType | NdefLibrary.Ndef.NdefIcalendarRecordBase | static |
Id | NdefLibrary.Ndef.NdefRecord | |
IsRecordType(NdefRecord record) | NdefLibrary.Ndef.NdefIcalendarRecordBase | static |
NdefIcalendarRecordBase() | NdefLibrary.Ndef.NdefIcalendarRecordBase | |
NdefIcalendarRecordBase(NdefRecord other) | NdefLibrary.Ndef.NdefIcalendarRecordBase | protected |
NdefRecord() | NdefLibrary.Ndef.NdefRecord | |
NdefRecord(TypeNameFormatType tnf, byte[] type) | NdefLibrary.Ndef.NdefRecord | |
NdefRecord(NdefRecord other) | NdefLibrary.Ndef.NdefRecord | |
Payload | NdefLibrary.Ndef.NdefRecord | |
Type | NdefLibrary.Ndef.NdefRecord | |
TypeNameFormat | NdefLibrary.Ndef.NdefRecord | |
TypeNameFormatType enum name | NdefLibrary.Ndef.NdefRecord |
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+Public Member Functions | |
NdefIcalendarRecordBase () | |
Create an empty MIME/iCal Record. 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/iCal record. Only checks the type and type name format, doesn't analyze if the payload is valid. More... | |
+Static Public Attributes | |
static readonly byte[] | IcalType = Encoding.UTF8.GetBytes("text/calendar") |
Type of the NDEF MIME / iCal record. More... | |
+Protected Member Functions | |
NdefIcalendarRecordBase (NdefRecord other) | |
Create a MIME/iCal record based on the record passed through the argument. 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... | |
NdefLibrary.Ndef.NdefIcalendarRecordBase.NdefIcalendarRecordBase | +( | +) | ++ |
Create an empty MIME/iCal Record.
+ +
+
|
+ +protected | +
Create a MIME/iCal 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/iCal Record as well.
+other | Record to copy into this iCal record. |
NdefException | Thrown if attempting to create a iCal record based on an incompatible record type. |
+
|
+ +static | +
Checks if the record sent via the parameter is indeed a MIME/iCal record. Only checks the type and type name format, doesn't analyze if the payload is valid.
+record | Record to check. |
+
|
+ +static | +
Type of the NDEF MIME / iCal record.
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefLaunchAppRecord, including all inherited members.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
Handles the Windows LaunchApp record format. + More...
++Public Member Functions | |
NdefLaunchAppRecord () | |
Create an empty LaunchApp Record. More... | |
NdefLaunchAppRecord (NdefRecord other) | |
Create a LaunchApp record based on the record passed through the argument. More... | |
void | AddPlatformAppId (string platform, string appId) |
Add another platform and app ID. 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... | |
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... | |
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... | |
+Static Public Member Functions | |
static bool | IsRecordType (NdefRecord record) |
Checks if the record sent via the parameter is indeed a LaunchApp record. Only checks the type and type name format, doesn't analyze if the payload is valid. More... | |
+Properties | |
string | Arguments [get, set] |
Arguments that will be passed to the launched application. More... | |
Dictionary< string, string > | PlatformIds [get] |
Platform names and respective app IDs. 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... | |
Handles the Windows LaunchApp record format.
+The Proximity APIs can directly write LaunchApp tags using a specific API call. However, this doesn't allow flexibility in including this record together with other records on a tag, to allow for greater flexibility.
+A LaunchApp record created using this class can be put into a multi-record NDEF message. This allows creating a tag that contains both the Windows LaunchApp tag, as well as the Android Application Record.
+Note that for default handling by the OS, the Windows LaunchApp tag needs to be the first record in the message. Android recommends to put its Android Application Record (AAR) as the last record of the message.
+To create a LaunchApp tag using the Windows Proximity APIs, you have to pass a string containing the arguments and platform/app ID tuples in a special format (separated by tabs). The APIs then re-format the text into the actual payload of the record - meaning that the string you send to the Proximity LaunchApp Write API does NOT get directly written to the tag.
+In contrast, this class provides a more convenient way to set the arguments and to add any number of platforms; all using properties or methods, without the need to worry about formatting a special string. This class will then directly create the required raw payload that is suitable to be written to the tag.
+NdefLibrary.Ndef.NdefLaunchAppRecord.NdefLaunchAppRecord | +( | +) | ++ |
Create an empty LaunchApp Record.
+ +NdefLibrary.Ndef.NdefLaunchAppRecord.NdefLaunchAppRecord | +( | +NdefRecord | +other | ) | ++ |
Create a LaunchApp 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 LaunchApp Record as well.
+other | Record to copy into this LaunchApp record. |
NdefException | Thrown if attempting to create a LaunchApp record based on an incompatible record type. |
void NdefLibrary.Ndef.NdefLaunchAppRecord.AddPlatformAppId | +( | +string | +platform, | +
+ | + | string | +appId | +
+ | ) | ++ |
Add another platform and app ID.
+A valid LaunchApp tag needs to contain at least one platform / app ID tuple. The platform name needs to be unique. Each platform name + app ID has to be smaller or equal to 255 characters. If known, the appID will be checked for semantic correctness.
+platform | Name of the platform, e.g., Windows or WindowsPhone. |
appId | ID of the platform. See platform documentation on how to format the platform ID. |
+
|
+ +virtual | +
Checks if the contents of the record are valid; throws an exception if a problem is found, containing a textual description of the issue.
+NdefException | Thrown if no valid NDEF record can be created based on the record's current contents. The exception message contains further details about the issue. |
Reimplemented from NdefLibrary.Ndef.NdefRecord.
+ +
+
|
+ +static | +
Checks if the record sent via the parameter is indeed a LaunchApp record. Only checks the type and type name format, doesn't analyze if the payload is valid.
+record | Record to check. |
void NdefLibrary.Ndef.NdefLaunchAppRecord.SetPayloadAndParse | +( | +byte[] | +payload, | +
+ | + | bool | +parseNewPayload | +
+ | ) | ++ |
Sets the payload of the base class to the byte array from the parameter and optionally parses its contents.
+The parsing needs to be done when the LaunchApp record is read from a tag. If a detail of an existing LaunchApp class is modified, it will just update its internal payload, but doesn't need to parse it again (as the details are already stored in the respecitve member variables).
+payload | new payload |
parseNewPayload | whether to parse the new payload to update the internal data properties |
+
|
+ +getset | +
Arguments that will be passed to the launched application.
+The exact format is up to the app itself. The arguments string must not be empty; otherwise, the reading device might ignore the LaunchApp record.
+ +
+
|
+ +get | +
Platform names and respective app IDs.
+The key is the platform name, the value the app ID for this specific platform. A valid LaunchApp tag needs to contain at least one platform / app ID tuple. The platform name needs to be unique. Each platform name + app ID has to be smaller or equal to 255 characters.
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefMailtoRecord, including all inherited members.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
Convenience class for creating records that open the email app on the user's device, with a specified recipient address, subject and body text. + More...
++Public Member Functions | |
NdefMailtoRecord () | |
Create an empty Mailto record. More... | |
NdefMailtoRecord (NdefRecord other) | |
Create a Mailto record based on another Mailto record, or a Smart Poster / URI record that has a Uri set that corresponds to the mailto: URI scheme. 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... | |
Public Member Functions inherited from NdefLibrary.Ndef.NdefSmartUriRecord | |
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... | |
+Static Public Member Functions | |
static new bool | IsRecordType (NdefRecord record) |
Checks if the record sent via the parameter is indeed a Mailto record. Checks the type and type name format and if the URI starts with the correct scheme. 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... | |
+Properties | |
string | Address [get, set] |
Email address of the recipient. More... | |
string | Subject [get, set] |
Optional pre-written subject to use for the email. More... | |
string | Body [get, set] |
Optional pre-written body to use for the email. More... | |
Properties inherited from NdefLibrary.Ndef.NdefSmartUriRecord | |
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 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... | |
Convenience class for creating records that open the email app on the user's device, with a specified recipient address, subject and body text.
+Implements the mailto URI scheme, which is also widely known from links on web pages. Most devices should react in the same way if they encounter this URI scheme from an NFC tag.
+The record should always have the recipient address defined, which needs to be a valid email address. Optionally, you can also add a subject and body text.
+The reading device will usually not send the email directly, but usually opens the user's email app with the contents you specified pre-defined. In general, the user can then still modify the contents and send the email.
+This class takes care of correctly escaping the subject and body text, so that they form valid URLs.
+The mailto: URI scheme is defined here: http://tools.ietf.org/html/rfc2368 (this record only implements a subset of the complete URI scheme)
+NdefLibrary.Ndef.NdefMailtoRecord.NdefMailtoRecord | +( | +) | ++ |
Create an empty Mailto record.
+ +NdefLibrary.Ndef.NdefMailtoRecord.NdefMailtoRecord | +( | +NdefRecord | +other | ) | ++ |
Create a Mailto record based on another Mailto record, or a Smart Poster / URI record that has a Uri set that corresponds to the mailto: URI scheme.
+other | Other record to copy the data from. |
+
|
+ +virtual | +
Checks if the contents of the record are valid; throws an exception if a problem is found, containing a textual description of the issue.
+NdefException | Thrown if no valid NDEF record can be created based on the record's current contents. The exception message contains further details about the issue. |
Reimplemented from NdefLibrary.Ndef.NdefRecord.
+ +
+
|
+ +static | +
Checks if the record sent via the parameter is indeed a Mailto record. Checks the type and type name format and if the URI starts with the correct scheme.
+record | Record to check. |
+
|
+ +getset | +
Email address of the recipient.
+ +
+
|
+ +getset | +
Optional pre-written body to use for the email.
+The property string should not be URL escaped. Escaping will be applied directly when creating the URI through System.Uri.EscapeDataString().
+ +
+
|
+ +getset | +
Optional pre-written subject to use for the email.
+The property string should not be URL escaped. Escaping will be applied directly when creating the URI through System.Uri.EscapeDataString().
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefMessage, including all inherited members.
+FromByteArray(byte[] message) | NdefLibrary.Ndef.NdefMessage | static |
ToByteArray() | NdefLibrary.Ndef.NdefMessage |
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
An NDEF message is composed of one or more NDEF records. + More...
++Public Member Functions | |
byte[] | ToByteArray () |
Convert all the NDEF records currently stored in the NDEF message to a byte array suitable for writing to a tag or sending to another device. More... | |
+Static Public Member Functions | |
static NdefMessage | FromByteArray (byte[] message) |
Returns the NDEF message parsed from the contents of message . More... | |
An NDEF message is composed of one or more NDEF records.
+This class is essentially just a list of records, and provides the necessary methods to convert all the records into a single byte array that can be written to a tag and has the correct flags set (e.g., message begin / end). NdefMessage can also parse a byte array into an NDEF message, separating and creating all the individual records out of the array.
+From the NFC Forum specification document: NFC Forum Data Exchange Format is a lightweight binary message format designed to encapsulate one or more application-defined payloads into a single message construct.
+An NDEF message contains one or more NDEF records, each carrying a payload of arbitrary type and up to (2^32)-1 octets in size. Records can be chained together to support larger payloads.
+An NDEF record carries three parameters for describing its payload: the payload length, the payload type, and an optional payload identifier.
+
+
|
+ +static | +
Returns the NDEF message parsed from the contents of message .
+The message parameter is interpreted as the raw message format defined in the NFC Forum specifications.
+message | Raw byte array containing the NDEF message, which consists of 0 or more NDEF records. |
NdefException | Thrown if there is an error parsing the NDEF message out of the byte array. |
byte [] NdefLibrary.Ndef.NdefMessage.ToByteArray | +( | +) | ++ |
Convert all the NDEF records currently stored in the NDEF message to a byte array suitable for writing to a tag or sending to another device.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefMimeImageRecordBase, including all inherited members.
+_payload | NdefLibrary.Ndef.NdefRecord | protected |
_type | NdefLibrary.Ndef.NdefRecord | protected |
CheckIfValid() | NdefLibrary.Ndef.NdefRecord | virtual |
CheckSpecializedType(bool checkForSubtypes) | NdefLibrary.Ndef.NdefRecord | |
Id | NdefLibrary.Ndef.NdefRecord | |
ImageMimeType enum name | NdefLibrary.Ndef.NdefMimeImageRecordBase | |
ImageMimeTypes | NdefLibrary.Ndef.NdefMimeImageRecordBase | static |
IsRecordType(NdefRecord record) | NdefLibrary.Ndef.NdefMimeImageRecordBase | static |
NdefMimeImageRecordBase() | NdefLibrary.Ndef.NdefMimeImageRecordBase | protected |
NdefMimeImageRecordBase(NdefRecord other) | NdefLibrary.Ndef.NdefMimeImageRecordBase | |
NdefRecord() | NdefLibrary.Ndef.NdefRecord | |
NdefRecord(TypeNameFormatType tnf, byte[] type) | NdefLibrary.Ndef.NdefRecord | |
NdefRecord(NdefRecord other) | NdefLibrary.Ndef.NdefRecord | |
Payload | NdefLibrary.Ndef.NdefRecord | |
Type | NdefLibrary.Ndef.NdefRecord | |
TypeNameFormat | NdefLibrary.Ndef.NdefRecord | |
TypeNameFormatType enum name | NdefLibrary.Ndef.NdefRecord |
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
Stores a MIME type and image data for individual use or as a part of another record like the Smart Poster. + More...
++Public Types | |
enum | ImageMimeType { + Png, +Jpg, +Jpeg, +JpegXr, + + Bmp, +Gif, +Tiff + + } |
Common Image MIME type definitions, to be used when accessing the ImageMimeTypes dictionary to retrieve the correct MIME type string for the NDEF record. More... | |
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... | |
+Public Member Functions | |
NdefMimeImageRecordBase (NdefRecord other) | |
Create a MIME / Image 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 / Image record. Only checks the type and type name format, doesn't analyze if the payload is valid. More... | |
+Static Public Attributes | |
static readonly Dictionary< ImageMimeType, byte[]> | ImageMimeTypes |
Dictionary containing the most common MIME type definitions for various image formats. More... | |
+Protected Member Functions | |
NdefMimeImageRecordBase () | |
Create an empty MIME / Image Record with the type of PNG. More... | |
+Additional Inherited Members | |
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... | |
Stores a MIME type and image data for individual use or as a part of another record like the Smart Poster.
+This base class provides the general record layout and various common used MIME types. As the actual interaction with bitmaps and encoded images (PNG, JPEG, etc.) is not possible from within a portable class library and requires platform-specific functions, you can use the derived class in the extension library for convenience methods to work with the image.
+
+
|
+ +strong | +
Common Image MIME type definitions, to be used when accessing the ImageMimeTypes dictionary to retrieve the correct MIME type string for the NDEF record.
+ +
+
|
+ +protected | +
Create an empty MIME / Image Record with the type of PNG.
+ +NdefLibrary.Ndef.NdefMimeImageRecordBase.NdefMimeImageRecordBase | +( | +NdefRecord | +other | ) | ++ |
Create a MIME / Image record based on the record passed through the argument.
+The original record has to be a MIME / Image Record as well.
+other | Record to copy into this Image record. |
NdefException | Thrown if attempting to create an Image record based on an incompatible record type. |
+
|
+ +static | +
Checks if the record sent via the parameter is indeed a MIME / Image record. Only checks the type and type name format, doesn't analyze if the payload is valid.
+record | Record to check. |
+
|
+ +static | +
Dictionary containing the most common MIME type definitions for various image formats.
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefNokiaAccessoriesRecord, including all inherited members.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
URI NDEF Record with the custom nokia-accessories URI scheme, as used for example in the Nokia Wireless Charging Stand. + More...
++Public Member Functions | |
NdefNokiaAccessoriesRecord () | |
Create an empty Nokia Accessories record. More... | |
NdefNokiaAccessoriesRecord (NdefRecord other) | |
Create a Nokia Accessories record based on the record passed through the argument. 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... | |
Public Member Functions inherited from NdefLibrary.Ndef.NdefUriRecord | |
NdefUriRecord () | |
Create an empty URI record. More... | |
NdefUriRecord (NdefRecord other) | |
Create a URI 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... | |
+Static Public Member Functions | |
static new bool | IsRecordType (NdefRecord record) |
Checks if the record sent via the parameter is indeed a Nokia Accessories record. Checks the type and type name format as well as if the payload is valid. More... | |
Static Public Member Functions inherited from NdefLibrary.Ndef.NdefUriRecord | |
static bool | IsRecordType (NdefRecord record) |
Checks if the record sent via the parameter is indeed a URI record. Only checks the type and type name format, doesn't analyze if the payload is valid. More... | |
+Static Public Attributes | |
static readonly Dictionary< string, string > | NokiaAccessoriesNamePresets |
Static Public Attributes inherited from NdefLibrary.Ndef.NdefUriRecord | |
static readonly byte[] | UriType = { (byte)'U' } |
Type of the NDEF Text record (well-known, type 'U'). More... | |
+Properties | |
string | ProductName nokia-accessories:s\?p=(?<productName>.*);sn=(?<serialNumber>\d+)" [get, set] |
Product name, e.g., dt910 (= Nokia Wireless Charging Stand) More... | |
string | SerialNumber [get, set] |
Serial number of accessory. 19 chars, all numbers [0-9] More... | |
Properties inherited from NdefLibrary.Ndef.NdefUriRecord | |
byte[] | RawUri [get, set] |
Get the raw URI as stored in this record, excluding any abbreviations. More... | |
string | Uri [get, set] |
URI stored in this record. The abbreviation will be handled behind the scenes - getting and setting this property will always work on the full URI. 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... | |
URI NDEF Record with the custom nokia-accessories URI scheme, as used for example in the Nokia Wireless Charging Stand.
+Custom URI schemes can be associated with custom apps on Windows Phone. On Nokia phones, a pre-installed default handler for the nokia-accessories URI protocol exists. The protocol is used for example in the Nokia Wireless Charging stand.
+This record class is a specialization of the generic well-known URI NDEF record, and formats the correct URI string, based on a provided product name and serial number. See the documentation of the properties for details on the format of those.
+NdefLibrary.Ndef.NdefNokiaAccessoriesRecord.NdefNokiaAccessoriesRecord | +( | +) | ++ |
Create an empty Nokia Accessories record.
+ +NdefLibrary.Ndef.NdefNokiaAccessoriesRecord.NdefNokiaAccessoriesRecord | +( | +NdefRecord | +other | ) | ++ |
Create a Nokia Accessories 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 Nokia Accessories Record as well.
+other | Record to copy into this Text record. |
+
|
+ +virtual | +
Checks if the contents of the record are valid; throws an exception if a problem is found, containing a textual description of the issue.
+NdefException | Thrown if no valid NDEF record can be created based on the record's current contents. The exception message contains further details about the issue. |
Reimplemented from NdefLibrary.Ndef.NdefRecord.
+ +
+
|
+ +static | +
Checks if the record sent via the parameter is indeed a Nokia Accessories record. Checks the type and type name format as well as if the payload is valid.
+record | Record to check. |
+
|
+ +static | +
+
|
+ +getset | +
Product name, e.g., dt910 (= Nokia Wireless Charging Stand)
+ +
+
|
+ +getset | +
Serial number of accessory. 19 chars, all numbers [0-9]
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefRecord, including all inherited members.
+_payload | NdefLibrary.Ndef.NdefRecord | protected |
_type | NdefLibrary.Ndef.NdefRecord | protected |
CheckIfValid() | NdefLibrary.Ndef.NdefRecord | virtual |
CheckSpecializedType(bool checkForSubtypes) | NdefLibrary.Ndef.NdefRecord | |
Id | NdefLibrary.Ndef.NdefRecord | |
NdefRecord() | NdefLibrary.Ndef.NdefRecord | |
NdefRecord(TypeNameFormatType tnf, byte[] type) | NdefLibrary.Ndef.NdefRecord | |
NdefRecord(NdefRecord other) | NdefLibrary.Ndef.NdefRecord | |
Payload | NdefLibrary.Ndef.NdefRecord | |
Type | NdefLibrary.Ndef.NdefRecord | |
TypeNameFormat | NdefLibrary.Ndef.NdefRecord | |
TypeNameFormatType enum name | NdefLibrary.Ndef.NdefRecord |
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
An NDEF record contains a payload described by a type, a length, and an optional identifier. + More...
++Public Types | |
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... | |
+Public Member Functions | |
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... | |
+Protected Attributes | |
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 | |
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... | |
An NDEF record contains a payload described by a type, a length, and an optional identifier.
+This class is generic and can hold the data of any kind of record. It follows the specification from the NFC forum for the data format.
+Ndef Records should usually be placed within an Ndef Message, which will make sure that for example the message begin / end flags are set correctly.
+While the NdefRecord class only offers access to the payload as a byte array, you should rather use specialized sub classes, which offer convenient ways to handle data stored in the payload through easy access methods. Such classes are provided for several standardized types.
+
+
|
+ +strong | +
Standardized type name formats, as defined by the NDEF record specification from the Nfc Forum.
+NdefLibrary.Ndef.NdefRecord.NdefRecord | +( | +) | ++ |
Create an empty record, not setting any information.
+ +NdefLibrary.Ndef.NdefRecord.NdefRecord | +( | +TypeNameFormatType | +tnf, | +
+ | + | byte[] | +type | +
+ | ) | ++ |
Create a new record with the specified type name format and type. Doesn't set the payload and ID.
+tnf | Type name format to use, based on the tnf's standardized by the Nfc Forum. |
type | Type string. |
NdefLibrary.Ndef.NdefRecord.NdefRecord | +( | +NdefRecord | +other | ) | ++ |
Create a new record, copying the information of the record sent through the parameter.
+other | Record to copy. |
+
|
+ +virtual | +
Checks if the contents of the record are valid; throws an exception if a problem is found, containing a textual description of the issue.
+NdefException | Thrown if no valid NDEF record can be created based on the record's current contents. The exception message contains further details about the issue. |
Reimplemented in NdefLibrary.Ndef.NdefLaunchAppRecord, NdefLibrary.Ndef.NdefHandoverAlternativeCarrierRecord, NdefLibrary.Ndef.NdefSpRecord, NdefLibrary.Ndef.NdefGeoRecord, NdefLibrary.Ndef.NdefMailtoRecord, NdefLibrary.Ndef.NdefSmsRecord, NdefLibrary.Ndef.NdefNokiaAccessoriesRecord, NdefLibrary.Ndef.NdefTelRecord, and NdefLibrary.Ndef.NdefSocialRecord.
+ +Type NdefLibrary.Ndef.NdefRecord.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.
+checkForSubtypes | If set to true, also checks for subtypes of the URL / SmartPoster record where the library offers a convenient handling class - e.g. for SMS or Mailto records, which are actually URL schemes. |
+
|
+ +protected | +
Byte array storing raw contents of the payload. Use Payload property to access it whenever possible.
+Direct byte array access provided as virtual property can't be accessed from constructor.
+ +
+
|
+ +protected | +
Byte array storing raw contents of the type. Use Type property to access it whenever possible.
+Direct byte array access provided as virtual property can't be accessed from constructor.
+ +
+
|
+ +getset | +
An identifier in the form of a URI reference.
+ +
+
|
+ +getset | +
The application data carried within an NDEF record.
+ +
+
|
+ +getset | +
An identifier describing the type of the payload.
+ +
+
|
+ +getset | +
Indicates the structure of the value of the TYPE field.
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefSmartUriRecord, including all inherited members.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
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...
++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... | |
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.
+NdefLibrary.Ndef.NdefSmartUriRecord.NdefSmartUriRecord | +( | +) | ++ |
Create an empty Smart Uri Record.
+ +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.
+other | Record to copy into this SmartUri record. |
+
|
+ +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.
+ +
+
|
+ +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).
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefSmsRecord, including all inherited members.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
Convenience class for formatting SMS information into an NDEF record, depending on added info either URI or Smart Poster. + More...
++Public Member Functions | |
NdefSmsRecord () | |
Create an empty Sms record. You need to set the number and body to create a URI and make this record valid. More... | |
NdefSmsRecord (NdefRecord other) | |
Create a SMS record based on another SMS record, or Smart Poster / URI record that have a Uri set that corresponds to the sms: URI scheme. 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... | |
Public Member Functions inherited from NdefLibrary.Ndef.NdefSmartUriRecord | |
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... | |
+Static Public Member Functions | |
static new bool | IsRecordType (NdefRecord record) |
Checks if the record sent via the parameter is indeed an Sms record. Checks the type and type name format and if the URI starts with the correct scheme. 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... | |
+Properties | |
string | SmsBody [get, set] |
The body of the SMS message. More... | |
string | SmsNumber [get, set] |
The number the reading phone is supposed to send the short message to. Recommended to store in international format, e.g., +431234... More... | |
Properties inherited from NdefLibrary.Ndef.NdefSmartUriRecord | |
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 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... | |
Convenience class for formatting SMS information into an NDEF record, depending on added info either URI or Smart Poster.
+Tapping a tag with SMS information stored on it should trigger a dialog in the phone to send the proposed SMS. This can for example be used to interact with information services that then reply by sending more info per SMS, or for payment services that send a premium SMS to purchase items or content.
+Add the recipient number and the SMS message body to the class, which takes care of properly encoding the information into the correct URI.
+As this class is based on the Smart URI base class, the payload is formatted as a URI record initially. When first adding Smart Poster information (like a title), the payload instantly transforms into a Smart Poster.
+NdefLibrary.Ndef.NdefSmsRecord.NdefSmsRecord | +( | +) | ++ |
Create an empty Sms record. You need to set the number and body to create a URI and make this record valid.
+ +NdefLibrary.Ndef.NdefSmsRecord.NdefSmsRecord | +( | +NdefRecord | +other | ) | ++ |
Create a SMS record based on another SMS record, or Smart Poster / URI record that have a Uri set that corresponds to the sms: URI scheme.
+other | Other record to copy the data from. |
+
|
+ +virtual | +
Checks if the contents of the record are valid; throws an exception if a problem is found, containing a textual description of the issue.
+NdefException | Thrown if no valid NDEF record can be created based on the record's current contents. The exception message contains further details about the issue. |
Reimplemented from NdefLibrary.Ndef.NdefRecord.
+ +
+
|
+ +static | +
Checks if the record sent via the parameter is indeed an Sms record. Checks the type and type name format and if the URI starts with the correct scheme.
+record | Record to check. |
+
|
+ +getset | +
The body of the SMS message.
+Note: the URI content has to be encoded in UTF-8, which should be done by the URI class. No further transformation is necessary for the SMS use case (e.g., to 7-bit US-ASCII, as would be recommended for Internet URLs). This class will take care of Uri Escaping the body text through System.Uri.EscapeDataString().
+ +
+
|
+ +getset | +
The number the reading phone is supposed to send the short message to. Recommended to store in international format, e.g., +431234...
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefSocialRecord, including all inherited members.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
Link to one of the supported social networks by simply selecting the network and specifying the username. + More...
++Public Types | |
enum | NfcSocialType { + Twitter = 0, +LinkedIn, +Facebook, +Xing, + + VKontakte, +FoursquareWeb, +FoursquareApp, +Skype, + + GooglePlus + + } |
List of social networks this class can be used to generate a link for. More... | |
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... | |
+Public Member Functions | |
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... | |
Public Member Functions inherited from NdefLibrary.Ndef.NdefSmartUriRecord | |
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 | |
string | SocialUserName [get, set] |
Username / id of the social network. More... | |
NfcSocialType | SocialType [get, set] |
Format to use for encoding the social network URL. More... | |
Properties inherited from NdefLibrary.Ndef.NdefSmartUriRecord | |
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 | |
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... | |
Link to one of the supported social networks by simply selecting the network and specifying the username.
+Tapping a tag written with this record type will take the user to the social network web site, where he can then for example start following you on Twitter.
+As this class is based on the Smart URI base class, the payload is formatted as a URI record initially. When first adding Smart Poster information (like a title), the payload instantly transforms into a Smart Poster.
+
+
|
+ +strong | +
List of social networks this class can be used to generate a link for.
+ +
+
|
+ +virtual | +
Checks if the contents of the record are valid; throws an exception if a problem is found, containing a textual description of the issue.
+NdefException | Thrown if no valid NDEF record can be created based on the record's current contents. The exception message contains further details about the issue. |
Reimplemented from NdefLibrary.Ndef.NdefRecord.
+ +
+
|
+ +getset | +
Format to use for encoding the social network URL.
+ +
+
|
+ +getset | +
Username / id of the social network.
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefSpActRecord, including all inherited members.
+_payload | NdefLibrary.Ndef.NdefRecord | protected |
_type | NdefLibrary.Ndef.NdefRecord | protected |
CheckIfValid() | NdefLibrary.Ndef.NdefRecord | virtual |
CheckSpecializedType(bool checkForSubtypes) | NdefLibrary.Ndef.NdefRecord | |
Id | NdefLibrary.Ndef.NdefRecord | |
IsRecordType(NdefRecord record) | NdefLibrary.Ndef.NdefSpActRecord | static |
NdefRecord() | NdefLibrary.Ndef.NdefRecord | |
NdefRecord(TypeNameFormatType tnf, byte[] type) | NdefLibrary.Ndef.NdefRecord | |
NdefRecord(NdefRecord other) | NdefLibrary.Ndef.NdefRecord | |
NdefSpActRecord() | NdefLibrary.Ndef.NdefSpActRecord | |
NdefSpActRecord(NdefRecord other) | NdefLibrary.Ndef.NdefSpActRecord | |
NfcAction | NdefLibrary.Ndef.NdefSpActRecord | |
NfcActionType enum name | NdefLibrary.Ndef.NdefSpActRecord | |
Payload | NdefLibrary.Ndef.NdefRecord | |
Type | NdefLibrary.Ndef.NdefRecord | |
TypeNameFormat | NdefLibrary.Ndef.NdefRecord | |
TypeNameFormatType enum name | NdefLibrary.Ndef.NdefRecord |
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
The Action record is a Local Type specific to the Smart Poster. + More...
++Public Types | |
enum | NfcActionType { NfcActionType.DoAction = 0, +NfcActionType.SaveForLater, +NfcActionType.OpenForEditing, +NfcActionType.Rfu + } |
Type of the action, according to the NFC Forum Smart Poster specification. More... | |
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... | |
+Public Member Functions | |
NdefSpActRecord () | |
Create an empty Action record, to be used within a Smart Poster message. Automatically creates the payload and sets it to the default DoAction. More... | |
NdefSpActRecord (NdefRecord other) | |
Create an action 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 an Action record. More... | |
+Properties | |
NfcActionType | NfcAction [get, set] |
Defines how the device should handle the linked content. DoAction per default. 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 | |
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... | |
The Action record is a Local Type specific to the Smart Poster.
+It suggests a course of action that the device should do with the content. The NFC Local Type Name for the action is "act" (0x61 0x63 0x74). The action record is defined as having a local scope only, and therefore it has meaning only within a Smart Poster record. A lone "act"-record SHALL be considered an error.
+The device MAY ignore this suggestion. The default (i.e., the Action record is missing from the Smart Poster) is not defined. For example, the device might show a list of options to the user.
+(Information taken from NFC Forum Smart Poster NDEF record specifications)
+
+
|
+ +strong | +
Type of the action, according to the NFC Forum Smart Poster specification.
+NdefLibrary.Ndef.NdefSpActRecord.NdefSpActRecord | +( | +) | ++ |
Create an empty Action record, to be used within a Smart Poster message. Automatically creates the payload and sets it to the default DoAction.
+ +NdefLibrary.Ndef.NdefSpActRecord.NdefSpActRecord | +( | +NdefRecord | +other | ) | ++ |
Create an action 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.
+other | Action record to copy into this record. |
+
|
+ +static | +
Checks if the record sent via the parameter is indeed an Action record.
+Only checks the type and type name format, doesn't analyze if the payload is valid.
+record | Record to check. |
+
|
+ +getset | +
Defines how the device should handle the linked content. DoAction per default.
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefSpMimeTypeRecord, including all inherited members.
+_payload | NdefLibrary.Ndef.NdefRecord | protected |
_type | NdefLibrary.Ndef.NdefRecord | protected |
CheckIfValid() | NdefLibrary.Ndef.NdefRecord | virtual |
CheckSpecializedType(bool checkForSubtypes) | NdefLibrary.Ndef.NdefRecord | |
Id | NdefLibrary.Ndef.NdefRecord | |
IsRecordType(NdefRecord record) | NdefLibrary.Ndef.NdefSpMimeTypeRecord | static |
NdefRecord() | NdefLibrary.Ndef.NdefRecord | |
NdefRecord(TypeNameFormatType tnf, byte[] type) | NdefLibrary.Ndef.NdefRecord | |
NdefRecord(NdefRecord other) | NdefLibrary.Ndef.NdefRecord | |
NdefSpMimeTypeRecord() | NdefLibrary.Ndef.NdefSpMimeTypeRecord | |
NdefSpMimeTypeRecord(NdefRecord other) | NdefLibrary.Ndef.NdefSpMimeTypeRecord | |
NfcMimeType | NdefLibrary.Ndef.NdefSpMimeTypeRecord | |
Payload | NdefLibrary.Ndef.NdefRecord | |
Type | NdefLibrary.Ndef.NdefRecord | |
TypeNameFormat | NdefLibrary.Ndef.NdefRecord | |
TypeNameFormatType enum name | NdefLibrary.Ndef.NdefRecord |
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
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...
++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... | |
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)
+NdefLibrary.Ndef.NdefSpMimeTypeRecord.NdefSpMimeTypeRecord | +( | +) | ++ |
Create an empty mime type record, to be used within a Smart Poster message.
+ +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.
+other | Mime type record to copy into this 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.
+record | Record to check. |
+
|
+ +getset | +
MIME type of the linked content.
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefSpRecord, including all inherited members.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
Handles the Smart Poster meta-record and is able to both parse and assemble a smart poster according to the specification. + More...
++Public Member Functions | |
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... | |
+Static Public Member Functions | |
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 | |
static readonly byte[] | SmartPosterType = { (byte)'S', (byte)'p' } |
Type of the NDEF Smart Poster record (well-known, type 'Sp'). More... | |
+Protected Attributes | |
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... | |
+Properties | |
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... | |
Handles the Smart Poster meta-record and is able to both parse and assemble a smart poster according to the specification.
+The class is able to handle the mandatory URI, any number of text records (for storing the Smart Poster title in multiple languages), the action, size, type and image.
+As only the URI is mandatory, various ...InUse() methods can be queried to see if an optional detail was set in the Smart Poster that was read from a tag.
+The action, size and type records used within the Smart Poster are only valid within its context according to the specification. Therefore, classes for those record types are defined within the context of the Smart Poster record class.
+Due to the more complex nature of the Smart Poster record, which consists of multiple records, this class parses the payload contents and creates instances of the various record classes found within the Smart Poster. However, any changes to details are instantly commited to the raw payload as well.
+NdefLibrary.Ndef.NdefSpRecord.NdefSpRecord | +( | +) | ++ |
Create an empty Smart Poster (Sp) record.
+Note that in order to write a Smart Poster to a tag, you have to at least add the URL. An empty Smart Poster record is not valid according to the specs.
+ +NdefLibrary.Ndef.NdefSpRecord.NdefSpRecord | +( | +NdefRecord | +other | ) | ++ |
Create a Smart Poster 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.
+other | Record to copy into this smart poster record. |
NdefException | Thrown if attempting to create a Smart Poster based on an incompatible record type. |
bool NdefLibrary.Ndef.NdefSpRecord.ActionInUse | +( | +) | ++ |
Returns if the action has been defined for this Smart Poster instance.
+ +void NdefLibrary.Ndef.NdefSpRecord.AddTitle | +( | +NdefTextRecord | +newTitle | ) | ++ |
Add an (optional) title to the Smart Poster.
+It is possible to add more than one title as each title text record can have a different language. The phone is then recommended to choose the text record with the language that makes most sense to the user.
+newTitle | (additional) title to be stored in the Smart Poster. |
+
|
+ +virtual | +
Checks if the contents of the record are valid; throws an exception if a problem is found, containing a textual description of the issue.
+NdefException | Thrown if no valid NDEF record can be created based on the record's current contents. The exception message contains further details about the issue. |
Reimplemented from NdefLibrary.Ndef.NdefRecord.
+ +Reimplemented in NdefLibrary.Ndef.NdefTelRecord.
+ +bool NdefLibrary.Ndef.NdefSpRecord.HasSpData | +( | +) | ++ |
Returns true if this record contains data that requires a Smart Poster and could not be stored in a simple URI record.
+bool NdefLibrary.Ndef.NdefSpRecord.ImageInUse | +( | +) | ++ |
Returns if the Smart Poster contains an image (not supported yet).
+ +
+
|
+ +static | +
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.
+record | Record to check. |
bool NdefLibrary.Ndef.NdefSpRecord.MimeTypeInUse | +( | +) | ++ |
Returns if the mime type has been defined for this Smart Poster instance.
+ +void NdefLibrary.Ndef.NdefSpRecord.SetPayloadAndParse | +( | +byte[] | +payload, | +
+ | + | bool | +parseNewPayload | +
+ | ) | ++ |
Sets the payload of the base class to the byte array from the parameter and optionally parses its contents.
+The parsing needs to be done when the Smart Poster is read from a tag. If a detail of an existing Smart Poster class is modified, it will just update its internal payload, but doesn't need to parse it again (as the details are already stored in instances of the various record classes).
+payload | new payload |
parseNewPayload | whether to parse the new payload to update the internal records (url, title, type, etc.). |
void NdefLibrary.Ndef.NdefSpRecord.SetUri | +( | +NdefUriRecord | +newUri | ) | ++ |
Set the URI based on another URI record instead of specifying the URI itself.
+newUri |
bool NdefLibrary.Ndef.NdefSpRecord.SizeInUse | +( | +) | ++ |
Returns if the size has been defined for this Smart Poster instance.
+ +NdefTextRecord NdefLibrary.Ndef.NdefSpRecord.Title | +( | +int | +index | ) | ++ |
Retrieve a specific title text record from the list.
+Returns an empty record in case the index is invalid.
+index | number of the title record to return |
int NdefLibrary.Ndef.NdefSpRecord.TitleCount | +( | +) | ++ |
Returns how many title text records are stored in the Smart Poster.
+ +
+
|
+ +protected | +
URI sub-record of this Smart Poster. Use Uri property to access if possible.
+ +
+
|
+ +static | +
Type of the NDEF Smart Poster record (well-known, type 'Sp').
+ +
+
|
+ +getset | +
The action defines how the reader should handle the Smart Poster record.
+Make sure to check actionInUse() before retrieving the action; if the Smart Poster doesn't have an action defined, itd will return the default NdefNfcSpRecord::DoAction.
+ +
+
|
+ +getset | +
Icon / Image data contained in the Smart Poster.
+A reader device should display the icon prior to acting on the URI record. Note that the Smart Poster standard would allow to use multiple icons. However, as no currently available phones actually show the image contained in the Smart Poster and the standard does not contain an indication as to what would be the use of having multiple images if the device should only show one anyway (and there is no distinction between the images), this class is deliberately limited to only one image record.
+ +
+
|
+ +getset | +
MIME type of the linked object.
+This can be used to tell the mobile device what kind of an object it can expect before it opens the connection.
+ +
+
|
+ +getset | +
Size of the linked content.
+This is useful if the reader device needs to decide in advance whether it has the capability to process the referenced object.
+ +
+
|
+ +get | +
List of all title texts for different languages used in the Smart Poster.
+Can be no title at all, or multiple titles. Each title should have a different language.
+ +
+
|
+ +getset | +
Mandatory URI of the Smart Poster
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefSpSizeRecord, including all inherited members.
+_payload | NdefLibrary.Ndef.NdefRecord | protected |
_type | NdefLibrary.Ndef.NdefRecord | protected |
CheckIfValid() | NdefLibrary.Ndef.NdefRecord | virtual |
CheckSpecializedType(bool checkForSubtypes) | NdefLibrary.Ndef.NdefRecord | |
Id | NdefLibrary.Ndef.NdefRecord | |
IsRecordType(NdefRecord record) | NdefLibrary.Ndef.NdefSpSizeRecord | static |
NdefRecord() | NdefLibrary.Ndef.NdefRecord | |
NdefRecord(TypeNameFormatType tnf, byte[] type) | NdefLibrary.Ndef.NdefRecord | |
NdefRecord(NdefRecord other) | NdefLibrary.Ndef.NdefRecord | |
NdefSpSizeRecord() | NdefLibrary.Ndef.NdefSpSizeRecord | |
NdefSpSizeRecord(NdefRecord other) | NdefLibrary.Ndef.NdefSpSizeRecord | |
NfcSize | NdefLibrary.Ndef.NdefSpSizeRecord | |
Payload | NdefLibrary.Ndef.NdefRecord | |
Type | NdefLibrary.Ndef.NdefRecord | |
TypeNameFormat | NdefLibrary.Ndef.NdefRecord | |
TypeNameFormatType enum name | NdefLibrary.Ndef.NdefRecord |
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
The Size Record contains a four-byte, 32-bit, unsigned integer, which contains the size of object that the URI field refers to. + More...
++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... | |
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)
+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.
+ +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.
+other | Size record to copy into this 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.
+record | Record to check. |
+
|
+ +getset | +
Size of the linked content.
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefTelRecord, including all inherited members.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
Convenience class for formatting telephone call information into an NDEF record, depending on added info either URI or Smart Poster. + More...
++Public Member Functions | |
NdefTelRecord () | |
Create an empty telephone record. You need to set the number to create a URI and make this record valid. More... | |
NdefTelRecord (NdefRecord other) | |
Create a telephone record based on another telephone record, or Smart Poster / URI record that have a Uri set that corresponds to the tel: URI scheme. 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... | |
Public Member Functions inherited from NdefLibrary.Ndef.NdefSmartUriRecord | |
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... | |
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... | |
+Static Public Member Functions | |
static new bool | IsRecordType (NdefRecord record) |
Checks if the record sent via the parameter is indeed a Telephone record. Checks the type and type name format and if the URI starts with the correct scheme. 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... | |
+Properties | |
string | TelNumber [get, set] |
The number the reading phone is supposed to call. Recommended to store in international format, e.g., +431234... More... | |
Properties inherited from NdefLibrary.Ndef.NdefSmartUriRecord | |
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 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... | |
Convenience class for formatting telephone call information into an NDEF record, depending on added info either URI or Smart Poster.
+Tapping a tag with telephone information stored on it should trigger a dialog in the phone to call the specified number. This can for example be used to get in touch with customer service or support, or to book a hotel.
+To create and write the record, specify the target phone number (in international format). This class will take care of properly encoding the information.
+As this class is based on the Smart URI base class, the payload is formatted as a URI record initially. When first adding Smart Poster information (like a title), the payload instantly transforms into a Smart Poster.
+NdefLibrary.Ndef.NdefTelRecord.NdefTelRecord | +( | +) | ++ |
Create an empty telephone record. You need to set the number to create a URI and make this record valid.
+ +NdefLibrary.Ndef.NdefTelRecord.NdefTelRecord | +( | +NdefRecord | +other | ) | ++ |
Create a telephone record based on another telephone record, or Smart Poster / URI record that have a Uri set that corresponds to the tel: URI scheme.
+other | Other record to copy the data from. |
+
|
+ +virtual | +
Checks if the contents of the record are valid; throws an exception if a problem is found, containing a textual description of the issue.
+NdefException | Thrown if no valid NDEF record can be created based on the record's current contents. The exception message contains further details about the issue. |
Reimplemented from NdefLibrary.Ndef.NdefSpRecord.
+ +
+
|
+ +static | +
Checks if the record sent via the parameter is indeed a Telephone record. Checks the type and type name format and if the URI starts with the correct scheme.
+record | Record to check. |
+
|
+ +getset | +
The number the reading phone is supposed to call. Recommended to store in international format, e.g., +431234...
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefTextRecord, including all inherited members.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
The Text record as specified by the NFC Forum URI record type definition. + More...
++Public Types | |
enum | TextEncodingType { Utf8, +Utf16 + } |
Text encoding to use - either Utf8 or Utf16 (big endian) More... | |
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... | |
+Public Member Functions | |
NdefTextRecord () | |
Create an empty Text record. More... | |
NdefTextRecord (NdefRecord other) | |
Create a Text 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 Text record. Only checks the type and type name format, doesn't analyze if the payload is valid. More... | |
+Static Public Attributes | |
static readonly byte[] | TextType = { (byte)'T' } |
Type of the NDEF Text record (well-known, type 'T'). More... | |
+Properties | |
string | LanguageCode [get, set] |
Language code that corresponds to the text. All language codes MUST be done according to RFC 3066 [RFC3066]. The language code MAY NOT be omitted. More... | |
string | Text [get, set] |
The text stored in the text record as a string. More... | |
TextEncodingType | TextEncoding [get, set] |
The encoding of the text - can be either Utf8 or Utf16. 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 | |
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... | |
The Text record as specified by the NFC Forum URI record type definition.
+Stores an arbritary string. Multiple text records can be part of a message, each of those should have a different language so that the reading device can choose the most appropriate language. Text can be encoded either in Utf-8 or Utf-16.
+The text record is usually used within a Smart Poster record or other meta records, where the text contained here describes the properties of the other record, in order to for example guide the user.
+
+
|
+ +strong | +
Text encoding to use - either Utf8 or Utf16 (big endian)
+ +NdefLibrary.Ndef.NdefTextRecord.NdefTextRecord | +( | +) | ++ |
Create an empty Text record.
+ +NdefLibrary.Ndef.NdefTextRecord.NdefTextRecord | +( | +NdefRecord | +other | ) | ++ |
Create a Text 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 Text record as well.
+other | Record to copy into this Text record. |
NdefException | Thrown if attempting to create a Text record based on an incompatible record type. |
+
|
+ +static | +
Checks if the record sent via the parameter is indeed a Text record. Only checks the type and type name format, doesn't analyze if the payload is valid.
+record | Record to check. |
+
|
+ +static | +
Type of the NDEF Text record (well-known, type 'T').
+ +
+
|
+ +getset | +
Language code that corresponds to the text. All language codes MUST be done according to RFC 3066 [RFC3066]. The language code MAY NOT be omitted.
+ +
+
|
+ +getset | +
The text stored in the text record as a string.
+ +
+
|
+ +getset | +
The encoding of the text - can be either Utf8 or Utf16.
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefUriRecord, including all inherited members.
+_payload | NdefLibrary.Ndef.NdefRecord | protected |
_type | NdefLibrary.Ndef.NdefRecord | protected |
CheckIfValid() | NdefLibrary.Ndef.NdefRecord | virtual |
CheckSpecializedType(bool checkForSubtypes) | NdefLibrary.Ndef.NdefRecord | |
Id | NdefLibrary.Ndef.NdefRecord | |
IsRecordType(NdefRecord record) | NdefLibrary.Ndef.NdefUriRecord | static |
NdefRecord() | NdefLibrary.Ndef.NdefRecord | |
NdefRecord(TypeNameFormatType tnf, byte[] type) | NdefLibrary.Ndef.NdefRecord | |
NdefRecord(NdefRecord other) | NdefLibrary.Ndef.NdefRecord | |
NdefUriRecord() | NdefLibrary.Ndef.NdefUriRecord | |
NdefUriRecord(NdefRecord other) | NdefLibrary.Ndef.NdefUriRecord | |
Payload | NdefLibrary.Ndef.NdefRecord | |
RawUri | NdefLibrary.Ndef.NdefUriRecord | |
Type | NdefLibrary.Ndef.NdefRecord | |
TypeNameFormat | NdefLibrary.Ndef.NdefRecord | |
TypeNameFormatType enum name | NdefLibrary.Ndef.NdefRecord | |
Uri | NdefLibrary.Ndef.NdefUriRecord | |
UriType | NdefLibrary.Ndef.NdefUriRecord | static |
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
The URI record as specified by the NFC Forum URI record type definition. + More...
++Public Member Functions | |
NdefUriRecord () | |
Create an empty URI record. More... | |
NdefUriRecord (NdefRecord other) | |
Create a URI 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 URI record. Only checks the type and type name format, doesn't analyze if the payload is valid. More... | |
+Static Public Attributes | |
static readonly byte[] | UriType = { (byte)'U' } |
Type of the NDEF Text record (well-known, type 'U'). More... | |
+Properties | |
byte[] | RawUri [get, set] |
Get the raw URI as stored in this record, excluding any abbreviations. More... | |
string | Uri [get, set] |
URI stored in this record. The abbreviation will be handled behind the scenes - getting and setting this property will always work on the full URI. 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... | |
The URI record as specified by the NFC Forum URI record type definition.
+The record stores a URI and can be stored on a tag or sent to another device. Several of the most common URI headers are automatically abbreviated in order to keep the record as small as possible. URIs will be encoded using UTF-8.
+This record can either be used stand alone, or as part of another record like the Smart Poster (NdefSpRecord).
+NdefLibrary.Ndef.NdefUriRecord.NdefUriRecord | +( | +) | ++ |
Create an empty URI record.
+ +NdefLibrary.Ndef.NdefUriRecord.NdefUriRecord | +( | +NdefRecord | +other | ) | ++ |
Create a URI 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 URI record as well.
+other | Uri record to copy into this record. |
NdefException | Thrown if attempting to create a Uri record based on an incompatible record type. |
+
|
+ +static | +
Checks if the record sent via the parameter is indeed a URI record. Only checks the type and type name format, doesn't analyze if the payload is valid.
+record | Record to check. |
+
|
+ +static | +
Type of the NDEF Text record (well-known, type 'U').
+ +
+
|
+ +getset | +
Get the raw URI as stored in this record, excluding any abbreviations.
+Gets the raw contents of the URI, exclusive the first byte of the record's payload that would contain the abbreviation code. If the URI has been abbreviated, this method returns retuns the actual URI text as stored on the tag. To get the full URI that has been expanded with the abbreviated URI scheme, use the normal Uri accessor.
+ +
+
|
+ +getset | +
URI stored in this record. The abbreviation will be handled behind the scenes - getting and setting this property will always work on the full URI.
+Note that this property / class does not escape the URI data string to avoid double-escaping and to allow storing unescaped URIs if allowed by the protocol. For generic URLs, it's recommended to escape the URL string when sending it to this class, e.g., with System.Uri.EscapeUriString().
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefVcardRecordBase, including all inherited members.
+_payload | NdefLibrary.Ndef.NdefRecord | protected |
_type | NdefLibrary.Ndef.NdefRecord | protected |
CheckIfValid() | NdefLibrary.Ndef.NdefRecord | virtual |
CheckSpecializedType(bool checkForSubtypes) | NdefLibrary.Ndef.NdefRecord | |
Id | NdefLibrary.Ndef.NdefRecord | |
IsRecordType(NdefRecord record) | NdefLibrary.Ndef.NdefVcardRecordBase | static |
NdefRecord() | NdefLibrary.Ndef.NdefRecord | |
NdefRecord(TypeNameFormatType tnf, byte[] type) | NdefLibrary.Ndef.NdefRecord | |
NdefRecord(NdefRecord other) | NdefLibrary.Ndef.NdefRecord | |
NdefVcardRecordBase() | NdefLibrary.Ndef.NdefVcardRecordBase | |
NdefVcardRecordBase(NdefRecord other) | NdefLibrary.Ndef.NdefVcardRecordBase | |
Payload | NdefLibrary.Ndef.NdefRecord | |
Type | NdefLibrary.Ndef.NdefRecord | |
TypeNameFormat | NdefLibrary.Ndef.NdefRecord | |
TypeNameFormatType enum name | NdefLibrary.Ndef.NdefRecord | |
VcardType | NdefLibrary.Ndef.NdefVcardRecordBase | static |
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
Stores a business card (vCard) in a MIME type record, allowing users to immediately add a contact to their address book. + More...
++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... | |
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.
+NdefLibrary.Ndef.NdefVcardRecordBase.NdefVcardRecordBase | +( | +) | ++ |
Create an empty MIME/vCard Record.
+ +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.
+other | Record to copy into this vCard record. |
NdefException | Thrown if attempting to create a vCard record based on an incompatible record type. |
+
|
+ +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.
+record | Record to check. |
+
|
+ +static | +
Type of the NDEF MIME / vCard record.
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefWindowsSettingsRecord, including all inherited members.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
Convenience class for formatting URI records that launch specific setting pages on Windows 10. + More...
++Public Types | |
enum | NfcSettingsApp { + SettingsHome, +SystemDisplay, +SystemNotifications, +SystemPhone, + + SystemMessaging, +SystemBatterySaver, +SystemBatterySaverSettings, +SystemBatteryUse, + + SystemPower, +SystemEncryption, +SystemOfflineMaps, +SystemAbout, + + DevicesCamera, +DevicesBluetooth, +DevicesMouseTouchpad, +DevicesNfc, + + NetworkWifi, +NetworkAirplaneMode, +NetworkDataUsage, +NetworkCellularSim, + + NetworkMobileHotspot, +NetworkProxy, +Personalization, +PersonalizationBackground, + + PersonalizationColors, +PersonalizationSounds, +PersonalizationLockScreen, +AccountsEmail, + + AccountsWorkAccess, +AccountsSync, +TimeLanguageDateTime, +TimeLanguageRegion, + + EaseOfAccessNarrator, +EaseOfAccessMagnifier, +EaseOfAccessHighContrast, +EaseOfAccessClosedCaptions, + + EaseOfAccessKeyboard, +EaseOfAccessMouse, +EaseOfAccessOther, +PrivacyLocation, + + PrivacyCamera, +PrivacyMicrophone, +PrivacyMotion, +PrivacySpeechInkingTyping, + + PrivacyAccountInfo, +PrivacyContacts, +PrivacyCalendar, +PrivacyCallHistory, + + PrivacyEmail, +PrivacyMessaging, +PrivacyRadios, +PrivacyBackgroundApps, + + PrivacyOtherDevices, +PrivacyFeedback, +UpdateSecurityDeveopers + + } |
The different setting schemes for launching setting app pages on Windows Phone, as defined by Microsoft. More... | |
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... | |
+Public Member Functions | |
NdefWindowsSettingsRecord () | |
Create an empty Windows Settings record. More... | |
NdefWindowsSettingsRecord (NdefRecord other) | |
Create a Windows settings record based on another Windows settings record, or a URI record that has a Uri that corresponds to one of the allowed URI schemes for this record. More... | |
Public Member Functions inherited from NdefLibrary.Ndef.NdefUriRecord | |
NdefUriRecord () | |
Create an empty URI record. More... | |
NdefUriRecord (NdefRecord other) | |
Create a URI 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 new bool | IsRecordType (NdefRecord record) |
Checks if the record sent via the parameter is indeed a Windows Settings record. More... | |
Static Public Member Functions inherited from NdefLibrary.Ndef.NdefUriRecord | |
static bool | IsRecordType (NdefRecord record) |
Checks if the record sent via the parameter is indeed a URI record. Only checks the type and type name format, doesn't analyze if the payload is valid. More... | |
+Properties | |
NfcSettingsApp | SettingsApp [get, set] |
Use this property to get/set which settings page is launched through the record. More... | |
Properties inherited from NdefLibrary.Ndef.NdefUriRecord | |
byte[] | RawUri [get, set] |
Get the raw URI as stored in this record, excluding any abbreviations. More... | |
string | Uri [get, set] |
URI stored in this record. The abbreviation will be handled behind the scenes - getting and setting this property will always work on the full URI. 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 | |
Static Public Attributes inherited from NdefLibrary.Ndef.NdefUriRecord | |
static readonly byte[] | UriType = { (byte)'U' } |
Type of the NDEF Text record (well-known, type 'U'). 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... | |
Convenience class for formatting URI records that launch specific setting pages on Windows 10.
+Tapping a tag with one of the custom URI schemes defined in this record will cause a Windows10 application to launch the settings app on the specified page, e.g., to adjust the Bluetooth settings or to activate flight mode.
+Unfortunately, this URI scheme does not allow to actually change the system settings; you can only show the required page to the user so that he can apply the changes manually. This serves as a shortcut, if you for example need the user to activate Bluetooth. Due to the security model on Windows Phone 8, no app or tag could modify system settings; the user always has to do that. You can only make his life easier by redirecting him to the specific settings page.
+This URI scheme is specific to Windows 10 devices and will only work on such devices. More information: https://msdn.microsoft.com/en-us/library/windows/apps/mt228342.aspx
+
+
|
+ +strong | +
The different setting schemes for launching setting app pages on Windows Phone, as defined by Microsoft.
+ +NdefLibrary.Ndef.NdefWindowsSettingsRecord.NdefWindowsSettingsRecord | +( | +) | ++ |
Create an empty Windows Settings record.
+ +NdefLibrary.Ndef.NdefWindowsSettingsRecord.NdefWindowsSettingsRecord | +( | +NdefRecord | +other | ) | ++ |
Create a Windows settings record based on another Windows settings record, or a URI record that has a Uri that corresponds to one of the allowed URI schemes for this record.
+other | Other record to copy the data from. |
+
|
+ +static | +
Checks if the record sent via the parameter is indeed a Windows Settings record.
+record | Record to check. |
+
|
+ +getset | +
Use this property to get/set which settings page is launched through the record.
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibrary.Ndef.NdefWpSettingsRecord, including all inherited members.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
Convenience class for formatting URI records that launch specific setting pages on Windows Phone 8. Please use the NdefWindowsSettingsRecord for Windows 10 and Windows 10 Mobile. + More...
++Public Types | |
enum | NfcSettingsApp { + AirplaneMode, +Battery, +Bluetooth, +Camera, + + Cellular, +EmailAndAccounts, +Location, +Lock, + + Notifications, +Power, +Proximity, +ScreenRotation, + + Wallet, +Wifi, +Workplace, +NetworkProfileUpdate, + + NfcTransactions, +UiccToolkit + + } |
The different setting schemes for launching setting app pages on Windows Phone, as defined by Microsoft. More... | |
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... | |
+Public Member Functions | |
NdefWpSettingsRecord () | |
Create an empty WP8 Settings record. More... | |
NdefWpSettingsRecord (NdefRecord other) | |
Create a WP8 settings record based on another WP8 settings record, or a URI record that has a Uri that corresponds to one of the allowed URI schemes for this record. More... | |
Public Member Functions inherited from NdefLibrary.Ndef.NdefUriRecord | |
NdefUriRecord () | |
Create an empty URI record. More... | |
NdefUriRecord (NdefRecord other) | |
Create a URI 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 new bool | IsRecordType (NdefRecord record) |
Checks if the record sent via the parameter is indeed a Windows Phone Settings record. More... | |
Static Public Member Functions inherited from NdefLibrary.Ndef.NdefUriRecord | |
static bool | IsRecordType (NdefRecord record) |
Checks if the record sent via the parameter is indeed a URI record. Only checks the type and type name format, doesn't analyze if the payload is valid. More... | |
+Properties | |
NfcSettingsApp | SettingsApp [get, set] |
Use this property to get/set which settings page is launched through the record. More... | |
Properties inherited from NdefLibrary.Ndef.NdefUriRecord | |
byte[] | RawUri [get, set] |
Get the raw URI as stored in this record, excluding any abbreviations. More... | |
string | Uri [get, set] |
URI stored in this record. The abbreviation will be handled behind the scenes - getting and setting this property will always work on the full URI. 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 | |
Static Public Attributes inherited from NdefLibrary.Ndef.NdefUriRecord | |
static readonly byte[] | UriType = { (byte)'U' } |
Type of the NDEF Text record (well-known, type 'U'). 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... | |
Convenience class for formatting URI records that launch specific setting pages on Windows Phone 8. Please use the NdefWindowsSettingsRecord for Windows 10 and Windows 10 Mobile.
+Tapping a tag with one of the custom URI schemes defined in this record will cause a Windows Phone 8 application to launch the settings app on the specified page, e.g., to adjust the Bluetooth settings or to activate flight mode.
+Unfortunately, this URI scheme does not allow to actually change the system settings; you can only show the required page to the user so that he can apply the changes manually. This serves as a shortcut, if you for example need the user to activate Bluetooth. Due to the security model on Windows Phone 8, no app or tag could modify system settings; the user always has to do that. You can only make his life easier by redirecting him to the specific settings page.
+This URI scheme is specific to Windows Phone 8 devices and will only work on such phones. More information: http://msdn.microsoft.com/en-us/library/windowsphone/develop/jj662937%28v=vs.105%29.aspx
+
+
|
+ +strong | +
The different setting schemes for launching setting app pages on Windows Phone, as defined by Microsoft.
+ +NdefLibrary.Ndef.NdefWpSettingsRecord.NdefWpSettingsRecord | +( | +) | ++ |
Create an empty WP8 Settings record.
+ +NdefLibrary.Ndef.NdefWpSettingsRecord.NdefWpSettingsRecord | +( | +NdefRecord | +other | ) | ++ |
Create a WP8 settings record based on another WP8 settings record, or a URI record that has a Uri that corresponds to one of the allowed URI schemes for this record.
+other | Other record to copy the data from. |
+
|
+ +static | +
Checks if the record sent via the parameter is indeed a Windows Phone Settings record.
+record | Record to check. |
+
|
+ +getset | +
Use this property to get/set which settings page is launched through the record.
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibraryUwp.Ndef.NdefMimeImageRecord, including all inherited members.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
Extended MIME / Image record for the WinRT APIs that integrates with the platform's image handling to support convenient conversion to and from various formats (WriteableBitmap, PNG, JPEG, etc.) + More...
++Public Member Functions | |
NdefMimeImageRecord (NdefRecord other) | |
Create a MIME / Image record based on the record passed through the argument. More... | |
async Task | SetImage (WriteableBitmap bmp, ImageMimeType mimeType, double dpi=96.0) |
Set an image to this class by specifying the WritableBitmap and the target encoding and optionally the DPI to set for the target file (if supported by the target file type). More... | |
async Task | LoadFile (StorageFile file) |
Set an image to this class by specifying an input file that has to be one of the supported MIME types (e.g., a JPEG or PNG file). More... | |
async Task | LoadStream (IRandomAccessStream imgStream) |
Set an image to this class by specifying an input stream that contains image data in one of the supported MIME types (e.g., JPEG or PNG file contents). More... | |
async Task | DetermineMimeTypeFromPayload () |
Utility method to determine & update the MIME type of the record according to the current payload. More... | |
async Task< WriteableBitmap > | GetImageAsBitmap () |
Retrieve the image stored in this class as a WriteableBitmap. Automatically decodes the image. More... | |
Public Member Functions inherited from NdefLibrary.Ndef.NdefMimeImageRecordBase | |
NdefMimeImageRecordBase (NdefRecord other) | |
Create a MIME / Image 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 async Task< NdefMimeImageRecord > | CreateFromBitmap (WriteableBitmap bmp, ImageMimeType mimeType, double dpi=96.0) |
Construct a new MIME / Image record based on a WriteableBitmap. Specify the MIME type and DPI, and the image data is encoded accordingly. More... | |
static async Task< NdefMimeImageRecord > | CreateFromFile (StorageFile file) |
Construct a new MIME / Image record based on a file. More... | |
static async Task< NdefMimeImageRecord > | CreateFromStream (IRandomAccessStream imgStream) |
Construct a new MIME / Image record based on a stream. More... | |
static Guid | GetBitmapEncoderIdForMimeType (ImageMimeType mimeType) |
Utility method to convert the MIME type enumeration used by this class to the platform's Bitmap Encoder GUID. More... | |
static ImageMimeType | GetMimeTypeForBitmapDecoderId (Guid codecId) |
Utility method to convert the platform's Bitmap Decoder codec ID / GUID to the MIME type enumeration used by this class. More... | |
Static Public Member Functions inherited from NdefLibrary.Ndef.NdefMimeImageRecordBase | |
static bool | IsRecordType (NdefRecord record) |
Checks if the record sent via the parameter is indeed a MIME / Image record. Only checks the type and type name format, doesn't analyze if the payload is valid. More... | |
+Additional Inherited Members | |
Public Types inherited from NdefLibrary.Ndef.NdefMimeImageRecordBase | |
enum | ImageMimeType { + Png, +Jpg, +Jpeg, +JpegXr, + + Bmp, +Gif, +Tiff + + } |
Common Image MIME type definitions, to be used when accessing the ImageMimeTypes dictionary to retrieve the correct MIME type string for the NDEF record. More... | |
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 Attributes inherited from NdefLibrary.Ndef.NdefMimeImageRecordBase | |
static readonly Dictionary< ImageMimeType, byte[]> | ImageMimeTypes |
Dictionary containing the most common MIME type definitions for various image formats. More... | |
Protected Member Functions inherited from NdefLibrary.Ndef.NdefMimeImageRecordBase | |
NdefMimeImageRecordBase () | |
Create an empty MIME / Image Record with the type of PNG. 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... | |
Extended MIME / Image record for the WinRT APIs that integrates with the platform's image handling to support convenient conversion to and from various formats (WriteableBitmap, PNG, JPEG, etc.)
+If you are working on a platform that supports the WinRT APIs and you need to interact with the image data, you can use this derived class instead of the base class.
+It adds several convenient methods to directly construct this record from a WriteableBitmap, from a stream containing image data or from a file. If loading from a stream / file, the class will automatically determine the correct MIME type and set it to the record.
+When loading & parsing an existing record, just construct this class based on a generic NdefRecord. You can then use convenient getter methods to retrieve a WriteableBitmap from the image data payload, no matter which encoding the image data is actually using.
+NdefLibraryUwp.Ndef.NdefMimeImageRecord.NdefMimeImageRecord | +( | +NdefRecord | +other | ) | ++ |
Create a MIME / Image record based on the record passed through the argument.
+The original record has to be a MIME / Image Record as well.
+other | Record to copy into this Image record. |
NdefException | Thrown if attempting to create an Image record based on an incompatible record type. |
+
|
+ +static | +
Construct a new MIME / Image record based on a WriteableBitmap. Specify the MIME type and DPI, and the image data is encoded accordingly.
+bmp | Source bitmap to use for conversion. |
mimeType | MIME type to specify the target image encoding. |
dpi | Optional parameter to set the DPI of the encoded image (if supported by the specific MIME type). |
+
|
+ +static | +
Construct a new MIME / Image record based on a file.
+file | Reference to a file that will be opened and parsed by this class, to load its contents into the Payload of this record and set the MIME type correctly depending on the file contents. |
+
|
+ +static | +
Construct a new MIME / Image record based on a stream.
+imgStream | Reference to a stream containing image data (encoded for example as a PNG or JPEG). The stream will be parsed by this class, to load its contents into the Payload of this record and set the MIME type correctly depending on the stream contents. |
async Task NdefLibraryUwp.Ndef.NdefMimeImageRecord.DetermineMimeTypeFromPayload | +( | +) | ++ |
Utility method to determine & update the MIME type of the record according to the current payload.
+Mostly for internal use, but can also be used externally if you set the Payload directly and want the class to adapt its MIME type based on the new Payload contents.
+
+
|
+ +static | +
Utility method to convert the MIME type enumeration used by this class to the platform's Bitmap Encoder GUID.
+mimeType | MIME type to convert. |
async Task<WriteableBitmap> NdefLibraryUwp.Ndef.NdefMimeImageRecord.GetImageAsBitmap | +( | +) | ++ |
Retrieve the image stored in this class as a WriteableBitmap. Automatically decodes the image.
+Run this method from the UI thread, as it needs to create a WriteableBitmap. If you need to access the encoded image data (e.g., if it contains JPEG or PNG data), use the Payload property directly.
+
+
|
+ +static | +
Utility method to convert the platform's Bitmap Decoder codec ID / GUID to the MIME type enumeration used by this class.
+codecId | Bitmap decoder codec ID / GUID. |
async Task NdefLibraryUwp.Ndef.NdefMimeImageRecord.LoadFile | +( | +StorageFile | +file | ) | ++ |
Set an image to this class by specifying an input file that has to be one of the supported MIME types (e.g., a JPEG or PNG file).
+Specify the reference to a file that is one of the supported MIME types - e.g., a JPEG or PNG image. The file contents are set as the payload of this record. This method will try to find out the MIME type of the referenced file automatically and adapt the type of the NDEF record accordingly.
+async Task NdefLibraryUwp.Ndef.NdefMimeImageRecord.LoadStream | +( | +IRandomAccessStream | +imgStream | ) | ++ |
Set an image to this class by specifying an input stream that contains image data in one of the supported MIME types (e.g., JPEG or PNG file contents).
+The stream has to contain one of the supported MIME types - e.g., a JPEG or PNG image. The stream contents are set as the payload of this record. This method will try to find out the MIME type of the referenced stream contents automatically and adapt the type of the NDEF record accordingly.
+async Task NdefLibraryUwp.Ndef.NdefMimeImageRecord.SetImage | +( | +WriteableBitmap | +bmp, | +
+ | + | ImageMimeType | +mimeType, | +
+ | + | double | +dpi = 96.0 |
+
+ | ) | ++ |
Set an image to this class by specifying the WritableBitmap and the target encoding and optionally the DPI to set for the target file (if supported by the target file type).
+The method takes the bitmap as input and uses the BitmapEncoder to encode the image data into the specified MIME type and file format. The encoded contents are then stored to the payload of the record, the MIME type is set as the type of the record.
+bmp | Input bitmap to encode and set as payload of this record. |
mimeType | MIME type to use for encoding this image. |
dpi | Target DPI if supported by the target file / MIME format. |
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibraryUwp.Ndef.NdefVcardRecord, including all inherited members.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
Work with contact / vCard / vcf information in an NDEF record, and convert the WinRT Contact storage to / from a valid vCard representation. + More...
++Public Member Functions | |
NdefVcardRecord () | |
Construct an emtpy vCard record with no contact set. More... | |
NdefVcardRecord (NdefRecord other) | |
Creates a new instance of an NdefVcardRecord and imports the payload into the ContactData instance. More... | |
NdefVcardRecord (Contact contact) | |
Construct a new vCard record based on the WinRT contact instance, which is automatically converted to a vCard for the payload of this record. More... | |
NdefVcardRecord (string vCardString) | |
Create a new vCard record based on the string that contains valid vCard information. Automatically parses the vCard data and populates fields in the WinRT Contact instance accessible through ContactData. More... | |
NdefVcardRecord (byte[] vCardByte) | |
Create a new vCard record based on the byte array that contains valid vCard information. Automatically parses the vCard data and populates fields in the WinRT Contact instance accessible through ContactData. More... | |
vCard | ConvertContactToVCard (Contact contact) |
Map the Windows 8 Contact class to a vCard object from the vCard library. This mapping is not 1:1, as Contact has differnet properties than supported in the vCard standard. The method maps / converts as much information as possible. More... | |
Public Member Functions inherited from NdefLibrary.Ndef.NdefVcardRecordBase | |
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... | |
+Properties | |
Contact | ContactData [get, set] |
Contact from WinRT that is represented as a vCard by this class. 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.NdefVcardRecordBase | |
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 inherited from NdefLibrary.Ndef.NdefVcardRecordBase | |
static readonly byte[] | VcardType = Encoding.UTF8.GetBytes("text/x-vCard") |
Type of the NDEF MIME / vCard record. 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... | |
Work with contact / vCard / vcf information in an NDEF record, and convert the WinRT Contact storage to / from a valid vCard representation.
+WinRT is using the Contact class to store contact information for use in its address book. However, this class does not include conversion to and from the vCard standard that can be used to store the contact information in files (.vcf) or to include it as a payload for a contact NDEF record.
+Furthermore, the Contact class does not actually match the vCard standard from its supported features and information details.
+Therefore, this class depends on an external vCard library that is used so that the NFC library can convert between the WinRT Contact class and the vCard library that can generate and parse vcf contents.
+As that matching is not 1:1, some details might not be represented accurately after the conversion or might even get lost. But the class tries to retain as much information as possible and maps data between the WinRT Contact class and the vCard standard with care.
+You can either create a class instance from a WinRT Contact, or from a vCard string / UTF-8 encoded byte array. The class will handle automatic conversion between the two formats upon construction.
+NdefLibraryUwp.Ndef.NdefVcardRecord.NdefVcardRecord | +( | +) | ++ |
Construct an emtpy vCard record with no contact set.
+ +NdefLibraryUwp.Ndef.NdefVcardRecord.NdefVcardRecord | +( | +NdefRecord | +other | ) | ++ |
Creates a new instance of an NdefVcardRecord and imports the payload into the ContactData instance.
+other | An NDEF record that contains valid vCard data as its payload and has the right type information. |
NdefLibraryUwp.Ndef.NdefVcardRecord.NdefVcardRecord | +( | +Contact | +contact | ) | ++ |
Construct a new vCard record based on the WinRT contact instance, which is automatically converted to a vCard for the payload of this record.
+contact | Contact instance that should be converted to a vCard for this payload's record. |
NdefLibraryUwp.Ndef.NdefVcardRecord.NdefVcardRecord | +( | +string | +vCardString | ) | ++ |
Create a new vCard record based on the string that contains valid vCard information. Automatically parses the vCard data and populates fields in the WinRT Contact instance accessible through ContactData.
+vCardString | String that contains vCard data. |
NdefLibraryUwp.Ndef.NdefVcardRecord.NdefVcardRecord | +( | +byte[] | +vCardByte | ) | ++ |
Create a new vCard record based on the byte array that contains valid vCard information. Automatically parses the vCard data and populates fields in the WinRT Contact instance accessible through ContactData.
+vCardByte | Byte array that contains vCard data. |
vCard NdefLibraryUwp.Ndef.NdefVcardRecord.ConvertContactToVCard | +( | +Contact | +contact | ) | ++ |
Map the Windows 8 Contact class to a vCard object from the vCard library. This mapping is not 1:1, as Contact has differnet properties than supported in the vCard standard. The method maps / converts as much information as possible.
+contact | Source contact to convert to a vCard object. |
+
|
+ +getset | +
Contact from WinRT that is represented as a vCard by this class.
+If you make any changes to this class instance, call
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibraryWin.Ndef.NdefIcalendarRecord, including all inherited members.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
A platform-specific class for Windows 8.1 that is able to convert the Windows Appointment class into a valid iCalendar structure and back again. + More...
++Public Member Functions | |
NdefIcalendarRecord (Appointment ap) | |
Create a new iCalendar record based on the supplied appointment. The appointment will be automatically converted to a vCard for the payload of the record, using a matching algorithm to transform the data from the Windows Appointment class to the vCard standard. More... | |
NdefIcalendarRecord (byte[] iCalendarPayload) | |
Parses the supplied iCalendar compatible payload (UTF8 encoded string) and converts it into the Windows 8 Appointment class by matching the properties. Afterwards, the method sets the payload of the record by converting the Appointment class back to an iCalendar file, to maintain consistency between the stored AppointmentData and the ics data in the payload. More... | |
+ | NdefIcalendarRecord (NdefRecord other) |
Public Member Functions inherited from NdefLibrary.Ndef.NdefIcalendarRecordBase | |
NdefIcalendarRecordBase () | |
Create an empty MIME/iCal Record. 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... | |
+Properties | |
+Appointment | AppointmentData [get, set] |
string | ProductId [get, set] |
The product ID is mandatory for an ics file according to the specification. If you do not set this from your app, a default product ID will be used. See the official iCalendar specification for further details. http://www.ietf.org/rfc/rfc2445.txt 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.NdefIcalendarRecordBase | |
static bool | IsRecordType (NdefRecord record) |
Checks if the record sent via the parameter is indeed a MIME/iCal record. Only checks the type and type name format, doesn't analyze if the payload is valid. More... | |
Static Public Attributes inherited from NdefLibrary.Ndef.NdefIcalendarRecordBase | |
static readonly byte[] | IcalType = Encoding.UTF8.GetBytes("text/calendar") |
Type of the NDEF MIME / iCal record. More... | |
Protected Member Functions inherited from NdefLibrary.Ndef.NdefIcalendarRecordBase | |
NdefIcalendarRecordBase (NdefRecord other) | |
Create a MIME/iCal record based on the record passed through the argument. 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... | |
A platform-specific class for Windows 8.1 that is able to convert the Windows Appointment class into a valid iCalendar structure and back again.
+Warning: Alpha Status! Interfaces and functionality of this class might still change.
+The iCalendar file can then be stored on an NFC tag or sent to another device in order to immediately create the appointment in the user's calendar.
+As the Windows Appointment class and the iCalendar standards to not directly match in all properties, this class will do the conversion and transform from one type to the other, aiming to keep as much information as possible.
+As such - especially for the intended usecase and as plain text iCalendar data gets quite large - the class only supports a single appointment and not an iCalendar file that contains complete calendar information formed from multiple individual events.
+The NDEF record has a specific MIME type that identifies it as a calendar record, its payload is UTF8-encoded text that contains the iCalendar data (similar to an .ics file).
+Note that the iCalendar standard is a cross-platform calendar standard and not to be confused with Apple's iCal.
+http://www.ietf.org/rfc/rfc2445.txt
+NdefLibraryWin.Ndef.NdefIcalendarRecord.NdefIcalendarRecord | +( | +Appointment | +ap | ) | ++ |
Create a new iCalendar record based on the supplied appointment. The appointment will be automatically converted to a vCard for the payload of the record, using a matching algorithm to transform the data from the Windows Appointment class to the vCard standard.
+ap | Appointment to use for this iCalendar record. |
NdefLibraryWin.Ndef.NdefIcalendarRecord.NdefIcalendarRecord | +( | +byte[] | +iCalendarPayload | ) | ++ |
Parses the supplied iCalendar compatible payload (UTF8 encoded string) and converts it into the Windows 8 Appointment class by matching the properties. Afterwards, the method sets the payload of the record by converting the Appointment class back to an iCalendar file, to maintain consistency between the stored AppointmentData and the ics data in the payload.
+iCalendarPayload |
+
|
+ +getset | +
The product ID is mandatory for an ics file according to the specification. If you do not set this from your app, a default product ID will be used. See the official iCalendar specification for further details. http://www.ietf.org/rfc/rfc2445.txt
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibraryWin.Ndef.NdefMimeImageRecord, including all inherited members.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
Extended MIME / Image record for the WinRT APIs that integrates with the platform's image handling to support convenient conversion to and from various formats (WriteableBitmap, PNG, JPEG, etc.) + More...
++Public Member Functions | |
NdefMimeImageRecord (NdefRecord other) | |
Create a MIME / Image record based on the record passed through the argument. More... | |
async Task | SetImage (WriteableBitmap bmp, ImageMimeType mimeType, double dpi=96.0) |
Set an image to this class by specifying the WritableBitmap and the target encoding and optionally the DPI to set for the target file (if supported by the target file type). More... | |
async Task | LoadFile (StorageFile file) |
Set an image to this class by specifying an input file that has to be one of the supported MIME types (e.g., a JPEG or PNG file). More... | |
async Task | LoadStream (IRandomAccessStream imgStream) |
Set an image to this class by specifying an input stream that contains image data in one of the supported MIME types (e.g., JPEG or PNG file contents). More... | |
async Task | DetermineMimeTypeFromPayload () |
Utility method to determine & update the MIME type of the record according to the current payload. More... | |
async Task< WriteableBitmap > | GetImageAsBitmap () |
Retrieve the image stored in this class as a WriteableBitmap. Automatically decodes the image. More... | |
Public Member Functions inherited from NdefLibrary.Ndef.NdefMimeImageRecordBase | |
NdefMimeImageRecordBase (NdefRecord other) | |
Create a MIME / Image 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 async Task< NdefMimeImageRecord > | CreateFromBitmap (WriteableBitmap bmp, ImageMimeType mimeType, double dpi=96.0) |
Construct a new MIME / Image record based on a WriteableBitmap. Specify the MIME type and DPI, and the image data is encoded accordingly. More... | |
static async Task< NdefMimeImageRecord > | CreateFromFile (StorageFile file) |
Construct a new MIME / Image record based on a file. More... | |
static async Task< NdefMimeImageRecord > | CreateFromStream (IRandomAccessStream imgStream) |
Construct a new MIME / Image record based on a stream. More... | |
static Guid | GetBitmapEncoderIdForMimeType (ImageMimeType mimeType) |
Utility method to convert the MIME type enumeration used by this class to the platform's Bitmap Encoder GUID. More... | |
static ImageMimeType | GetMimeTypeForBitmapDecoderId (Guid codecId) |
Utility method to convert the platform's Bitmap Decoder codec ID / GUID to the MIME type enumeration used by this class. More... | |
Static Public Member Functions inherited from NdefLibrary.Ndef.NdefMimeImageRecordBase | |
static bool | IsRecordType (NdefRecord record) |
Checks if the record sent via the parameter is indeed a MIME / Image record. Only checks the type and type name format, doesn't analyze if the payload is valid. More... | |
+Additional Inherited Members | |
Public Types inherited from NdefLibrary.Ndef.NdefMimeImageRecordBase | |
enum | ImageMimeType { + Png, +Jpg, +Jpeg, +JpegXr, + + Bmp, +Gif, +Tiff + + } |
Common Image MIME type definitions, to be used when accessing the ImageMimeTypes dictionary to retrieve the correct MIME type string for the NDEF record. More... | |
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 Attributes inherited from NdefLibrary.Ndef.NdefMimeImageRecordBase | |
static readonly Dictionary< ImageMimeType, byte[]> | ImageMimeTypes |
Dictionary containing the most common MIME type definitions for various image formats. More... | |
Protected Member Functions inherited from NdefLibrary.Ndef.NdefMimeImageRecordBase | |
NdefMimeImageRecordBase () | |
Create an empty MIME / Image Record with the type of PNG. 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... | |
Extended MIME / Image record for the WinRT APIs that integrates with the platform's image handling to support convenient conversion to and from various formats (WriteableBitmap, PNG, JPEG, etc.)
+If you are working on a platform that supports the WinRT APIs and you need to interact with the image data, you can use this derived class instead of the base class.
+It adds several convenient methods to directly construct this record from a WriteableBitmap, from a stream containing image data or from a file. If loading from a stream / file, the class will automatically determine the correct MIME type and set it to the record.
+When loading & parsing an existing record, just construct this class based on a generic NdefRecord. You can then use convenient getter methods to retrieve a WriteableBitmap from the image data payload, no matter which encoding the image data is actually using.
+NdefLibraryWin.Ndef.NdefMimeImageRecord.NdefMimeImageRecord | +( | +NdefRecord | +other | ) | ++ |
Create a MIME / Image record based on the record passed through the argument.
+The original record has to be a MIME / Image Record as well.
+other | Record to copy into this Image record. |
NdefException | Thrown if attempting to create an Image record based on an incompatible record type. |
+
|
+ +static | +
Construct a new MIME / Image record based on a WriteableBitmap. Specify the MIME type and DPI, and the image data is encoded accordingly.
+bmp | Source bitmap to use for conversion. |
mimeType | MIME type to specify the target image encoding. |
dpi | Optional parameter to set the DPI of the encoded image (if supported by the specific MIME type). |
+
|
+ +static | +
Construct a new MIME / Image record based on a file.
+file | Reference to a file that will be opened and parsed by this class, to load its contents into the Payload of this record and set the MIME type correctly depending on the file contents. |
+
|
+ +static | +
Construct a new MIME / Image record based on a stream.
+imgStream | Reference to a stream containing image data (encoded for example as a PNG or JPEG). The stream will be parsed by this class, to load its contents into the Payload of this record and set the MIME type correctly depending on the stream contents. |
async Task NdefLibraryWin.Ndef.NdefMimeImageRecord.DetermineMimeTypeFromPayload | +( | +) | ++ |
Utility method to determine & update the MIME type of the record according to the current payload.
+Mostly for internal use, but can also be used externally if you set the Payload directly and want the class to adapt its MIME type based on the new Payload contents.
+
+
|
+ +static | +
Utility method to convert the MIME type enumeration used by this class to the platform's Bitmap Encoder GUID.
+mimeType | MIME type to convert. |
async Task<WriteableBitmap> NdefLibraryWin.Ndef.NdefMimeImageRecord.GetImageAsBitmap | +( | +) | ++ |
Retrieve the image stored in this class as a WriteableBitmap. Automatically decodes the image.
+Run this method from the UI thread, as it needs to create a WriteableBitmap. If you need to access the encoded image data (e.g., if it contains JPEG or PNG data), use the Payload property directly.
+
+
|
+ +static | +
Utility method to convert the platform's Bitmap Decoder codec ID / GUID to the MIME type enumeration used by this class.
+codecId | Bitmap decoder codec ID / GUID. |
async Task NdefLibraryWin.Ndef.NdefMimeImageRecord.LoadFile | +( | +StorageFile | +file | ) | ++ |
Set an image to this class by specifying an input file that has to be one of the supported MIME types (e.g., a JPEG or PNG file).
+Specify the reference to a file that is one of the supported MIME types - e.g., a JPEG or PNG image. The file contents are set as the payload of this record. This method will try to find out the MIME type of the referenced file automatically and adapt the type of the NDEF record accordingly.
+async Task NdefLibraryWin.Ndef.NdefMimeImageRecord.LoadStream | +( | +IRandomAccessStream | +imgStream | ) | ++ |
Set an image to this class by specifying an input stream that contains image data in one of the supported MIME types (e.g., JPEG or PNG file contents).
+The stream has to contain one of the supported MIME types - e.g., a JPEG or PNG image. The stream contents are set as the payload of this record. This method will try to find out the MIME type of the referenced stream contents automatically and adapt the type of the NDEF record accordingly.
+async Task NdefLibraryWin.Ndef.NdefMimeImageRecord.SetImage | +( | +WriteableBitmap | +bmp, | +
+ | + | ImageMimeType | +mimeType, | +
+ | + | double | +dpi = 96.0 |
+
+ | ) | ++ |
Set an image to this class by specifying the WritableBitmap and the target encoding and optionally the DPI to set for the target file (if supported by the target file type).
+The method takes the bitmap as input and uses the BitmapEncoder to encode the image data into the specified MIME type and file format. The encoded contents are then stored to the payload of the record, the MIME type is set as the type of the record.
+bmp | Input bitmap to encode and set as payload of this record. |
mimeType | MIME type to use for encoding this image. |
dpi | Target DPI if supported by the target file / MIME format. |
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibraryWin.Ndef.NdefVcardRecord, including all inherited members.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
Work with contact / vCard / vcf information in an NDEF record, and convert the WinRT Contact storage to / from a valid vCard representation. + More...
++Public Member Functions | |
NdefVcardRecord () | |
Construct an emtpy vCard record with no contact set. More... | |
NdefVcardRecord (NdefRecord other) | |
Creates a new instance of an NdefVcardRecord and imports the payload into the ContactData instance. More... | |
NdefVcardRecord (Contact contact) | |
Construct a new vCard record based on the WinRT contact instance, which is automatically converted to a vCard for the payload of this record. More... | |
NdefVcardRecord (string vCardString) | |
Create a new vCard record based on the string that contains valid vCard information. Automatically parses the vCard data and populates fields in the WinRT Contact instance accessible through ContactData. More... | |
NdefVcardRecord (byte[] vCardByte) | |
Create a new vCard record based on the byte array that contains valid vCard information. Automatically parses the vCard data and populates fields in the WinRT Contact instance accessible through ContactData. More... | |
vCard | ConvertContactToVCard (Contact contact) |
Map the Windows 8 Contact class to a vCard object from the vCard library. This mapping is not 1:1, as Contact has differnet properties than supported in the vCard standard. The method maps / converts as much information as possible. More... | |
Public Member Functions inherited from NdefLibrary.Ndef.NdefVcardRecordBase | |
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... | |
+Properties | |
Contact | ContactData [get, set] |
Contact from WinRT that is represented as a vCard by this class. 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.NdefVcardRecordBase | |
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 inherited from NdefLibrary.Ndef.NdefVcardRecordBase | |
static readonly byte[] | VcardType = Encoding.UTF8.GetBytes("text/x-vCard") |
Type of the NDEF MIME / vCard record. 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... | |
Work with contact / vCard / vcf information in an NDEF record, and convert the WinRT Contact storage to / from a valid vCard representation.
+WinRT is using the Contact class to store contact information for use in its address book. However, this class does not include conversion to and from the vCard standard that can be used to store the contact information in files (.vcf) or to include it as a payload for a contact NDEF record.
+Furthermore, the Contact class does not actually match the vCard standard from its supported features and information details.
+Therefore, this class depends on an external vCard library that is used so that the NFC library can convert between the WinRT Contact class and the vCard library that can generate and parse vcf contents.
+As that matching is not 1:1, some details might not be represented accurately after the conversion or might even get lost. But the class tries to retain as much information as possible and maps data between the WinRT Contact class and the vCard standard with care.
+You can either create a class instance from a WinRT Contact, or from a vCard string / UTF-8 encoded byte array. The class will handle automatic conversion between the two formats upon construction.
+NdefLibraryWin.Ndef.NdefVcardRecord.NdefVcardRecord | +( | +) | ++ |
Construct an emtpy vCard record with no contact set.
+ +NdefLibraryWin.Ndef.NdefVcardRecord.NdefVcardRecord | +( | +NdefRecord | +other | ) | ++ |
Creates a new instance of an NdefVcardRecord and imports the payload into the ContactData instance.
+other | An NDEF record that contains valid vCard data as its payload and has the right type information. |
NdefLibraryWin.Ndef.NdefVcardRecord.NdefVcardRecord | +( | +Contact | +contact | ) | ++ |
Construct a new vCard record based on the WinRT contact instance, which is automatically converted to a vCard for the payload of this record.
+contact | Contact instance that should be converted to a vCard for this payload's record. |
NdefLibraryWin.Ndef.NdefVcardRecord.NdefVcardRecord | +( | +string | +vCardString | ) | ++ |
Create a new vCard record based on the string that contains valid vCard information. Automatically parses the vCard data and populates fields in the WinRT Contact instance accessible through ContactData.
+vCardString | String that contains vCard data. |
NdefLibraryWin.Ndef.NdefVcardRecord.NdefVcardRecord | +( | +byte[] | +vCardByte | ) | ++ |
Create a new vCard record based on the byte array that contains valid vCard information. Automatically parses the vCard data and populates fields in the WinRT Contact instance accessible through ContactData.
+vCardByte | Byte array that contains vCard data. |
vCard NdefLibraryWin.Ndef.NdefVcardRecord.ConvertContactToVCard | +( | +Contact | +contact | ) | ++ |
Map the Windows 8 Contact class to a vCard object from the vCard library. This mapping is not 1:1, as Contact has differnet properties than supported in the vCard standard. The method maps / converts as much information as possible.
+contact | Source contact to convert to a vCard object. |
+
|
+ +getset | +
Contact from WinRT that is represented as a vCard by this class.
+If you make any changes to this class instance, call
+ ++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
This is the complete list of members for NdefLibraryWp.Ndef.NdefVcardRecord, including all inherited members.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
Work with contact / vCard / vcf information in an NDEF record, and convert the Windows Phone Contact or ContactInformation classes to / from a valid vCard representation. + More...
++Public Member Functions | |
async Task | ParsePayloadToContact () |
Takes the information stored in the payload of the record and converts that to a Contact. More... | |
async Task | AssemblePayload () |
Takes the ContactData instance and converts it to a vCard representation that is assigned to the payload of this record instance. More... | |
async Task | ParseDataToContact (string vCardString) |
Parse the supplied string containing vCard information (= vcf data) into a Windows Phone ContactInformation class (the ContactData property). More... | |
async Task | ParseDataToContact (byte[] vCardByte) |
Parse the supplied byte array containing UTF-8 encoded vCard information (= vcf data) into a Windows Phone ContactInformation class (the ContactData property). More... | |
Public Member Functions inherited from NdefLibrary.Ndef.NdefVcardRecordBase | |
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 async Task< NdefVcardRecord > | CreateFromGenericBaseRecord (NdefRecord record) |
Creates a new instance of an NdefVcardRecord and imports the payload into contact information. More... | |
static async Task< NdefVcardRecord > | CreateFromContactInformation (ContactInformation contactInfo, VCardFormat vCardFormat=VCardFormat.Version2_1) |
Create a new NdefVcardRecord based on an already supplied contact information from Windows Phone 8 ContactInformation data. The ContactInformation type is able to convert data into the vCard format. More... | |
static async Task< NdefVcardRecord > | CreateFromContact (Contact contact, VCardFormat vCardFormat=VCardFormat.Version2_1) |
Create a new NdefVcardRecord based on an already supplied contact information from Windows Phone 8 Contact data. This data type is used by the WP address book. Internally, this class will convert the Contact class instance to a ContactInformation instance using an own mapping algorithm, as only ContactInformation can be used for working with vCard data. More... | |
static async Task< ContactInformation > | ConvertContactToInformation (Contact contact) |
Called when reading a contact from the address book (Contact instance) and we need to convert it to a ContactInformation instance that supports conversion to a vCard. More... | |
Static Public Member Functions inherited from NdefLibrary.Ndef.NdefVcardRecordBase | |
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... | |
+Properties | |
+VCardFormat | VCardFormatToWrite [get, set] |
+ContactInformation | ContactData [get, protected set] |
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 Attributes inherited from NdefLibrary.Ndef.NdefVcardRecordBase | |
static readonly byte[] | VcardType = Encoding.UTF8.GetBytes("text/x-vCard") |
Type of the NDEF MIME / vCard record. 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... | |
Work with contact / vCard / vcf information in an NDEF record, and convert the Windows Phone Contact or ContactInformation classes to / from a valid vCard representation.
+Windows Phone supports two contact storage related classes: Contact and ContactInformation.
+Contact is used in the address book to represent a contact. However, only the ContactInformation class supports the vCard standard and is able to export / import vCard data.
+Unfortunately, the Microsoft APIs do not provide conversion between the two contact storage classes present in Windows Phone. Most times, you have to work with Contact instances, as this is what you need when interacting with the address book.
+Therefore, this class adds conversation between these two classes, so that you can create a vCard also based on the Contact class, to enable real-world use of the NFC library.
+As the information those two classes can store does not exactly match, this class is doing its best to support a great conversation and aims to retain as much information as possible. This works very well for the most common fields, but of course some additional information might get lost or changed during the transformation.
+Using the NdefVcardRecord for Windows Phone
+As most operations when working with contacts on WP are asynchronous, you can only construct a class instance using static constructor methods (factory pattern). These methods will then parse the supplied contact information (both Contact as well as ContactInformation) and convert that to a vCard payload suitable to be stored on an NFC tag.
+If you read an NDEF record from a tag, use CreateFromGenericBaseRecord() to convert the NdefRecord base class into a NdefVcardRecord and to immediately parse the vCard data into the ContactData property.
+To convert from Contact to ContactInformation in your app, the conversion method of this class have been made public: Contact -> ContactInformation: ConvertContactToInformation()
+async Task NdefLibraryWp.Ndef.NdefVcardRecord.AssemblePayload | +( | +) | ++ |
Takes the ContactData instance and converts it to a vCard representation that is assigned to the payload of this record instance.
+
+
|
+ +static | +
Called when reading a contact from the address book (Contact instance) and we need to convert it to a ContactInformation instance that supports conversion to a vCard.
+Note that there is no 1:1 conversion possible between those two formats, as they have a very different structure. This method does its best to map and retain as much information as possible.
+Currently, this method is only working with KnownContactProperties of the ContactInformation object, and doesn't define custom properties.
+contact | the contact from the address book to convert. |
+
|
+ +static | +
Create a new NdefVcardRecord based on an already supplied contact information from Windows Phone 8 Contact data. This data type is used by the WP address book. Internally, this class will convert the Contact class instance to a ContactInformation instance using an own mapping algorithm, as only ContactInformation can be used for working with vCard data.
+contact | Contact to be used for creating this record. |
vCardFormat | Optionally specify the VCardFormat to use for creating the textual payload data. |
+
|
+ +static | +
Create a new NdefVcardRecord based on an already supplied contact information from Windows Phone 8 ContactInformation data. The ContactInformation type is able to convert data into the vCard format.
+contactInfo | ContactInformation to be used for creating this record. |
vCardFormat | Optionally specify the VCardFormat to use for creating the textual payload data. |
+
|
+ +static | +
Creates a new instance of an NdefVcardRecord and imports the payload into contact information.
+record | An NDEF record of type NdefRecord that contains valid vCard data as its payload and has the right type information. |
async Task NdefLibraryWp.Ndef.NdefVcardRecord.ParseDataToContact | +( | +string | +vCardString | ) | ++ |
Parse the supplied string containing vCard information (= vcf data) into a Windows Phone ContactInformation class (the ContactData property).
+vCardString | String that contains the vCard data to parse. |
async Task NdefLibraryWp.Ndef.NdefVcardRecord.ParseDataToContact | +( | +byte[] | +vCardByte | ) | ++ |
Parse the supplied byte array containing UTF-8 encoded vCard information (= vcf data) into a Windows Phone ContactInformation class (the ContactData property).
+vCardByte | UTF-8 encoded byte array that contains the vCard data to parse. |
async Task NdefLibraryWp.Ndef.NdefVcardRecord.ParsePayloadToContact | +( | +) | ++ |
Takes the information stored in the payload of the record and converts that to a Contact.
++ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
CNdefLibrary.Ndef.NdefBtSecureSimplePairingRecord.BtClassOfDevice | Defines the Class of Device information data. This is to be used to provide a graphical representation to the user as part of UI involving operations with Bluetooth devices. For example, it may provide a particular icon to represent the device. |
CNdefLibrary.Ndef.NdefBtSecureSimplePairingRecord.BtServiceClasses | Utility class to handle the Bluetooth Service Classes defined in the OOB data of the Secure Simple Pairing Record. |
▼CException | |
CNdefLibrary.Ndef.NdefException | Exception occured when parsing or assembling NDEF messages, records and their respective payloads. |
CNdefLibrary.GeoCoordinate | Custom GeoCoordinate class to allow for cross-platform portability. |
▼CList | |
CNdefLibrary.Ndef.NdefMessage | An NDEF message is composed of one or more NDEF records. |
CNdefLibrary.Ndef.NdefBtSecureSimplePairingRecord.BtClassOfDevice.MinorDeviceClassType | Information class that specifies required information to correclty parse and create a minor device class based on one or more encoded values. The exact format of the minor device class depends on the major device class in use, and this class enables to look up the encoding and lets this implementation take care of most of the complex underlying work that needs to be done. |
CNdefLibrary.Ndef.NdefExceptionMessages | A strongly-typed resource class, for looking up localized strings, etc. |
CNdefLibrary.Ndef.NdefHandoverVersion | Utility class that handles the correct format for storing version information in Handover records. The handover version contains a major and minor version. This implementation conforms to the specification with major version 1 and minor version 3. |
▼CNdefLibrary.Ndef.NdefRecord | An NDEF record contains a payload described by a type, a length, and an optional identifier. |
CNdefLibrary.Ndef.NdefAndroidAppRecord | Creates the Android-specific Android Application Record. |
CNdefLibrary.Ndef.NdefBtSecureSimplePairingRecord | Create an NDEF record for Bluetooth Carrier Handover according to the "Secure Simple Pairing" mechanism defined by the Bluetooth SIG. |
CNdefLibrary.Ndef.NdefHandoverAlternativeCarrierRecord | The Alternative Carrier record is used within the payload of the Handover Select record to describe a single alternative carrier. |
CNdefLibrary.Ndef.NdefHandoverErrorRecord | The Error Record is used in the Handover Select Record to indicate that the Handover Selector failed to successfully process the most recently received Handover Request Message. It SHALL NOT be used elsewhere. |
CNdefLibrary.Ndef.NdefHandoverSelectRecord | Handover Select Record for the Connection Handover Standard. Its payload contains at least one reference to an Alternative Carrier record that defines a possible carrier for a connection handover. |
▼CNdefLibrary.Ndef.NdefIcalendarRecordBase | |
CNdefLibraryWin.Ndef.NdefIcalendarRecord | A platform-specific class for Windows 8.1 that is able to convert the Windows Appointment class into a valid iCalendar structure and back again |
CNdefLibrary.Ndef.NdefLaunchAppRecord | Handles the Windows LaunchApp record format. |
▼CNdefLibrary.Ndef.NdefMimeImageRecordBase | Stores a MIME type and image data for individual use or as a part of another record like the Smart Poster. |
CNdefLibraryUwp.Ndef.NdefMimeImageRecord | Extended MIME / Image record for the WinRT APIs that integrates with the platform's image handling to support convenient conversion to and from various formats (WriteableBitmap, PNG, JPEG, etc.) |
CNdefLibraryWin.Ndef.NdefMimeImageRecord | Extended MIME / Image record for the WinRT APIs that integrates with the platform's image handling to support convenient conversion to and from various formats (WriteableBitmap, PNG, JPEG, etc.) |
CNdefLibrary.Ndef.NdefSpActRecord | The Action record is a Local Type specific to the Smart Poster. |
CNdefLibrary.Ndef.NdefSpMimeTypeRecord | 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. |
▼CNdefLibrary.Ndef.NdefSpRecord | Handles the Smart Poster meta-record and is able to both parse and assemble a smart poster according to the specification. |
▼CNdefLibrary.Ndef.NdefSmartUriRecord | 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 |
CNdefLibrary.Ndef.NdefGeoRecord | Store longitude and latitude on a tag, to allow the user to view a map when tapping the tag. |
CNdefLibrary.Ndef.NdefMailtoRecord | Convenience class for creating records that open the email app on the user's device, with a specified recipient address, subject and body text. |
CNdefLibrary.Ndef.NdefSmsRecord | Convenience class for formatting SMS information into an NDEF record, depending on added info either URI or Smart Poster. |
CNdefLibrary.Ndef.NdefSocialRecord | Link to one of the supported social networks by simply selecting the network and specifying the username. |
CNdefLibrary.Ndef.NdefTelRecord | Convenience class for formatting telephone call information into an NDEF record, depending on added info either URI or Smart Poster. |
CNdefLibrary.Ndef.NdefSpSizeRecord | The Size Record contains a four-byte, 32-bit, unsigned integer, which contains the size of object that the URI field refers to. |
CNdefLibrary.Ndef.NdefTextRecord | The Text record as specified by the NFC Forum URI record type definition. |
▼CNdefLibrary.Ndef.NdefUriRecord | The URI record as specified by the NFC Forum URI record type definition. |
CNdefLibrary.Ndef.NdefNokiaAccessoriesRecord | URI NDEF Record with the custom nokia-accessories URI scheme, as used for example in the Nokia Wireless Charging Stand. |
CNdefLibrary.Ndef.NdefWindowsSettingsRecord | Convenience class for formatting URI records that launch specific setting pages on Windows 10. |
CNdefLibrary.Ndef.NdefWpSettingsRecord | Convenience class for formatting URI records that launch specific setting pages on Windows Phone 8. Please use the NdefWindowsSettingsRecord for Windows 10 and Windows 10 Mobile. |
▼CNdefLibrary.Ndef.NdefVcardRecordBase | Stores a business card (vCard) in a MIME type record, allowing users to immediately add a contact to their address book. |
CNdefLibraryUwp.Ndef.NdefVcardRecord | Work with contact / vCard / vcf information in an NDEF record, and convert the WinRT Contact storage to / from a valid vCard representation. |
CNdefLibraryWin.Ndef.NdefVcardRecord | Work with contact / vCard / vcf information in an NDEF record, and convert the WinRT Contact storage to / from a valid vCard representation. |
CNdefLibraryWp.Ndef.NdefVcardRecord | Work with contact / vCard / vcf information in an NDEF record, and convert the Windows Phone Contact or ContactInformation classes to / from a valid vCard representation. |
+ |
+ NFC / NDEF Library for Proximity APIs
+ 3.1.1
+
+ Easily parse and create NDEF records with the Windows Proximity APIs / Near Field Communication NFC.
+ |
+
t |