Skip to content

Commit d0fe50e

Browse files
author
Amanda Butler
authored
Create MessageBuilder.md
Move MessageBuilder class reference to its own page.
1 parent 5826d79 commit d0fe50e

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

docs/api/nfc/MessageBuilder.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## MessageBuilder
2+
3+
Mbed OS provides this API to construct NDEF messages, the common data format exchange for NFC messages. The class `mbed::nfc::ndef::MessageBuilder` builds an NDEF message into a user-provided buffer. `URI`, `Text` and `Mime` types can be serialized in the builder with the help of the member function `append_as_record`.
4+
5+
### MessageBuilder class reference
6+
7+
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/classmbed_1_1nfc_1_1ndef_1_1_message_builder.html)
8+
9+
### MessageBuilder example
10+
11+
```
12+
#include "nfc/ndef/MessageBuilder.h"
13+
14+
using mbed::nfc::ndef::MessageBuilder;
15+
using mbed::nfc::ndef::common::Text;
16+
using mbed::nfc::ndef::common::URI;
17+
18+
size_t build_ndef_message(const Span<uint8_t> &buffer) {
19+
MessageBuilder builder(buffer);
20+
21+
URI uri(URI::HTTPS_WWW, span_from_cstr("mbed.com"));
22+
Text text(Text::UTF8, span_from_cstr("en-US"), span_from_cstr("Mbed website"));
23+
24+
uri.append_as_record(builder);
25+
text.append_as_record(builder, /* last record */ true);
26+
27+
return builder.get_message().size();
28+
}
29+
```
30+
31+
### Related content
32+
33+
- [MessageParser](messageparser.html) API reference.
34+
- [SimpleMessageParser](simplemessageparser.html) API reference.
35+
- [NFC architecture](/docs/development/reference/nfc-technology.html).

0 commit comments

Comments
 (0)