Public Types

Public Member Functions
	SmartPoster (const URI &uri)
	Construct a smart poster. More...

void	set_title (const Text &text)
	Set the title of the resource. More...

void	set_icon (const Mime &icon)
	Set the icon of the resource. More...

void	set_action (action_t action)
	Set the action to trigger upon smart poster reception. More...

void	set_resource_size (uint32_t size)
	Set the size of the resource. More...

void	set_resource_type (mbed::Span< const uint8_t > &resource_type)
	Set the type of the resource. More...

bool	append_record (MessageBuilder &ndef_builder, bool is_last_record) const
	Append the smart poster as a ndef record. More...

Detailed Description

Smart poster object.

A smart poster is one of the basic use case of NFC. It encapsulates a URI to a resource and meta-data of the resource.

Meta-data are optional, they can be:

title: name of the resource
icon: image/media associated to the resource
action: Action the peer should execute upon reception of the smart poster
size: The size of the resource.
type: Mime type of the resource.

Note: It obeys to value semantic and can be copied around.

Definition at line 39 of file SmartPoster.h.

Member Enumeration Documentation

enum action_t

Type of actions that should be executed upon smart poster reception.

Enumerator
EXECUTE	EXECUTE.
SAVE	SAVE.
EDIT	EDIT.

Definition at line 49 of file SmartPoster.h.

Constructor & Destructor Documentation

SmartPoster ( const URI & uri )

Construct a smart poster.

Parameters

uri	The URI to the resource.

Member Function Documentation

bool append_record	(	MessageBuilder &	ndef_builder,
		bool	is_last_record
	)		const

Append the smart poster as a ndef record.

Parameters

ndef_builder	The message builder where the record is appended.
is_last_record	Indicates if this message is the last one.

Returns: true if the message has been appended to the builder or false otherwise.

void set_action ( action_t action )

Set the action to trigger upon smart poster reception.

Parameters

action The action to do upon reception.

void set_icon ( const Mime & icon )

Set the icon of the resource.

Parameters

icon	The icon to set.

void set_resource_size ( uint32_t size )

Set the size of the resource.

Parameters

size	The size of the resource.

void set_resource_type ( mbed::Span< const uint8_t > & resource_type )

Set the type of the resource.

Parameters

resource_type The type of the resource pointed by the URI.

void set_title ( const Text & text )

Set the title of the resource.

Parameters

text	The title of the resource to set.

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Important Information for this Arm website