Titanium SDK

# Modules.Nfc.TagTechnologyNdefFormatable

Provide access to NDEF format operations on a Modules.Nfc.NfcTag.

Availability
1.1.0
Extends
Modules.Nfc.TagTechnology

# Overview

Use the Modules.Nfc.createTagTechnologyNdefFormatable method to create this tag technology.

See also: NdefFormatable (opens new window)

# Properties

# apiName READONLY

Availability
3.2.0
apiName :String

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button returns Ti.UI.Button.

# lifecycleContainer

Availability
3.6.0
lifecycleContainer :Titanium.UI.Window | Titanium.UI.TabGroup

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.

# tag

Availability
1.1.0
tag :Modules.Nfc.NfcTag

The tag technology that has been discovered.

When a tag is discovered, a Modules.Nfc.NfcTag proxy is created and passed as a property to the onNdefDiscovered, onTagDiscovered, or onTechDiscovered callback (see NdefDiscovered).

# Methods

# close

Availability
1.1.0
close() → void

Disable I/O operations to the tag and release resources.

Returns

Type
void

# connect

Availability
1.1.0
connect() → void

Enable I/O operations to the tag.

Only one Tag Technology proxy can be connected to a Tag at a time.

Returns

Type
void

# format

Availability
1.1.0
format(message) → void

Format a tag as NDEF, and write a Modules.Nfc.NdefMessage.

Parameters

Name Type Description
message Modules.Nfc.NdefMessage

The NDEF message to write after formatting, can be null.

Returns

Type
void

# formatReadOnly

Availability
1.1.0
formatReadOnly(message) → void

Formats a tag as NDEF, write a Modules.Nfc.NdefMessage, and make read-only.

Parameters

Name Type Description
message Modules.Nfc.NdefMessage

The NDEF message to write after formatting

Returns

Type
void

# isConnected

Availability
1.1.0
isConnected() → Boolean

Returns true if connect has completed, and close has not been called, and the tag is not known to be out of range.

Returns

Type
Boolean

# isValid

Availability
1.1.0
isValid() → Boolean

Return true if this tag technology was successfully obtained.

Returns

Type
Boolean

Contents