* @remarks @b Header @b %file: @b \#include @b <FNet.h> @n
* @b Library : @b osp-nfc @n
*
- * The %Nfc namespace contains the various classes and interfaces for the Near Field Communication (NFC) programming that
- * enables the devices to share information within a distance of less than @c 4 centimeters.
+ * The %Nfc namespace contains the various classes and interfaces for the Near Field Communication (NFC) programming
+ * that enables the devices to share information within a distance of less than @c 4 centimeters.
*
* For more information on the NFC namespace features, see
* <a href="../org.tizen.native.appprogramming/html/guide/net/nfc.htm">NFC Guide</a>.
*
* @since 2.0
*
- * The %INdefMessageDiscoveryEventListener interface specifies the methods used for creating notifications about the NDEF message discovered from the
- * target tag.
+ * The %INdefMessageDiscoveryEventListener interface specifies the methods used for creating notifications about the
+ * NDEF message discovered from the target tag.
*
* For more information on the class features, see
* <a href="../org.tizen.native.appprogramming/html/guide/net/nfc.htm">NFC Guide</a>.
* @since 2.0
*
* @param[in] pMessage The detected NDEF message
- * @remarks This method can be used for read-only access to the data on the target without opening a connection
- * to it. @n
- * The input NdefMessage object must be deleted by the application after use, even outside this
- * method. The NdefMessage::RemoveAllRecords() method must be called with @c true as the input value
- * immediately before the NdefMessage object is deleted.
+ * @remarks
+ * - This method can be used for read-only access to the data on the target without opening a
+ * connection to it.
+ * - The input NdefMessage object must be deleted by the application after use, even outside this
+ * method. The NdefMessage::RemoveAllRecords() method must be called with @c true as the input value
+ * immediately before the NdefMessage object is deleted.
*/
virtual void OnNdefMessageDetectedN(NdefMessage* pMessage) = 0;
protected:
//
- // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
+ // This method is for internal use only. Using this method can cause behavioral, security-related, and
+ // consistency-related issues in the application.
//
// This method is reserved and may change its name at any time without prior notice.
//
virtual void INdefMessageDiscoveryEventListener_Reserved1(void) {}
//
- // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
+ // This method is for internal use only. Using this method can cause behavioral, security-related, and
+ // consistency-related issues in the application.
//
// This method is reserved and may change its name at any time without prior notice.
//
virtual void INdefMessageDiscoveryEventListener_Reserved2(void) {}
//
- // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
+ // This method is for internal use only. Using this method can cause behavioral, security-related, and
+ // consistency-related issues in the application.
//
// This method is reserved and may change its name at any time without prior notice.
//
* @brief This interface provides a listener for the events related to the %NfcPushManager.
* @since 2.0
*
- * The %INdefPushManagerListener interface specifies the methods used for receiving the status of the pushed NDEF message asynchronously.
+ * The %INdefPushManagerListener interface specifies the methods used for receiving the status of the pushed NDEF
+ * message asynchronously.
*
* For more information on the class features, see
- * <a href="../com.osp.cppappprogramming.help/html/guide/net/nfc.htm">NFC Guide</a>.
+ * <a href="../org.tizen.native.appprogramming/html/guide/net/nfc.htm">NFC Guide</a>.
*/
class _OSP_EXPORT_ INdefPushManagerListener
: virtual public Tizen::Base::Runtime::IEventListener
protected:
//
- // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
+ // This method is for internal use only. Using this method can cause behavioral, security-related, and
+ // consistency-related issues in the application.
//
// The following methods are reserved, and the name of methods can be changed at any time without prior notice.
//
virtual void INdefPushManagerListener_Reserved1(void) {}
//
- // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
+ // This method is for internal use only. Using this method can cause behavioral, security-related, and
+ // consistency-related issues in the application.
//
// The following methods are reserved, and the name of methods can be changed at any time without prior notice.
//
*
* @since 2.0
*
- * The %INdefTagConnectionListener interface specifies the methods used for creating the notifications about the result of an action for the
- * NdefTagConnection, such as reading and writing the NDEF data.
+ * The %INdefTagConnectionListener interface specifies the methods used for creating the notifications about the result
+ * of an action for the NdefTagConnection, such as reading and writing the NDEF data.
*
* For more information on the class features, see
* <a href="../org.tizen.native.appprogramming/html/guide/net/nfc.htm">NFC Guide</a>.
* @see NdefTagConnection::Read()
* @remarks The input NdefMessage object must be deleted by the application after use, even outside this
* method. The NdefMessage::RemoveAllRecords() method must be called with @c true as the input value
- * right before the NdefMessage object is deleted.
+ * right before the %NdefMessage object is deleted.
*/
virtual void OnNdefReadCompletedN(NdefMessage* pMessage, result r) = 0;
protected:
//
- // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
+ // This method is for internal use only. Using this method can cause behavioral, security-related, and
+ // consistency-related issues in the application.
//
// This method is reserved and may change its name at any time without prior notice.
//
virtual void INdefTagConnectionListener_Reserved1(void) {}
//
- // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
+ // This method is for internal use only. Using this method can cause behavioral, security-related, and
+ // consistency-related issues in the application.
//
// This method is reserved and may change its name at any time without prior notice.
//
virtual void INdefTagConnectionListener_Reserved2(void) {}
//
- // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
+ // This method is for internal use only. Using this method can cause behavioral, security-related, and
+ // consistency-related issues in the application.
//
// This method is reserved and may change its name at any time without prior notice.
//
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
* @since 2.0
*
* The %INfcDeviceDiscoveryEventListener interface specifies the methods used for creating the notifications
- * about detecting a device.
+ * about detecting a device.
*
* For more information on the class features, see
- * <a href="../com.osp.cppappprogramming.help/html/guide/net/nfc.htm">NFC Guide</a>.
+ * <a href="../org.tizen.native.appprogramming/html/guide/net/nfc.htm">NFC Guide</a>.
*/
class _OSP_EXPORT_ INfcDeviceDiscoveryEventListener
: virtual public Tizen::Base::Runtime::IEventListener
*
* @since 2.0
*
- * The %INfcManagerEventListener interface specifies the method used for creating the notifications about a change in the NfcManager status.
+ * The %INfcManagerEventListener interface specifies the method used for creating the notifications about a change in
+ * the NfcManager status.
*
* For more information on the class features, see
* <a href="../org.tizen.native.appprogramming/html/guide/net/nfc.htm">NFC Guide</a>.
protected:
//
- // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
+ // This method is for internal use only. Using this method can cause behavioral, security-related, and
+ // consistency-related issues in the application.
//
// This method is reserved and may change its name at any time without prior notice.
//
virtual void INfcManagerEventListener_Reserved1(void) {}
//
- // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
+ // This method is for internal use only. Using this method can cause behavioral, security-related, and
+ // consistency-related issues in the application.
//
// This method is reserved and may change its name at any time without prior notice.
//
virtual void INfcManagerEventListener_Reserved2(void) {}
//
- // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
+ // This method is for internal use only. Using this method can cause behavioral, security-related, and
+ // consistency-related issues in the application.
//
// This method is reserved and may change its name at any time without prior notice.
//
virtual void INfcManagerEventListener_Reserved3(void) {}
//
- // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
+ // This method is for internal use only. Using this method can cause behavioral, security-related, and
+ // consistency-related issues in the application.
//
// This method is reserved and may change its name at any time without prior notice.
//
virtual void INfcManagerEventListener_Reserved4(void) {}
//
- // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
+ // This method is for internal use only. Using this method can cause behavioral, security-related, and
+ // consistency-related issues in the application.
//
// This method is reserved and may change its name at any time without prior notice.
//
*
* @since 2.0
*
- * The %INfcTagDiscoveryEventListener interface specifies the methods used for creating the notifications about detecting the target tag.
+ * The %INfcTagDiscoveryEventListener interface specifies the methods used for creating the notifications about
+ * detecting the target tag.
*
* For more information on the class features, see
* <a href="../org.tizen.native.appprogramming/html/guide/net/nfc.htm">NFC Guide</a>.
protected:
//
- // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
+ // This method is for internal use only. Using this method can cause behavioral, security-related, and
+ // consistency-related issues in the application.
//
// This method is reserved and may change its name at any time without prior notice.
//
virtual void INfcTagDiscoveryEventListener_Reserved1(void) {}
//
- // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
+ // This method is for internal use only. Using this method can cause behavioral, security-related, and
+ // consistency-related issues in the application.
//
// This method is reserved and may change its name at any time without prior notice.
//
virtual void INfcTagDiscoveryEventListener_Reserved2(void) {}
//
- // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
+ // This method is for internal use only. Using this method can cause behavioral, security-related, and
+ // consistency-related issues in the application.
//
// This method is reserved and may change its name at any time without prior notice.
//
*
* @since 2.0
*
- * The %ITagConnectionListener interface provides methods that are used for creating notifications for the result of the actions of the
- * TagConnection, such as sending a command.
+ * The %ITagConnectionListener interface provides methods that are used for creating notifications for the result of
+ * the actions of the TagConnection, such as sending a command.
*
* For more information on the class features, see
* <a href="../org.tizen.native.appprogramming/html/guide/net/nfc.htm">NFC Guide</a>.
protected:
//
- // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
+ // This method is for internal use only. Using this method can cause behavioral, security-related, and
+ // consistency-related issues in the application.
//
// This method is reserved and may change its name at any time without prior notice.
//
virtual void ITagConnectionListener_Reserved1(void) {}
//
- // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
+ // This method is for internal use only. Using this method can cause behavioral, security-related, and
+ // consistency-related issues in the application.
//
// This method is reserved and may change its name at any time without prior notice.
//
virtual void ITagConnectionListener_Reserved2(void) {}
//
- // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
+ // This method is for internal use only. Using this method can cause behavioral, security-related, and
+ // consistency-related issues in the application.
//
// This method is reserved and may change its name at any time without prior notice.
//
*
* @since 2.0
*
- * The %NdefMessage class represents an NDEF message. An NDEF message is composed of 1 or more NDEF records. Therefore, this class
- * has NdefRecord instances and provides the operations to manipulate the list of those instances. These operations are
- * very similar to those of the Tizen::Base::Collection::IList class.
+ * The %NdefMessage class represents an NDEF message. An NDEF message is composed of 1 or more NDEF records. Therefore,
+ * this class has NdefRecord instances and provides the operations to manipulate the list of those instances. These
+ * operations are very similar to those of the Tizen::Base::Collection::IList class.
*
* If a new NDEF record is inserted, the uniqueness of its payload identifier is checked. This class also provides
* methods which convert %NdefMessage to Tizen::Base::ByteBuffer and vice versa.
*
* @since 2.0
*
- * @return @c true if the specified instance of %Object is equal to the calling %NdefMessage instance, @n
+ * @return @c true if the specified instance of Tizen::Base::Object is equal to the calling %NdefMessage
+ * instance, @n
* else @c false
* @param[in] obj The object to compare
- * @remark Two %NdefMessage instances are equal only if they contain the same %NdefRecord instances in the
+ * @remark Two NdefMessage instances are equal only if they contain the same %NdefRecord instances in the
* same order.
*/
virtual bool Equals(const Tizen::Base::Object& obj) const;
* @since 2.0
*
* @return An error code
- * @param[in] record The NDEF record to be appended
+ * @param[in] record The NDEF record to append
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified NDEF record is invalid. @n
* For example, the record has the same payload identifier as the other records in
* @since 2.0
*
* @return An error code
- * @param[in] record The NDEF record to be inserted
+ * @param[in] record The NDEF record to insert
* @param[in] index The index at which the NDEF record must be inserted
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified index is outside the bounds of the record list. @n
* For example, the record has the same payload identifier as the other records in
* this NDEF message.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks The NDEF records that appear after the insertion point move downwards to accommodate the inserted
- * NDEF record.
- * This method performs a shallow copy. It adds just the pointer, not the NdefRecord instance.
+ * @remarks
+ * - The NDEF records that appear after the insertion point move downwards to accommodate the inserted
+ * NDEF record.
+ * - This method performs a shallow copy. It adds just the pointer, not the NdefRecord instance.
*/
result InsertRecordAt(const NdefRecord& record, int index);
* @since 2.0
*
* @return An error code
- * @param[in] record The NDEF record to be set
- * @param[in] index The index at which the NDEF record is to be set
+ * @param[in] record The NDEF record to set
+ * @param[in] index The index at which the NDEF record is set
* @param[in] deallocate Set to @c true to deallocate the replaced record, @n
* else @c false
* @exception E_SUCCESS The method is successful.
*
* @since 2.0
*
- * @return The NDEF message as a ByteBuffer, @n
+ * @return The NDEF message as a Tizen::Base::ByteBuffer, @n
* else @c null if the conversion fails
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_DATA The specified NDEF message does not contain any NDEF records.
Tizen::Base::ByteBuffer* ToByteBufferN(void) const;
/**
- * Gets a new instance of the NDEF message from the specified ByteBuffer.
+ * Gets a new instance of the NDEF message from the specified Tizen::Base::ByteBuffer.
*
* @since 2.0
*
static NdefMessage* GetInstanceN(const Tizen::Base::ByteBuffer& buffer);
/**
- * Copying of objects using this copy assignment operator is allowed.
+ * Assigns the value of the specified instance to the current instance of %NdefMessage.
*
* @since 2.0
*
// http://floralicense.org/license/
//
// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an AS IS BASIS,
+// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
* The %NdefPushManager class is the class for pushing an NDEF message to a device.
*
* For more information on the class features, see
- * <a href="../com.osp.cppappprogramming.help/html/guide/net/nfc.htm">NFC Guide</a>.
+ * <a href="../org.tizen.native.appprogramming/html/guide/net/nfc.htm">NFC Guide</a>.
*
*/
class _OSP_EXPORT_ NdefPushManager
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc.p2p
+ * @feature %http://tizen.org/feature/network.nfc
*
* @return An error code
- * @param[in] pListener An instance of %INdefPushManagerListener. @n
+ * @param[in] pListener An instance of INdefPushManagerListener. @n
* If it is null, it will reset the listener.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_UNSUPPORTED_OPERATION The device does not support the NFC feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * For more information, see
+ * <a href=”../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm”>
+ * Application Filtering</a>.
* @exception E_OPERATION_FAILED The operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc.p2p
+ * @feature %http://tizen.org/feature/network.nfc
*
* @return An error code
- * @param[in] message The NDEF message to be sent
+ * @param[in] message The NDEF message to send
* @exception E_SUCCESS The method is successful.
* @exception E_DEVICE_BUSY The device is processing preceding job.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* attached.
* @exception E_INVALID_ARG The input @c message is invalid. @n
* For example, it does not contain any NDEF records.
- * @exception E_UNSUPPORTED_OPERATION The device does not support the NFC feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * For more information, see
+ * <a href=”../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm”>
+ * Application Filtering</a>.
* @exception E_OPERATION_FAILED The operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks
*/
result Push(const NdefMessage& message);
* @since 2.1
* @privlevel platform
* @privilege %http://tizen.org/privilege/nfcmanager
+ * @feature %http://tizen.org/feature/network.nfc and %http://tizen.org/feature/network.nfc.reserved_push @n
+ * Both the features are required.
*
* @return An error code
* @exception E_SUCCESS The method is successful.
* operation. @n
* For example, Reserved Push is already activated.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_UNSUPPORTED_OPERATION The device does not support the NFC feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * For more information, see
+ * <a href=”../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm”>
+ * Application Filtering</a>.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @see <a href="../org.tizen.native.appprogramming/html/guide/net/nfc_reserved_push.htm">
* The NFC Reserved Push guide</a>
* @since 2.1
* @privlevel platform
* @privilege %http://tizen.org/privilege/nfcmanager
+ * @feature %http://tizen.org/feature/network.nfc and %http://tizen.org/feature/network.nfc.reserved_push @n
+ * Both the features are required.
*
* @return An error code
* @exception E_SUCCESS The method is successful.
* operation. @n
* For example, Reserved Push is already deactivated.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_UNSUPPORTED_OPERATION The device does not support the NFC feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * For more information, see
+ * <a href=”../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm”>
+ * Application Filtering</a>.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @see <a href="../org.tizen.native.appprogramming/html/guide/net/nfc_reserved_push.htm">
* The NFC Reserved Push guide</a>
* @since 2.1
* @privlevel platform
* @privilege %http://tizen.org/privilege/nfcmanager
+ * @feature %http://tizen.org/feature/network.nfc and %http://tizen.org/feature/network.nfc.reserved_push @n
+ * Both the features are required.
*
* @return An error code
* @param[in] packageId The package ID of the application which registered the NDEF message to push
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified @c packageId is not found in the Reserved Push candidate list.
- * @exception E_UNSUPPORTED_OPERATION The device does not support the NFC feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * For more information, see
+ * <a href=”../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm”>
+ * Application Filtering</a>.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @see <a href="../org.tizen.native.appprogramming/html/guide/net/nfc_reserved_push.htm">
* Gets the owner application ID of the picked NDEF message among all Reserved Push candidates.
*
* @since 2.1
+ * @feature %http://tizen.org/feature/network.nfc and %http://tizen.org/feature/network.nfc.reserved_push @n
+ * Both the features are required.
*
* @return The package ID of the application which is the owner of the picked Reserved Push message @n
* else an empty string if an error occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND There is no element in the Reserved Push candidate list.
- * @exception E_UNSUPPORTED_OPERATION The device does not support the NFC feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * For more information, see
+ * <a href=”../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm”>
+ * Application Filtering</a>.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @see <a href="../org.tizen.native.appprogramming/html/guide/net/nfc_reserved_push.htm">
* The NFC Reserved Push guide</a>
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc.p2p
+ * @feature %http://tizen.org/feature/network.nfc and %http://tizen.org/feature/network.nfc.reserved_push @n
+ * Both the features are required.
*
* @return An error code
- * @param[in] message The NDEF message to be registered
- * @param[in] description The description for the NDEF message to be registered @n
- * This description can be used in Reserved Push UI, for example, UI for
+ * @param[in] message The NDEF message to register
+ * @param[in] description The description for the NDEF message to register @n
+ * This description is used in Reserved Push UI, for example, UI for
* getting user consent to send the registered message.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The input @c message is invalid. @n
* For example, it does not contain any NDEF records.
- * @exception E_UNSUPPORTED_OPERATION The device does not support the NFC or the Reserved Push feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * For more information, see
+ * <a href=”../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm”>
+ * Application Filtering</a>.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @see <a href="../org.tizen.native.appprogramming/html/guide/net/nfc_reserved_push.htm">
* The NFC Reserved Push guide</a>
- * @remarks An application can register only one NDEF message. So the previously registered message will be
- * replaced by the new one.@n
- * The registered NDEF message can be selected to the Reserved Push message only by the user through
- * the Setting application.
+ * @remarks
+ * - An application can register only one NDEF message. So the previously registered message will be
+ * replaced by the new one.
+ * - The registered NDEF message is pushed only if it is selected by the user through the Setting
+ * application.
*/
static result RegisterNdefPushMessage(const NdefMessage& message, const Tizen::Base::String& description);
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc.p2p
+ * @feature %http://tizen.org/feature/network.nfc and %http://tizen.org/feature/network.nfc.reserved_push @n
+ * Both the features are required.
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_UNSUPPORTED_OPERATION The device does not support the NFC or the Reserved Push feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * For more information, see
+ * <a href=”../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm”>
+ * Application Filtering</a>.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @see <a href="../org.tizen.native.appprogramming/html/guide/net/nfc_reserved_push.htm">
private:
//
- // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying
- // of objects.
+ // The implementation of this copy constructor is intentionally blank to prohibit copying of objects.
//
NdefPushManager(const NdefPushManager& value);
//
- // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit
- // copying of objects.
+ // The implementation of this copy assignment operator is intentionally blank to prohibit copying of objects.
//
NdefPushManager& operator =(const NdefPushManager& value);
*
* @since 2.0
*
- * The %NdefRecord class represents an NDEF record, including certain attributes such as the type, the payload, and the payload
- * identifier. It provides the operations to manipulate them. However, this class does not expose all the attributes of
- * an NDEF record. Some attributes defined in the NDEF specification are hidden because they are not important for
- * applications. @n
+ * The %NdefRecord class represents an NDEF record, including certain attributes such as the type, the payload, and the
+ * payload identifier. It provides the operations to manipulate them. However, this class does not expose all the
+ * attributes of an NDEF record. Some attributes defined in the NDEF specification are hidden because they are not
+ * important for applications. @n
* The NDEF record may contain an NDEF message in the payload. It can be converted from a Tizen::Base::ByteBuffer
* instance to an NdefMessage instance through the NdefMessage::GetInstanceN() method.
*
Tizen::Base::String GetPayloadId(void) const;
/**
- * Gets the payload in this record as ByteBuffer.
+ * Gets the payload in this record as Tizen::Base::ByteBuffer.
*
* @since 2.0
*
* @since 2.0
*
* @return An error code
- * @param[in] type The record type to be set
+ * @param[in] type The record type to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The input argument is invalid. @n
* For example, NDEF_TNF_EMPTY is not allowed as the input value if the identifier
result SetPayload(const Tizen::Base::ByteBuffer& payload);
/**
- * Copying of objects using this copy assignment operator is allowed.
+ * Assigns the value of the specified instance to the current instance of %NdefRecord.
*
* @since 2.0
*
private:
//
- // This default constructor is intentionally declared as private because this class cannot be constructed.
+ // This default constructor is intentionally declared as private so that only the platform can create an instance.
//
NdefRecord(void);
* @if OSPDEPREC
* Defines the NDEF RTD Smart Poster type.
*
- * @brief <i> [Deprecated] </i>
- * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This object is provided only for backward compatibility and will be deleted in the near future.
* Use NFC_NDEF_RTD_SMART_POSTER instead of this object.
* @since 2.0
* @endif
_OSP_EXPORT_ extern const Tizen::Base::String NDEF_RTD_SMART_POSTER;
/**
-* Defines the NDEF RTD Smart Poster type. ("Sp")
-*
-* @since 2.0
-*/
+ * Defines the NDEF RTD Smart Poster type. ("Sp")
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t NFC_NDEF_RTD_SMART_POSTER[];
/**
* @if OSPDEPREC
* Defines the NDEF RTD %Text type.
*
- * @brief <i> [Deprecated] </i>
- * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This object is provided only for backward compatibility and will be deleted in the near future.
* Use NFC_NDEF_RTD_TEXT instead of this object.
* @since 2.0
* @endif
_OSP_EXPORT_ extern const Tizen::Base::String NDEF_RTD_TEXT;
/**
-* Defines the NDEF RTD %Text type. ("T")
-*
-* @since 2.0
-*/
+ * Defines the NDEF RTD %Text type. ("T")
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t NFC_NDEF_RTD_TEXT[];
/**
* @if OSPDEPREC
* Defines the NDEF RTD URI type.
*
- * @brief <i> [Deprecated] </i>
- * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This object is provided only for backward compatibility and will be deleted in the near future.
* Use NFC_NDEF_RTD_URI instead of this object.
* @since 2.0
* @endif
_OSP_EXPORT_ extern const Tizen::Base::String NDEF_RTD_URI;
/**
-* Defines the NDEF RTD URI type. ("U")
-*
-* @since 2.0
-*/
+ * Defines the NDEF RTD URI type. ("U")
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t NFC_NDEF_RTD_URI[];
/**
*
* @since 2.0
*
- * The %NdefRecordType class represents the type of an NDEF record. It encapsulates the name and the name format of the NDEF record
- * type. @n
- * The name format is represented by the enumeration type, Tizen::Net::Nfc::NdefRecordTypeNameFormat. The name is encoded
- * using the US_ASCII character set and follows the rules defined by the NFC forum RTDs and RFCs. The name does not
- * include the prefix @c "urn:nfc:wkt:" and @c "urn:nfc:ext:" defined by the NFC forum.
+ * The %NdefRecordType class represents the type of an NDEF record. It encapsulates the name and the name format of the
+ * NDEF record type. @n
+ * The name format is represented by the enumeration type, Tizen::Net::Nfc::NdefRecordTypeNameFormat. The name is
+ * encoded using the US_ASCII character set and follows the rules defined by the NFC forum RTDs and RFCs. The name does
+ * not include the prefix @c "urn:nfc:wkt:" and @c "urn:nfc:ext:" defined by the NFC forum.
*
* For more information on the class features, see
* <a href="../org.tizen.native.appprogramming/html/guide/net/nfc.htm">NFC Guide</a>.
*
* @return @c true if the values match, @n
* else @c false
- * @param[in] obj The Object to be compared
+ * @param[in] obj The Object to compare
* @remarks The method returns @c false if the specified object is not an %NdefRecordType instance. @n
* Additionally, the comparison rules for the record type name are different depending on the Type
* Name Format (TNF) value, as follows: @n
*
* @return The name of this record type, @n
* else an empty string if the name format is NDEF_TNF_EMPTY or NDEF_TNF_UNKNOWN
- * @remarks The returned name does not have the prefix @c "urn:nfc:wkt:" and @c "urn:nfc:ext:" defined by the
- * NFC forum.
- * In case of NDEF_TNF_ABSOLUTE_URI name format, this method returns the name in the same format as it
- * is given in the constructor, that is, with or without percent encoding. The name consists of the
- * characters encoded using the US_ASCII character set.
+ * @remarks
+ * - The returned name does not have the prefix @c "urn:nfc:wkt:" and @c "urn:nfc:ext:" defined by the
+ * NFC forum.
+ * - In case of NDEF_TNF_ABSOLUTE_URI name format, this method returns the name in the same format as
+ * it is given in the constructor, that is, with or without percent encoding. The name consists of
+ * the characters encoded using the US_ASCII character set.
*/
Tizen::Base::String GetName(void) const;
*
* @since 2.0
*
- * The %NdefTagConnection class provides the mechanism to communicate with the tag that has NFC Data Exchange Format (NDEF) data and
- * supports the NDEF message operations. @n
+ * The %NdefTagConnection class provides the mechanism to communicate with the tag that has NFC Data Exchange Format
+ * (NDEF) data and supports the NDEF message operations. @n
* This class can be derived from the TagConnection class. Use the IsNdefConnection() method to check the availability
* of the derivation. @n
* Use the Read() and Write() methods to read and write the NDEF data. After the completion of the read and write
* @since 2.0
*
* @return An error code
- * @param[in] pListener The listener to be added
+ * @param[in] pListener The listener to add
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @remarks At the most, one event listener can be registered. If the input parameter is @c null, the listener
* @since 2.0
*
* @return An error code
- * @param[in] message The NDEF message to be written to the target
+ * @param[in] message The NDEF message to write to the target
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The input @c message is invalid. @n
* For example, it does not contain any NDEF records.
private:
//
- // This default constructor is intentionally declared as private because this class cannot be constructed.
+ // This default constructor is intentionally declared as private so that only the platform can create an instance.
//
NdefTagConnection(void);
//
- // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying
- // of objects.
+ // The implementation of this copy constructor is intentionally blank to prohibit copying of objects.
//
NdefTagConnection(const NdefTagConnection& value);
//
- // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit
- // copying of objects.
+ // The implementation of this copy assignment operator is intentionally blank to prohibit copying of objects.
//
NdefTagConnection& operator =(const NdefTagConnection& value);
*
* @since 2.0
*
- * The %NfcManager class is the manager class for NFC features that includes the methods for enabling and disabling the NFC feature of
- * the device and the mechanism for establishing a connection with the detected tag. It is also used to detect the NFC
- * tags and NDEF messages. @n
+ * The %NfcManager class is the manager class for NFC features that includes the methods for enabling and disabling the
+ * NFC feature of the device and the mechanism for establishing a connection with the detected tag. It is also used to
+ * detect the NFC tags and NDEF messages. @n
* There are two ways to get the TagConnection instance established with the detected tag. @n
* @li Use the INfcTagDiscoveryEventListener::OnNfcTagDetectedN() method that is invoked immediately when the target
* tag is detected.
* Initializes this instance of %NfcManager with the specified listener.
*
* @since 2.0
+ * @feature %http://tizen.org/feature/network.nfc
*
* @return An error code
- * @param[in] listener The %INfcManagerEventListener instance to be added
+ * @param[in] listener The INfcManagerEventListener instance to add
* @exception E_SUCCESS The method is successful.
- * @exception E_UNSUPPORTED_OPERATION The device does not support the NFC feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * For more information, see
+ * <a href=”../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm”>
+ * Application Filtering</a>.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
*/
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The NdefTagConnection class can inherit the TagConnection class if the currently detected tag
- * supports the NDEF operations. To check whether the TagConnection class is inherited, use the
- * TagConnection::IsNdefConnection() method.
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - The NdefTagConnection class can inherit the TagConnection class if the currently detected tag
+ * supports the NDEF operations. To check whether the %TagConnection class is inherited, use the
+ * TagConnection::IsNdefConnection() method.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
TagConnection* GetCurrentTagConnectionN(void) const;
* @privilege %http://tizen.org/privilege/nfc.tag
*
* @return An error code
- * @param[in] listener The listener to be added
+ * @param[in] listener The listener to add
* @param[in] type The tag type for which the listener is added
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_ALREADY_EXIST The listener with the specified type is already added.
* @privilege %http://tizen.org/privilege/nfc.tag
*
* @return An error code
- * @param[in] listener The listener to be removed
+ * @param[in] listener The listener to remove
* @param[in] type The tag type for which the listener is removed
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The listener with the specified type is not found.
* @privilege %http://tizen.org/privilege/nfc.common
*
* @return An error code
- * @param[in] listener The listener to be added
+ * @param[in] listener The listener to add
* @param[in] type The type of the NDEF record for which the listener is added
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c type is invalid. @n
* @exception E_OBJ_ALREADY_EXIST The listener with the specified type is already added.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SYSTEM A system error has occurred.
- * @remarks This method can be invoked several times with different NdefRecordType values for the same listener
- * instance. In this case, the listener is called if the record type in the detected NDEF records
- * matches with one of the registered types.
- * In case of the MIME %Media type as Type Name Format (TNF), asterisks can be used in the type name
- * for wildcard matching, such as @htmlonly "image/*" @endhtmlonly.
+ * @remarks - This method can be invoked several times with different NdefRecordType values for the same
+ * listener instance. In this case, the listener is called if the record type in the detected NDEF
+ * records matches with one of the registered types.
+ * - In case of the MIME %Media type as Type Name Format (TNF), asterisks can be used in the type name
+ * for wildcard matching, such as @htmlonly "image/*" @endhtmlonly.
*/
result AddNdefMessageDiscoveryEventListener(INdefMessageDiscoveryEventListener& listener, const NdefRecordType& type);
* @privilege %http://tizen.org/privilege/nfc.common
*
* @return An error code
- * @param[in] listener The listener to be removed
+ * @param[in] listener The listener to remove
* @param[in] type The type of the NDEF record for which the listener is removed
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c type is invalid. @n
* @privilege %http://tizen.org/privilege/nfc.p2p
*
* @return An error code
- * @param[in] listener The listener to be added
+ * @param[in] listener The listener to add
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_ALREADY_EXIST The listener was already added.
+ * @exception E_OBJ_ALREADY_EXIST The listener is already added.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SYSTEM A system error has occurred.
* @privilege %http://tizen.org/privilege/nfc.p2p
*
* @return An error code
- * @param[in] listener The listener to be removed
+ * @param[in] listener The listener to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The listener was not found.
+ * @exception E_OBJ_NOT_FOUND The listener is not found.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SYSTEM A system error has occurred.
*/
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc.common
+ * @feature %http://tizen.org/feature/network.nfc
*
* @return The cached %NdefMessage instance, @n
* else @c null if the method is not successful
* @exception E_SUCCESS The method is successful.
- * @exception E_UNSUPPORTED_OPERATION The device does not support the NFC feature..
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * For more information, see
+ * <a href=”../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm”>
+ * Application Filtering</a>.
* @exception E_ILLEGAL_ACCESS This operation is not allowed because the application is not launched by
* Conditional %App Launch.
* @exception E_INVALID_FORMAT The cached data cannot be converted to the NDEF message.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SYSTEM A system error has occurred.
- * @remarks This method is available only to the application that is launched by Conditional %App Launch until
- * the application is terminated or another tag is detected.
- * The input NdefMessage instance should be deleted by the application after it is used, even outside
- * this method. The NdefMessage::RemoveAllRecords() method should be called with @c true as the input
- * value immediately before the NdefMessage instance is deleted.
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - This method is available only to the application that is launched by Conditional %App Launch
+ * until the application is terminated or another tag is detected.
+ * - The input NdefMessage instance should be deleted by the application after it is used, even
+ * outside this method. The NdefMessage::RemoveAllRecords() method should be called with @c true as
+ * the input value immediately before the NdefMessage instance is deleted.
+ * - The specific error code can be accessed using the GetLastResult() method.
* @see <a href="../org.tizen.native.appprogramming/html/guide/net/conditional_nfc_app_launch.htm">
* The Conditional NFC App Launch guide</a>
* @see Tizen::App::AppManager::RegisterAppLaunch
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc.common
+ * @feature %http://tizen.org/feature/network.nfc
*
* @return An error code
* @param[in] enable Set to @c true to enable the Conditional NFC %App Launch pop-up, @n
* else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_UNSUPPORTED_OPERATION The device does not support the NFC feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * For more information, see
+ * <a href=”../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm”>
+ * Application Filtering</a>.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SYSTEM A system error has occurred.
* @remarks Note that this method is used to enable or disable the launch pop-up when the application is in the
private:
//
- // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying
- // of objects.
+ // The implementation of this copy constructor is intentionally blank to prohibit copying of objects.
//
NfcManager(const NfcManager& value);
//
- // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit
- // copying of objects.
+ // The implementation of this copy assignment operator is intentionally blank to prohibit copying of objects.
//
NfcManager& operator =(const NfcManager& value);
*
* @return @c true if the tag has the specified tag type, @n
* else @c false
- * @param[in] type The tag type to be checked
+ * @param[in] type The tag type to check
*/
bool HasTagType(NfcTagType type) const;
private:
//
- // This default constructor is intentionally declared as private because this class cannot be constructed.
+ // This default constructor is intentionally declared as private so that only the platform can create an instance.
//
NfcTag(void);
//
- // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying
- // of objects.
+ // The implementation of this copy constructor is intentionally blank to prohibit copying of objects.
//
NfcTag(const NfcTag& value);
//
- // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit
- // copying of objects.
+ // The implementation of this copy assignment operator is intentionally blank to prohibit copying of objects.
//
NfcTag& operator =(const NfcTag& value);
*
* @since 2.0
*
- * The %TagConnection class represents the connection with an NFC tag. It provides the mechanism to communicate with the NFC tag
- * through ISO14443 or a general Radio Frequency Identification (RFID) manner. @n
+ * The %TagConnection class represents the connection with an NFC tag. It provides the mechanism to communicate with
+ * the NFC tag through ISO14443 or a general Radio Frequency Identification (RFID) manner. @n
* The class has an NfcTag instance that represents the target tag. This class can be inherited by the
* NdefTagConnection class if the target tag supports the NFC Data Exchange Format (NDEF) operations.
*
* @since 2.0
*
* @return An error code
- * @param[in] pListener The listener to be added
+ * @param[in] pListener The listener to add
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @remarks Only one event listener can be registered. If the input parameter is @c null, the listener that is
* @since 2.0
*
* @return An error code
- * @param[in] command The command to be sent
+ * @param[in] command The command to send
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The input @c command is invalid.
* @exception E_IN_PROGRESS The previous send request is in progress.
private:
//
- // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying
- // of objects.
+ // The implementation of this copy constructor is intentionally blank to prohibit copying of objects.
//
TagConnection(const TagConnection& value);
//
- // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit
- // copying of objects.
+ // The implementation of this copy assignment operator is intentionally blank to prohibit copying of objects.
//
TagConnection& operator =(const TagConnection& value);
projects / framework / osp / nfc.git / commitdiff