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

Convenience class for formatting URI records that launch specific setting pages on Windows 10. More...

Inheritance diagram for NdefLibrary.Ndef.NdefWindowsSettingsRecord:
NdefLibrary.Ndef.NdefUriRecord NdefLibrary.Ndef.NdefRecord

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, UpdateSecurityDevelopers
}
 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...
 

Detailed Description

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

Member Enumeration Documentation

◆ NfcSettingsApp

The different setting schemes for launching setting app pages on Windows Phone, as defined by Microsoft.

Constructor & Destructor Documentation

◆ NdefWindowsSettingsRecord() [1/2]

NdefLibrary.Ndef.NdefWindowsSettingsRecord.NdefWindowsSettingsRecord ( )

Create an empty Windows Settings record.

◆ NdefWindowsSettingsRecord() [2/2]

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.

Parameters
otherOther record to copy the data from.

Member Function Documentation

◆ IsRecordType()

static new bool NdefLibrary.Ndef.NdefWindowsSettingsRecord.IsRecordType ( NdefRecord  record)
static

Checks if the record sent via the parameter is indeed a Windows Settings record.

Parameters
recordRecord to check.
Returns
True if the record has the correct type and type name format to be a Windows Settings record + if its URI equals one of the allowed scheme names. False if it's a different record.

Property Documentation

◆ SettingsApp

NfcSettingsApp NdefLibrary.Ndef.NdefWindowsSettingsRecord.SettingsApp
getset

Use this property to get/set which settings page is launched through the record.


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