|
Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
|
Message Access Profile (MAP). More...
Topics | |
| Messaging Client Equipment(MCE) OBEX Client | |
| Messaging Client Equipment(MCE) OBEX Client. | |
| Messaging Client Equipment(MCE) OBEX Server | |
| Messaging Client Equipment(MCE) OBEX Server. | |
| Messaging Server Equipment(MSE) OBEX Client | |
| Messaging Server Equipment(MSE) OBEX Client. | |
| Messaging Server Equipment(MSE) OBEX Server | |
| Messaging Server Equipment(MSE) OBEX Server. | |
Macros | |
| #define | BT_MAP_MANDATORY_SUPPORTED_FEATURES (0x0000001FU) |
| MAP mandatory supported features bitmask. | |
| #define | BT_MAP_UUID_MAS |
| MAP Message Access Server (MAS) UUID. | |
| #define | BT_MAP_UUID_MNS |
| MAP Message Notification Server (MNS) UUID. | |
| #define | BT_MAP_FILLER_BYTE "0" |
| Filler byte for padding. | |
| #define | BT_MAP_HDR_TYPE_SEND_EVENT "x-bt/MAP-event-report" |
| Type header for send event operation. | |
| #define | BT_MAP_HDR_TYPE_SET_NTF_REG "x-bt/MAP-NotificationRegistration" |
| Type header for set notification registration operation. | |
| #define | BT_MAP_HDR_TYPE_GET_FOLDER_LISTING "x-obex/folder-listing" |
| Type header for get folder listing operation. | |
| #define | BT_MAP_HDR_TYPE_GET_MSG_LISTING "x-bt/MAP-msg-listing" |
| Type header for get message listing operation. | |
| #define | BT_MAP_HDR_TYPE_GET_MSG "x-bt/message" |
| Type header for get message operation. | |
| #define | BT_MAP_HDR_TYPE_SET_MSG_STATUS "x-bt/messageStatus" |
| Type header for set message status operation. | |
| #define | BT_MAP_HDR_TYPE_PUSH_MSG "x-bt/message" |
| Type header for push message operation. | |
| #define | BT_MAP_HDR_TYPE_UPDATE_INBOX "x-bt/MAP-messageUpdate" |
| Type header for update inbox operation. | |
| #define | BT_MAP_HDR_TYPE_GET_MAS_INST_INFO "x-bt/MASInstanceInformation" |
| Type header for get MAS instance info operation. | |
| #define | BT_MAP_HDR_TYPE_SET_OWNER_STATUS "x-bt/ownerStatus" |
| Type header for set owner status operation. | |
| #define | BT_MAP_HDR_TYPE_GET_OWNER_STATUS "x-bt/ownerStatus" |
| Type header for get owner status operation. | |
| #define | BT_MAP_HDR_TYPE_GET_CONVO_LISTING "x-bt/MAP-convo-listing" |
| Type header for get conversation listing operation. | |
| #define | BT_MAP_HDR_TYPE_SET_NTF_FILTER "x-bt/MAP-notification-filter" |
| Type header for set notification filter operation. | |
Message Access Profile (MAP).
| #define BT_MAP_FILLER_BYTE "0" |
#include <zephyr/bluetooth/classic/map.h>
Filler byte for padding.
Single byte used as padding in MAP operations where a body is required but no actual data needs to be transmitted.
| #define BT_MAP_HDR_TYPE_GET_CONVO_LISTING "x-bt/MAP-convo-listing" |
#include <zephyr/bluetooth/classic/map.h>
Type header for get conversation listing operation.
| #define BT_MAP_HDR_TYPE_GET_FOLDER_LISTING "x-obex/folder-listing" |
#include <zephyr/bluetooth/classic/map.h>
Type header for get folder listing operation.
| #define BT_MAP_HDR_TYPE_GET_MAS_INST_INFO "x-bt/MASInstanceInformation" |
#include <zephyr/bluetooth/classic/map.h>
Type header for get MAS instance info operation.
| #define BT_MAP_HDR_TYPE_GET_MSG "x-bt/message" |
#include <zephyr/bluetooth/classic/map.h>
Type header for get message operation.
| #define BT_MAP_HDR_TYPE_GET_MSG_LISTING "x-bt/MAP-msg-listing" |
#include <zephyr/bluetooth/classic/map.h>
Type header for get message listing operation.
| #define BT_MAP_HDR_TYPE_GET_OWNER_STATUS "x-bt/ownerStatus" |
#include <zephyr/bluetooth/classic/map.h>
Type header for get owner status operation.
| #define BT_MAP_HDR_TYPE_PUSH_MSG "x-bt/message" |
#include <zephyr/bluetooth/classic/map.h>
Type header for push message operation.
| #define BT_MAP_HDR_TYPE_SEND_EVENT "x-bt/MAP-event-report" |
#include <zephyr/bluetooth/classic/map.h>
Type header for send event operation.
| #define BT_MAP_HDR_TYPE_SET_MSG_STATUS "x-bt/messageStatus" |
#include <zephyr/bluetooth/classic/map.h>
Type header for set message status operation.
| #define BT_MAP_HDR_TYPE_SET_NTF_FILTER "x-bt/MAP-notification-filter" |
#include <zephyr/bluetooth/classic/map.h>
Type header for set notification filter operation.
| #define BT_MAP_HDR_TYPE_SET_NTF_REG "x-bt/MAP-NotificationRegistration" |
#include <zephyr/bluetooth/classic/map.h>
Type header for set notification registration operation.
| #define BT_MAP_HDR_TYPE_SET_OWNER_STATUS "x-bt/ownerStatus" |
#include <zephyr/bluetooth/classic/map.h>
Type header for set owner status operation.
| #define BT_MAP_HDR_TYPE_UPDATE_INBOX "x-bt/MAP-messageUpdate" |
#include <zephyr/bluetooth/classic/map.h>
Type header for update inbox operation.
| #define BT_MAP_MANDATORY_SUPPORTED_FEATURES (0x0000001FU) |
#include <zephyr/bluetooth/classic/map.h>
MAP mandatory supported features bitmask.
Minimum set of features that must be supported by all MAP implementations. Includes notification registration, notification, browsing, uploading, and delete features.
| #define BT_MAP_UUID_MAS |
#include <zephyr/bluetooth/classic/map.h>
MAP Message Access Server (MAS) UUID.
128-bit UUID for the Message Access Server service. Used to identify MAS service in OBEX connections.
| #define BT_MAP_UUID_MNS |
#include <zephyr/bluetooth/classic/map.h>
MAP Message Notification Server (MNS) UUID.
128-bit UUID for the Message Notification Server service. Used to identify MNS service in OBEX connections.
#include <zephyr/bluetooth/classic/map.h>
MAP application parameter tag identifiers.
Tag IDs for application parameters used in MAP operations. These are used in OBEX Application Parameters header to pass operation-specific data.
| Enumerator | |
|---|---|
| BT_MAP_APPL_PARAM_TAG_ID_MAX_LIST_CNT | Maximum list count (2 bytes). |
| BT_MAP_APPL_PARAM_TAG_ID_LIST_START_OFFSET | List start offset (2 bytes). |
| BT_MAP_APPL_PARAM_TAG_ID_FILTER_MSG_TYPE | Filter message type (1 byte) bt_map_filter_msg_type. |
| BT_MAP_APPL_PARAM_TAG_ID_FILTER_PERIOD_BEGIN | Filter period begin (variable length). |
| BT_MAP_APPL_PARAM_TAG_ID_FILTER_PERIOD_END | Filter period end (variable length). |
| BT_MAP_APPL_PARAM_TAG_ID_FILTER_READ_STATUS | Filter read status (1 byte) bt_map_filter_read_status. |
| BT_MAP_APPL_PARAM_TAG_ID_FILTER_RECIPIENT | Filter recipient (variable length). |
| BT_MAP_APPL_PARAM_TAG_ID_FILTER_ORIGINATOR | Filter originator (variable length). |
| BT_MAP_APPL_PARAM_TAG_ID_FILTER_PRIORITY | Filter priority (1 byte) bt_map_filter_priority. |
| BT_MAP_APPL_PARAM_TAG_ID_ATTACHMENT | Attachment (1 byte) bt_map_attachment. |
| BT_MAP_APPL_PARAM_TAG_ID_TRANSPARENT | Transparent (1 byte) bt_map_transparent. |
| BT_MAP_APPL_PARAM_TAG_ID_RETRY | Retry (1 byte) bt_map_retry. |
| BT_MAP_APPL_PARAM_TAG_ID_NEW_MSG | New message (1 byte) bt_map_new_msg. |
| BT_MAP_APPL_PARAM_TAG_ID_NTF_STATUS | Notification status (1 byte) bt_map_ntf_status. |
| BT_MAP_APPL_PARAM_TAG_ID_MAS_INST_ID | MAS instance ID (1 byte). |
| BT_MAP_APPL_PARAM_TAG_ID_PARAM_MASK | Parameter mask (4 bytes) bt_map_param_mask. |
| BT_MAP_APPL_PARAM_TAG_ID_FOLDER_LISTING_SIZE | Folder listing size (2 bytes). |
| BT_MAP_APPL_PARAM_TAG_ID_LISTING_SIZE | Listing size (2 bytes). |
| BT_MAP_APPL_PARAM_TAG_ID_SUBJECT_LEN | Subject length (variable, max 255 bytes). |
| BT_MAP_APPL_PARAM_TAG_ID_CHARSET | Charset (1 byte) bt_map_charset. |
| BT_MAP_APPL_PARAM_TAG_ID_FRACTION_REQUEST | Fraction request (1 byte) bt_map_fraction_request. |
| BT_MAP_APPL_PARAM_TAG_ID_FRACTION_DELIVER | Fraction deliver (1 byte) bt_map_fraction_deliver. |
| BT_MAP_APPL_PARAM_TAG_ID_STATUS_IND | Status indicator (1 byte) bt_map_status_ind. |
| BT_MAP_APPL_PARAM_TAG_ID_STATUS_VAL | Status value (1 byte) bt_map_status_val. |
| BT_MAP_APPL_PARAM_TAG_ID_MSE_TIME | MSE time (variable length). |
| BT_MAP_APPL_PARAM_TAG_ID_DB_ID | Database identifier (variable, max 32 bytes). |
| BT_MAP_APPL_PARAM_TAG_ID_CONVO_LISTING_VER_CNTR | Conversation listing version counter (variable, max 32 bytes). |
| BT_MAP_APPL_PARAM_TAG_ID_PRESENCE_AVAIL | Presence availability (1 byte) bt_map_presence. |
| BT_MAP_APPL_PARAM_TAG_ID_PRESENCE_TEXT | Presence text (variable length). |
| BT_MAP_APPL_PARAM_TAG_ID_LAST_ACTIVITY | Last activity (variable length). |
| BT_MAP_APPL_PARAM_TAG_ID_FILTER_LAST_ACTIVITY_BEGIN | Filter last activity begin (variable length). |
| BT_MAP_APPL_PARAM_TAG_ID_FILTER_LAST_ACTIVITY_END | Filter last activity end (variable length). |
| BT_MAP_APPL_PARAM_TAG_ID_CHAT_STATE | Chat state (1 byte) bt_map_chat_state. |
| BT_MAP_APPL_PARAM_TAG_ID_CONVO_ID | Conversation ID (variable, max 32 bytes). |
| BT_MAP_APPL_PARAM_TAG_ID_FOLDER_VER_CNTR | Folder version counter (variable, max 32 bytes). |
| BT_MAP_APPL_PARAM_TAG_ID_FILTER_MSG_HANDLE | Filter message handle (variable, max 16 bytes). |
| BT_MAP_APPL_PARAM_TAG_ID_NTF_FILTER_MASK | Notification filter mask (4 bytes) bt_map_ntf_filter_mask. |
| BT_MAP_APPL_PARAM_TAG_ID_CONVO_PARAM_MASK | Conversation parameter mask (4 bytes) bt_map_convo_param_mask. |
| BT_MAP_APPL_PARAM_TAG_ID_OWNER_UCI | Owner UCI (variable length). |
| BT_MAP_APPL_PARAM_TAG_ID_EXT_DATA | Extended data (variable length) bt_map_msg_ext_data. |
| BT_MAP_APPL_PARAM_TAG_ID_MAP_SUPPORTED_FEATURES | MAP supported features (4 bytes) bt_map_supported_features. |
| BT_MAP_APPL_PARAM_TAG_ID_MSG_HANDLE | Message handle (variable, max 16 bytes). |
| BT_MAP_APPL_PARAM_TAG_ID_MODIFY_TEXT | Modify text (1 byte) bt_map_modify_text. |
| enum bt_map_attachment |
#include <zephyr/bluetooth/classic/map.h>
MAP attachment values.
Indicates whether to include attachments.
| Enumerator | |
|---|---|
| BT_MAP_ATTACHMENT_OFF | Off - no attachments. |
| BT_MAP_ATTACHMENT_ON | On - include attachments. |
| enum bt_map_charset |
#include <zephyr/bluetooth/classic/map.h>
MAP charset values.
Character set for message content.
| Enumerator | |
|---|---|
| BT_MAP_CHARSET_NATIVE | Native charset. |
| BT_MAP_CHARSET_UTF8 | UTF-8 charset. |
| enum bt_map_chat_state |
#include <zephyr/bluetooth/classic/map.h>
MAP chat states.
Enumeration of possible chat states for the message owner.
#include <zephyr/bluetooth/classic/map.h>
MAP conversation parameter mask bits.
Bitmask for selecting which conversation attributes to include.
#include <zephyr/bluetooth/classic/map.h>
MAP filter message type values.
Bitmask for filtering messages by type.
#include <zephyr/bluetooth/classic/map.h>
MAP filter priority values.
Filter for message priority.
| Enumerator | |
|---|---|
| BT_MAP_FILTER_PRIORITY_NO_FILTERING | No filtering. |
| BT_MAP_FILTER_PRIORITY_HIGH | High priority messages only. |
| BT_MAP_FILTER_PRIORITY_NON_HIGH | Non-high priority messages only. |
#include <zephyr/bluetooth/classic/map.h>
MAP filter read status values.
Filter for read/unread messages.
| Enumerator | |
|---|---|
| BT_MAP_FILTER_READ_STATUS_NO_FILTERING | No filtering. |
| BT_MAP_FILTER_READ_STATUS_UNREAD | Unread messages only. |
| BT_MAP_FILTER_READ_STATUS_READ | Read messages only. |
#include <zephyr/bluetooth/classic/map.h>
MAP fraction deliver values.
Fraction of message delivered.
| Enumerator | |
|---|---|
| BT_MAP_FRACTION_DELIVER_MORE | More fractions to follow. |
| BT_MAP_FRACTION_DELIVER_LAST | Last fraction. |
#include <zephyr/bluetooth/classic/map.h>
MAP fraction request values.
Fraction of message to request.
| Enumerator | |
|---|---|
| BT_MAP_FRACTION_REQUEST_FIRST | First fraction. |
| BT_MAP_FRACTION_REQUEST_NEXT | Next fraction. |
| enum bt_map_modify_text |
#include <zephyr/bluetooth/classic/map.h>
MAP modify text values.
Indicates how message text is modified.
| Enumerator | |
|---|---|
| BT_MAP_MODIFY_TEXT_REPLACE | Replace text. |
| BT_MAP_MODIFY_TEXT_PREPEND | Prepend text. |
| enum bt_map_msg_ext_data |
#include <zephyr/bluetooth/classic/map.h>
MAP message extended data types.
Types of extended metadata that can be associated with messages.
| enum bt_map_new_msg |
#include <zephyr/bluetooth/classic/map.h>
MAP new message values.
Indicates whether a message is new.
| Enumerator | |
|---|---|
| BT_MAP_NEW_MSG_OFF | Not a new message. |
| BT_MAP_NEW_MSG_ON | New message. |
#include <zephyr/bluetooth/classic/map.h>
MAP notification filter mask bits.
Bitmask for filtering which event types to receive notifications for.
| enum bt_map_ntf_status |
#include <zephyr/bluetooth/classic/map.h>
MAP notification status values.
Status for notification registration.
| Enumerator | |
|---|---|
| BT_MAP_NTF_STATUS_OFF | Notifications off. |
| BT_MAP_NTF_STATUS_ON | Notifications on. |
| enum bt_map_param_mask |
#include <zephyr/bluetooth/classic/map.h>
MAP parameter mask bits.
Bitmask for selecting which message attributes to include.
| enum bt_map_presence |
#include <zephyr/bluetooth/classic/map.h>
MAP presence availability states.
Enumeration of possible presence states for the message owner.
| enum bt_map_retry |
#include <zephyr/bluetooth/classic/map.h>
MAP retry values.
Indicates whether to retry sending.
| Enumerator | |
|---|---|
| BT_MAP_RETRY_OFF | Off - no retry. |
| BT_MAP_RETRY_ON | On - retry. |
#include <zephyr/bluetooth/classic/map.h>
MAP set folder operation flags.
Flags controlling folder navigation behavior in SetFolder operations.
| Enumerator | |
|---|---|
| BT_MAP_SET_FOLDER_FLAGS_ROOT | Navigate to root folder. |
| BT_MAP_SET_FOLDER_FLAGS_DOWN | Navigate down to child folder. |
| BT_MAP_SET_FOLDER_FLAGS_UP | Navigate up to parent folder. |
| enum bt_map_status_ind |
#include <zephyr/bluetooth/classic/map.h>
MAP status indicator values.
Type of status to modify.
| Enumerator | |
|---|---|
| BT_MAP_STATUS_IND_READ | Read status. |
| BT_MAP_STATUS_IND_DELETED | Deleted status. |
| BT_MAP_STATUS_IND_EXTENDED_DATA | Set extended data. |
| enum bt_map_status_val |
#include <zephyr/bluetooth/classic/map.h>
MAP status value values.
New status value.
| Enumerator | |
|---|---|
| BT_MAP_STATUS_VAL_NO | No/Off. |
| BT_MAP_STATUS_VAL_YES | Yes/On. |
#include <zephyr/bluetooth/classic/map.h>
MAP supported features.
Feature flags indicating optional MAP capabilities. These are exchanged during SDP discovery or MAP connection establishment.
#include <zephyr/bluetooth/classic/map.h>
MAP supported message types.
Bitmask indicating which message types are supported by a MAS instance.
| enum bt_map_transparent |
#include <zephyr/bluetooth/classic/map.h>
MAP transparent values.
Indicates whether to use transparent mode.
| Enumerator | |
|---|---|
| BT_MAP_TRANSPARENT_OFF | Off - not transparent. |
| BT_MAP_TRANSPARENT_ON | On - transparent. |