Class Ndef

Object
   |
   +--Ndef

class Ndef

Defined in ndef.js

Field Detail

flags

Object flags

id

Object id

typeLength

Object typeLength

chunkFlag

<static> Object chunkFlag

idLengthFlag

<static> Object idLengthFlag

messageBegin

<static> Object messageBegin

messageEnd

<static> Object messageEnd

shortRecord

<static> Object shortRecord

tnf

<static> Object tnf

uriIdentifier

<static> Object uriIdentifier

Ndef

Ndef(encoded)

--------- |.##> <##.| Open Smart Card Development Platform (www.openscdp.org) |# #| |# #| Copyright (c) 1999-2011 CardContact Software & System Consulting |'##> <##'| Andreas Schwier, 32429 Minden, Germany (www.cardcontact.de) --------- This file is part of OpenSCDP. OpenSCDP is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation. OpenSCDP is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenSCDP; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

decode

void decode(<ByteString> encoded)

Create Ndef object

Parameters:
encoded - the encoded Ndef ByteString

getEncoded

ByteString getEncoded()

Return the Ndef in encoded format

Returns:
encoded Ndef

getPayload

ByteString getPayload()

Return the payload of the NDEF object.

Returns:
the payload

getTNF

ByteString getTNF()

Return the TNF flag The flag indicates the structure of the type value. 0x00 = Empty 0x01 = NFC Forum well-known type 0x02 = Media-type as defined in RFC 2046 0x03 = Absolute URI as defined in RFC 3986 0x04 = NFC Forum external type 0x05 = Unknown 0x06 = Unchanged 0x07 = Reserved

Returns:
the TNF

getUri

String getUri()

Return the decoded URI in readable form.

Returns:
the UTF-8 decoded URI

isChunked

Boolean isChunked()

Check if the Chunk flag is set. The flag indicates that this is either the first or the middle record chunk of a chunked payload.

isIdLengthFlag

Boolean isIdLengthFlag()

Check if the ID Length flag is set. The flag indicates that the ID Length field and the ID field are present. Otherwise the both are omitted from the record.

isMessageBegin

Boolean isMessageBegin()

Check if the Message Begin flag is set. The flag indicates the start of an NDEF message.

isMessageEnd

Boolean isMessageEnd(state)

Check if the Message End flag is set. The flag indicates the end of an NDEF message.

isShortRecord

Boolean isShortRecord()

Check if the Short Record flag is set. The flag indicates that the payload size will range between 0 to 255 octets.

setChunked

Object setChunked(<Boolean> state)

Set the Chunk flag. The flag indicates that this is either the first or the middle record chunk of a chunked payload.

Parameters:
state -

setIdLengthFlag

Object setIdLengthFlag(<Boolean> state)

Set the ID Length flag. The flag indicates that the ID Length field and the ID field are present. Otherwise the both are omitted from the record.

Parameters:
state -

setMessageBegin

Object setMessageBegin(<Boolean> state)

Set the Message Begin flag. The flag indicates the start of an NDEF message.

Parameters:
state -

setMessageEnd

Object setMessageEnd(<Boolean> state)

Set the Message End flag. The flag indicates the end of an NDEF message.

Parameters:
state -

setShortRecord

Object setShortRecord(<Boolean> state)

Set the Short Record flag. The flag indicates that the payload size will range between 0 to 255 octets.

Parameters:
state -

setTNF

void setTNF(tnf)

Set the TNF (Type Name Format) flag. The flag indicates the structure of the type value. 0x00 = Empty 0x01 = NFC Forum well-known type 0x02 = Media-type as defined in RFC 2046 0x03 = Absolute URI as defined in RFC 3986 0x04 = NFC Forum external type 0x05 = Unknown 0x06 = Unchanged 0x07 = Reserved

Parameters:
state -

toString

String toString()

Returns:
str A String containing the flag byte and the uri payload.

newMessage

<static> Object newMessage(<String> type, <ByteString> payload)

Create a new NDEF Message

Parameters:
type - The type of the NDEF Message coded in US-ASCII.
payload -

newUri

<static> NDEF newUri(<String> str)

Create a new Uri from string

Parameters:
str -

Returns:
the NDEF object

shortenString

<static> ByteString shortenString(<String> str)

Search for possible abbrevation in String and return the corresponding Uri Identifier

Parameters:
str - the message coded in UTF-8

Returns:
the payload consisting of the Uri Identifier and the shortened string