-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
scala-js/scala-js-dom#806: Add support for Web NFC API
- Loading branch information
1 parent
96d0e78
commit 89966dc
Showing
6 changed files
with
154 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
package org.scalajs.dom | ||
|
||
import scala.scalajs.js | ||
import scala.scalajs.js.annotation.JSGlobal | ||
|
||
/** The [[NDEFMessage]] interface of the Web NFC API represents the content of an NDEF message that has been read from | ||
* or could be written to an NFC tag. An instance is acquired by calling the NDEFMessage() constructor or from the | ||
* NDEFReadingEvent.message property, which is passed to the reading event. | ||
* | ||
* @param records\ | ||
* The records property of NDEFMessage interface represents a list of NDEFRecords present in the NDEF message. | ||
*/ | ||
@js.native | ||
@JSGlobal | ||
class NDEFMessage(var records: js.Array[NDEFRecord] = js.native) extends js.Object |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
package org.scalajs.dom | ||
|
||
import scala.scalajs.js | ||
import scala.scalajs.js.annotation.JSGlobal | ||
import scala.scalajs.js.| | ||
|
||
/** The [[NDEFReader]] interface of the Web NFC API (https://developer.mozilla.org/en-US/docs/Web/API/Web_NFC_API) is | ||
* used to read from and write data to compatible NFC devices, e.g. NFC tags supporting NDEF, when these devices are | ||
* within the reader's magnetic induction field. | ||
*/ | ||
@JSGlobal("NDEFReader") | ||
@js.native | ||
class NDEFReader() extends EventTarget { | ||
|
||
/** Activates a reading device and returns a Promise that either resolves when an NFC tag read operation is scheduled | ||
* or rejects if a hardware or permission error is encountered. This method triggers a permission prompt if the "nfc" | ||
* permission has not been previously granted. | ||
* | ||
* @return | ||
* a Promise that resolves immediately after scheduling read operations for the NFC adapter. | ||
*/ | ||
def scan(options: NDEFScanOptions = js.native): js.Promise[js.Any] = js.native | ||
|
||
/** Attempts to write an NDEF message to a tag and returns a Promise that either resolves when a message has been | ||
* written to the tag or rejects if a hardware or permission error is encountered. This method triggers a permission | ||
* prompt if the "nfc" permission has not been previously granted. | ||
* | ||
* @param message | ||
* The message to be written, either a string object or literal, an ArrayBuffer, a TypedArray, a DataView, or an | ||
* array of records. A record has the following members: | ||
* @param options | ||
* An object with the following properties: | ||
* | ||
* @return | ||
* a Promise that either resolves when a message has been written to the tag or rejects if a hardware or permission | ||
* error is encountered. | ||
*/ | ||
def write( | ||
message: String | js.typedarray.ArrayBuffer | /* js.typedarray.TypedArray[NDEFRecord, ???] */ js.typedarray.DataView | | ||
js.Array[NDEFRecord], options: NDEFWriteOptions = js.native | ||
): js.Promise[js.Any] = js.native | ||
|
||
/** The reading event of the NDEFReader interface is fired whenever a new reading is available from compatible NFC | ||
* devices (e.g. NFC tags supporting NDEF) when these devices are within the reader's magnetic induction field. | ||
*/ | ||
var onreading: js.Function1[NDEFReadingEvent, Any] = js.native | ||
|
||
/** The readingerror event of the NDEFReader interface is fired whenever an error occurs during reading of NFC tags, | ||
* e.g. when tags leave the reader's magnetic induction field. | ||
*/ | ||
var onreadingerror: js.Function1[Event, Any] = js.native | ||
} |
22 changes: 22 additions & 0 deletions
22
webapp/src/main/scala/org/scalajs/dom/NDEFReadingEvent.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
package org.scalajs.dom | ||
|
||
import scala.scalajs.js | ||
|
||
/** The NDEFReadingEvent interface of the Web NFC API represents events dispatched on new NFC readings obtained by | ||
* NDEFReader. | ||
* | ||
* @see | ||
* https://developer.mozilla.org/en-US/docs/Web/API/NDEFReadingEvent | ||
*/ | ||
@js.native | ||
trait NDEFReadingEvent extends Event { | ||
|
||
/** Returns an NDEFMessage object containing the received message. */ | ||
var message: NDEFMessage = js.native | ||
|
||
/** Returns the serial number of the device, which is used for anti-collision and identification, or an empty string | ||
* if no serial number is available. | ||
*/ | ||
var serialNumber: String = js.native | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
package org.scalajs.dom | ||
|
||
import scala.scalajs.js | ||
import scala.scalajs.js.annotation.JSGlobal | ||
|
||
/** The [[NDEFRecord]] interface of the Web NFC API provides data that can be read from, or written to, compatible NFC | ||
* devices, e.g. NFC tags supporting NDEF. | ||
*/ | ||
@js.native | ||
@JSGlobal | ||
class NDEFRecord extends js.Object { | ||
|
||
/** Returns the record type of the record. Records must have either a standardized well-known type name such as | ||
* "empty", "text", "url", "smart-poster", "absolute-url", "mime", or "unknown" or else an external type name, which | ||
* consists of a domain name and custom type name separated by a colon (":"). | ||
*/ | ||
var recordType: String = js.native | ||
|
||
/** Returns the MIME type of the record. This value will be null if recordType is not equal to "mime". */ | ||
var mediaType: js.UndefOr[String] = js.native | ||
|
||
/** Returns the record identifier, which is an absolute or relative URL used to identify the record. | ||
* | ||
* Note: The uniqueness of the identifier is enforced only by the generator of the record. | ||
*/ | ||
var id: js.UndefOr[String] = js.native | ||
|
||
/** Returns a DataView containing the raw bytes of the record's payload. */ | ||
var data: js.typedarray.DataView = js.native | ||
// var data: DataView = js.native | ||
|
||
/** Returns the encoding of a textual payload, or null otherwise. */ | ||
var encoding: js.UndefOr[String] = js.native | ||
|
||
/** Returns the language of a textual payload, or null if one was not supplied. */ | ||
var lang: js.UndefOr[String] = js.native | ||
|
||
/** Converts [[NDEFRecord.data]] to a sequence of records. This allows parsing the payloads of record types which may | ||
* contain nested records, such as smart poster and external type records. | ||
*/ | ||
def toRecords(): js.Array[NDEFRecord] = js.native | ||
} |
10 changes: 10 additions & 0 deletions
10
webapp/src/main/scala/org/scalajs/dom/NDEFScanOptions.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
package org.scalajs.dom | ||
|
||
import scala.scalajs.js | ||
|
||
@js.native | ||
trait NDEFScanOptions extends js.Object { | ||
|
||
/** An AbortSignal that allows the current write operation to be canceled. */ | ||
def `signal`: js.UndefOr[AbortSignal] = js.native | ||
} |
13 changes: 13 additions & 0 deletions
13
webapp/src/main/scala/org/scalajs/dom/NDEFWriteOptions.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
package org.scalajs.dom | ||
|
||
import scala.scalajs.js | ||
|
||
@js.native | ||
trait NDEFWriteOptions extends js.Object { | ||
|
||
/** A boolean value specifying whether or not existing records should be overwritten, if such exists. */ | ||
def `overwrite`: Boolean = js.native | ||
|
||
/** An AbortSignal that allows the current write operation to be canceled. */ | ||
def `signal`: js.UndefOr[AbortSignal] = js.native | ||
} |