Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
Message Access Profile (MAP)

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.

Enumerations

enum  bt_map_supported_features {
  BT_MAP_NTF_REG_FEATURE = BIT(0) , BT_MAP_NTF_FEATURE = BIT(1) , BT_MAP_BROWSING_FEATURE = BIT(2) , BT_MAP_UPLOADING_FEATURE = BIT(3) ,
  BT_MAP_DELETE_FEATURE = BIT(4) , BT_MAP_INST_INFO_FEATURE = BIT(5) , BT_MAP_EXT_EVENT_REPORT_V11 = BIT(6) , BT_MAP_EXT_EVENT_REPORT_V12 = BIT(7) ,
  BT_MAP_MSG_FORMAT_V11 = BIT(8) , BT_MAP_MSG_LISTING_FORMAT_V11 = BIT(9) , BT_MAP_PERSISTENT_MSG_HANDLE = BIT(10) , BT_MAP_DB_ID = BIT(11) ,
  BT_MAP_FOLDER_VER_CNTR = BIT(12) , BT_MAP_CONVO_VER_CNTR = BIT(13) , BT_MAP_PARTICIPANT_PRESENCE_CHANGE_NTF = BIT(14) , BT_MAP_PARTICIPANT_CHAT_STATE_CHANGE_NTF = BIT(15) ,
  BT_MAP_PBAP_CONTACT_XREF = BIT(16) , BT_MAP_NTF_FILTERING = BIT(17) , BT_MAP_UTC_OFFSET_TIMESTAMP_FORMAT = BIT(18) , BT_MAP_SUPPORTED_FEATURES_CONN_REQ = BIT(19) ,
  BT_MAP_CONVO_LISTING = BIT(20) , BT_MAP_OWNER_STATUS = BIT(21) , BT_MAP_MSG_FORWARDING = BIT(22)
}
 MAP supported features. More...
enum  bt_map_supported_msg_type {
  BT_MAP_MSG_TYPE_EMAIL = BIT(0) , BT_MAP_MSG_TYPE_SMS_GSM = BIT(1) , BT_MAP_MSG_TYPE_SMS_CDMA = BIT(2) , BT_MAP_MSG_TYPE_MMS = BIT(3) ,
  BT_MAP_MSG_TYPE_IM = BIT(4)
}
 MAP supported message types. More...
enum  bt_map_set_folder_flags { BT_MAP_SET_FOLDER_FLAGS_ROOT = BT_OBEX_SETPATH_FLAG_NO_CREATE , BT_MAP_SET_FOLDER_FLAGS_DOWN = BT_OBEX_SETPATH_FLAG_NO_CREATE , BT_MAP_SET_FOLDER_FLAGS_UP = BT_OBEX_SETPATH_FLAG_BACKUP | BT_OBEX_SETPATH_FLAG_NO_CREATE }
 MAP set folder operation flags. More...
enum  bt_map_appl_param_tag_id {
  BT_MAP_APPL_PARAM_TAG_ID_MAX_LIST_CNT = 0x01 , BT_MAP_APPL_PARAM_TAG_ID_LIST_START_OFFSET = 0x02 , BT_MAP_APPL_PARAM_TAG_ID_FILTER_MSG_TYPE = 0x03 , BT_MAP_APPL_PARAM_TAG_ID_FILTER_PERIOD_BEGIN = 0x04 ,
  BT_MAP_APPL_PARAM_TAG_ID_FILTER_PERIOD_END = 0x05 , BT_MAP_APPL_PARAM_TAG_ID_FILTER_READ_STATUS = 0x06 , BT_MAP_APPL_PARAM_TAG_ID_FILTER_RECIPIENT = 0x07 , BT_MAP_APPL_PARAM_TAG_ID_FILTER_ORIGINATOR = 0x08 ,
  BT_MAP_APPL_PARAM_TAG_ID_FILTER_PRIORITY = 0x09 , BT_MAP_APPL_PARAM_TAG_ID_ATTACHMENT = 0x0a , BT_MAP_APPL_PARAM_TAG_ID_TRANSPARENT = 0x0b , BT_MAP_APPL_PARAM_TAG_ID_RETRY = 0x0c ,
  BT_MAP_APPL_PARAM_TAG_ID_NEW_MSG = 0x0d , BT_MAP_APPL_PARAM_TAG_ID_NTF_STATUS = 0x0e , BT_MAP_APPL_PARAM_TAG_ID_MAS_INST_ID = 0x0f , BT_MAP_APPL_PARAM_TAG_ID_PARAM_MASK = 0x10 ,
  BT_MAP_APPL_PARAM_TAG_ID_FOLDER_LISTING_SIZE = 0x11 , BT_MAP_APPL_PARAM_TAG_ID_LISTING_SIZE = 0x12 , BT_MAP_APPL_PARAM_TAG_ID_SUBJECT_LEN = 0x13 , BT_MAP_APPL_PARAM_TAG_ID_CHARSET = 0x14 ,
  BT_MAP_APPL_PARAM_TAG_ID_FRACTION_REQUEST = 0x15 , BT_MAP_APPL_PARAM_TAG_ID_FRACTION_DELIVER = 0x16 , BT_MAP_APPL_PARAM_TAG_ID_STATUS_IND = 0x17 , BT_MAP_APPL_PARAM_TAG_ID_STATUS_VAL = 0x18 ,
  BT_MAP_APPL_PARAM_TAG_ID_MSE_TIME = 0x19 , BT_MAP_APPL_PARAM_TAG_ID_DB_ID = 0x1a , BT_MAP_APPL_PARAM_TAG_ID_CONVO_LISTING_VER_CNTR = 0x1b , BT_MAP_APPL_PARAM_TAG_ID_PRESENCE_AVAIL = 0x1c ,
  BT_MAP_APPL_PARAM_TAG_ID_PRESENCE_TEXT = 0x1d , BT_MAP_APPL_PARAM_TAG_ID_LAST_ACTIVITY = 0x1e , BT_MAP_APPL_PARAM_TAG_ID_FILTER_LAST_ACTIVITY_BEGIN = 0x1f , BT_MAP_APPL_PARAM_TAG_ID_FILTER_LAST_ACTIVITY_END = 0x20 ,
  BT_MAP_APPL_PARAM_TAG_ID_CHAT_STATE = 0x21 , BT_MAP_APPL_PARAM_TAG_ID_CONVO_ID = 0x22 , BT_MAP_APPL_PARAM_TAG_ID_FOLDER_VER_CNTR = 0x23 , BT_MAP_APPL_PARAM_TAG_ID_FILTER_MSG_HANDLE = 0x24 ,
  BT_MAP_APPL_PARAM_TAG_ID_NTF_FILTER_MASK = 0x25 , BT_MAP_APPL_PARAM_TAG_ID_CONVO_PARAM_MASK = 0x26 , BT_MAP_APPL_PARAM_TAG_ID_OWNER_UCI = 0x27 , BT_MAP_APPL_PARAM_TAG_ID_EXT_DATA = 0x28 ,
  BT_MAP_APPL_PARAM_TAG_ID_MAP_SUPPORTED_FEATURES = 0x29 , BT_MAP_APPL_PARAM_TAG_ID_MSG_HANDLE = 0x2a , BT_MAP_APPL_PARAM_TAG_ID_MODIFY_TEXT = 0x2b
}
 MAP application parameter tag identifiers. More...
enum  bt_map_filter_msg_type {
  BT_MAP_FILTER_MSG_TYPE_NO_FILTERING = 0x00 , BT_MAP_FILTER_MSG_TYPE_SMS_GSM = BIT(0) , BT_MAP_FILTER_MSG_TYPE_SMS_CDMA = BIT(1) , BT_MAP_FILTER_MSG_TYPE_EMAIL = BIT(2) ,
  BT_MAP_FILTER_MSG_TYPE_MMS = BIT(3) , BT_MAP_FILTER_MSG_TYPE_IM = BIT(4)
}
 MAP filter message type values. More...
enum  bt_map_filter_read_status { BT_MAP_FILTER_READ_STATUS_NO_FILTERING = 0x00 , BT_MAP_FILTER_READ_STATUS_UNREAD = 0x01 , BT_MAP_FILTER_READ_STATUS_READ = 0x02 }
 MAP filter read status values. More...
enum  bt_map_filter_priority { BT_MAP_FILTER_PRIORITY_NO_FILTERING = 0x00 , BT_MAP_FILTER_PRIORITY_HIGH = 0x01 , BT_MAP_FILTER_PRIORITY_NON_HIGH = 0x02 }
 MAP filter priority values. More...
enum  bt_map_attachment { BT_MAP_ATTACHMENT_OFF = 0x00 , BT_MAP_ATTACHMENT_ON = 0x01 }
 MAP attachment values. More...
enum  bt_map_transparent { BT_MAP_TRANSPARENT_OFF = 0x00 , BT_MAP_TRANSPARENT_ON = 0x01 }
 MAP transparent values. More...
enum  bt_map_retry { BT_MAP_RETRY_OFF = 0x00 , BT_MAP_RETRY_ON = 0x01 }
 MAP retry values. More...
enum  bt_map_new_msg { BT_MAP_NEW_MSG_OFF = 0x00 , BT_MAP_NEW_MSG_ON = 0x01 }
 MAP new message values. More...
enum  bt_map_ntf_status { BT_MAP_NTF_STATUS_OFF = 0x00 , BT_MAP_NTF_STATUS_ON = 0x01 }
 MAP notification status values. More...
enum  bt_map_param_mask {
  BT_MAP_PARAM_MASK_SUBJECT = BIT(0) , BT_MAP_PARAM_MASK_DATETIME = BIT(1) , BT_MAP_PARAM_MASK_SENDER_NAME = BIT(2) , BT_MAP_PARAM_MASK_SENDER_ADDRESSING = BIT(3) ,
  BT_MAP_PARAM_MASK_RECIPIENT_NAME = BIT(4) , BT_MAP_PARAM_MASK_RECIPIENT_ADDRESSING = BIT(5) , BT_MAP_PARAM_MASK_TYPE = BIT(6) , BT_MAP_PARAM_MASK_SIZE = BIT(7) ,
  BT_MAP_PARAM_MASK_RECEPTION_STATUS = BIT(8) , BT_MAP_PARAM_MASK_TEXT = BIT(9) , BT_MAP_PARAM_MASK_ATTACHMENT_SIZE = BIT(10) , BT_MAP_PARAM_MASK_PRIORITY = BIT(11) ,
  BT_MAP_PARAM_MASK_READ = BIT(12) , BT_MAP_PARAM_MASK_SENT = BIT(13) , BT_MAP_PARAM_MASK_PROTECTED = BIT(14) , BT_MAP_PARAM_MASK_REPLYTO_ADDRESSING = BIT(15) ,
  BT_MAP_PARAM_MASK_DELIVERY_STATUS = BIT(16) , BT_MAP_PARAM_MASK_CONVO_ID = BIT(17) , BT_MAP_PARAM_MASK_CONVO_NAME = BIT(18) , BT_MAP_PARAM_MASK_DIRECTION = BIT(19) ,
  BT_MAP_PARAM_MASK_ATTACHMENT_MIME = BIT(20)
}
 MAP parameter mask bits. More...
enum  bt_map_charset { BT_MAP_CHARSET_NATIVE = 0x00 , BT_MAP_CHARSET_UTF8 = 0x01 }
 MAP charset values. More...
enum  bt_map_fraction_request { BT_MAP_FRACTION_REQUEST_FIRST = 0x00 , BT_MAP_FRACTION_REQUEST_NEXT = 0x01 }
 MAP fraction request values. More...
enum  bt_map_fraction_deliver { BT_MAP_FRACTION_DELIVER_MORE = 0x00 , BT_MAP_FRACTION_DELIVER_LAST = 0x01 }
 MAP fraction deliver values. More...
enum  bt_map_status_ind { BT_MAP_STATUS_IND_READ = 0x00 , BT_MAP_STATUS_IND_DELETED = 0x01 , BT_MAP_STATUS_IND_EXTENDED_DATA = 0x02 }
 MAP status indicator values. More...
enum  bt_map_status_val { BT_MAP_STATUS_VAL_NO = 0x00 , BT_MAP_STATUS_VAL_YES = 0x01 }
 MAP status value values. More...
enum  bt_map_presence {
  BT_MAP_PRESENCE_UNKNOWN = 0x00 , BT_MAP_PRESENCE_OFFLINE = 0x01 , BT_MAP_PRESENCE_ONLINE = 0x02 , BT_MAP_PRESENCE_AWAY = 0x03 ,
  BT_MAP_PRESENCE_DO_NOT_DISTURB = 0x04 , BT_MAP_PRESENCE_BUSY = 0x05 , BT_MAP_PRESENCE_IN_A_MEETING = 0x06
}
 MAP presence availability states. More...
enum  bt_map_chat_state {
  BT_MAP_CHAT_STATE_UNKNOWN = 0x00 , BT_MAP_CHAT_STATE_INACTIVE = 0x01 , BT_MAP_CHAT_STATE_ACTIVE = 0x02 , BT_MAP_CHAT_STATE_COMPOSING = 0x03 ,
  BT_MAP_CHAT_STATE_PAUSED_COMPOSING = 0x04 , BT_MAP_CHAT_STATE_GONE = 0x05
}
 MAP chat states. More...
enum  bt_map_ntf_filter_mask {
  BT_MAP_NTF_FILTER_MASK_NEW_MSG = BIT(0) , BT_MAP_NTF_FILTER_MASK_MSG_DELETED = BIT(1) , BT_MAP_NTF_FILTER_MASK_MSG_SHIFT = BIT(2) , BT_MAP_NTF_FILTER_MASK_SENDING_SUCCESS = BIT(3) ,
  BT_MAP_NTF_FILTER_MASK_SENDING_FAILURE = BIT(4) , BT_MAP_NTF_FILTER_MASK_DELIVERY_SUCCESS = BIT(5) , BT_MAP_NTF_FILTER_MASK_DELIVERY_FAILURE = BIT(6) , BT_MAP_NTF_FILTER_MASK_MEM_FULL = BIT(7) ,
  BT_MAP_NTF_FILTER_MASK_MEM_AVAIL = BIT(8) , BT_MAP_NTF_FILTER_MASK_READ_STATUS_CHANGED = BIT(9) , BT_MAP_NTF_FILTER_MASK_CONVO_CHANGED = BIT(10) , BT_MAP_NTF_FILTER_MASK_PARTICIPANT_PRESENCE_CHANGED = BIT(11) ,
  BT_MAP_NTF_FILTER_MASK_PARTICIPANT_CHAT_STATE_CHANGED = BIT(12) , BT_MAP_NTF_FILTER_MASK_MSG_EXT_DATA_CHANGED = BIT(13) , BT_MAP_NTF_FILTER_MASK_MSG_REMOVED = BIT(14)
}
 MAP notification filter mask bits. More...
enum  bt_map_convo_param_mask {
  BT_MAP_CONVO_PARAM_MASK_CONVO_NAME = BIT(0) , BT_MAP_CONVO_PARAM_MASK_CONVO_LAST_ACTIVITY = BIT(1) , BT_MAP_CONVO_PARAM_MASK_READ_STATUS = BIT(2) , BT_MAP_CONVO_PARAM_MASK_VER_CNTR = BIT(3) ,
  BT_MAP_CONVO_PARAM_MASK_SUMMARY = BIT(4) , BT_MAP_CONVO_PARAM_MASK_PARTICIPANTS = BIT(5) , BT_MAP_CONVO_PARAM_MASK_PARTICIPANT_UCI = BIT(6) , BT_MAP_CONVO_PARAM_MASK_PARTICIPANT_DISP_NAME = BIT(7) ,
  BT_MAP_CONVO_PARAM_MASK_PARTICIPANT_CHAT_STATE = BIT(8) , BT_MAP_CONVO_PARAM_MASK_PARTICIPANT_LAST_ACTIVITY = BIT(9) , BT_MAP_CONVO_PARAM_MASK_PARTICIPANT_X_BT_UID = BIT(10) , BT_MAP_CONVO_PARAM_MASK_PARTICIPANT_NAME = BIT(11) ,
  BT_MAP_CONVO_PARAM_MASK_PARTICIPANT_PRESENCE_AVAIL = BIT(12) , BT_MAP_CONVO_PARAM_MASK_PARTICIPANT_PRESENCE_TEXT = BIT(13) , BT_MAP_CONVO_PARAM_MASK_PARTICIPANT_PRIORITY = BIT(14)
}
 MAP conversation parameter mask bits. More...
enum  bt_map_msg_ext_data { BT_MAP_MSG_EXT_DATA_FACEBOOK_LIKES = 0x00 , BT_MAP_MSG_EXT_DATA_TWITTER_FOLLOWERS = 0x01 , BT_MAP_MSG_EXT_DATA_TWITTER_RETWEETS = 0x02 , BT_MAP_MSG_EXT_DATA_GOOGLE_1S = 0x03 }
 MAP message extended data types. More...
enum  bt_map_modify_text { BT_MAP_MODIFY_TEXT_REPLACE = 0x00 , BT_MAP_MODIFY_TEXT_PREPEND = 0x01 }
 MAP modify text values. More...

Detailed Description

Message Access Profile (MAP).

Macro Definition Documentation

◆ BT_MAP_FILLER_BYTE

#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.

◆ BT_MAP_HDR_TYPE_GET_CONVO_LISTING

#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.

◆ BT_MAP_HDR_TYPE_GET_FOLDER_LISTING

#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.

◆ BT_MAP_HDR_TYPE_GET_MAS_INST_INFO

#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.

◆ BT_MAP_HDR_TYPE_GET_MSG

#define BT_MAP_HDR_TYPE_GET_MSG   "x-bt/message"

#include <zephyr/bluetooth/classic/map.h>

Type header for get message operation.

◆ BT_MAP_HDR_TYPE_GET_MSG_LISTING

#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.

◆ BT_MAP_HDR_TYPE_GET_OWNER_STATUS

#define BT_MAP_HDR_TYPE_GET_OWNER_STATUS   "x-bt/ownerStatus"

#include <zephyr/bluetooth/classic/map.h>

Type header for get owner status operation.

◆ BT_MAP_HDR_TYPE_PUSH_MSG

#define BT_MAP_HDR_TYPE_PUSH_MSG   "x-bt/message"

#include <zephyr/bluetooth/classic/map.h>

Type header for push message operation.

◆ BT_MAP_HDR_TYPE_SEND_EVENT

#define BT_MAP_HDR_TYPE_SEND_EVENT   "x-bt/MAP-event-report"

#include <zephyr/bluetooth/classic/map.h>

Type header for send event operation.

◆ BT_MAP_HDR_TYPE_SET_MSG_STATUS

#define BT_MAP_HDR_TYPE_SET_MSG_STATUS   "x-bt/messageStatus"

#include <zephyr/bluetooth/classic/map.h>

Type header for set message status operation.

◆ BT_MAP_HDR_TYPE_SET_NTF_FILTER

#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.

◆ BT_MAP_HDR_TYPE_SET_NTF_REG

#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.

◆ BT_MAP_HDR_TYPE_SET_OWNER_STATUS

#define BT_MAP_HDR_TYPE_SET_OWNER_STATUS   "x-bt/ownerStatus"

#include <zephyr/bluetooth/classic/map.h>

Type header for set owner status operation.

◆ BT_MAP_HDR_TYPE_UPDATE_INBOX

#define BT_MAP_HDR_TYPE_UPDATE_INBOX   "x-bt/MAP-messageUpdate"

#include <zephyr/bluetooth/classic/map.h>

Type header for update inbox operation.

◆ BT_MAP_MANDATORY_SUPPORTED_FEATURES

#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.

◆ BT_MAP_UUID_MAS

#define BT_MAP_UUID_MAS

#include <zephyr/bluetooth/classic/map.h>

Value:
(const struct bt_uuid_128 *)BT_UUID_DECLARE_128( \
BT_UUID_128_ENCODE(0xBB582B40, 0x420C, 0x11DB, 0xB0DE, 0x0800200C9A66))
#define BT_UUID_128_ENCODE(w32, w1, w2, w3, w48)
Encode 128 bit UUID into array values in little-endian format.
Definition uuid.h:193
#define BT_UUID_DECLARE_128(value...)
Helper to declare a 128-bit UUID inline.
Definition uuid.h:148
Definition uuid.h:68

MAP Message Access Server (MAS) UUID.

128-bit UUID for the Message Access Server service. Used to identify MAS service in OBEX connections.

◆ BT_MAP_UUID_MNS

#define BT_MAP_UUID_MNS

#include <zephyr/bluetooth/classic/map.h>

Value:
(const struct bt_uuid_128 *)BT_UUID_DECLARE_128( \
BT_UUID_128_ENCODE(0xBB582B41, 0x420C, 0x11DB, 0xB0DE, 0x0800200C9A66))

MAP Message Notification Server (MNS) UUID.

128-bit UUID for the Message Notification Server service. Used to identify MNS service in OBEX connections.

Enumeration Type Documentation

◆ bt_map_appl_param_tag_id

#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.

◆ 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.

◆ 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.

◆ bt_map_chat_state

#include <zephyr/bluetooth/classic/map.h>

MAP chat states.

Enumeration of possible chat states for the message owner.

Enumerator
BT_MAP_CHAT_STATE_UNKNOWN 

Unknown chat state.

BT_MAP_CHAT_STATE_INACTIVE 

Inactive.

BT_MAP_CHAT_STATE_ACTIVE 

Active.

BT_MAP_CHAT_STATE_COMPOSING 

Composing.

BT_MAP_CHAT_STATE_PAUSED_COMPOSING 

Paused composing.

BT_MAP_CHAT_STATE_GONE 

Gone.

◆ bt_map_convo_param_mask

#include <zephyr/bluetooth/classic/map.h>

MAP conversation parameter mask bits.

Bitmask for selecting which conversation attributes to include.

Enumerator
BT_MAP_CONVO_PARAM_MASK_CONVO_NAME 

Conversation name.

BT_MAP_CONVO_PARAM_MASK_CONVO_LAST_ACTIVITY 

Conversation last activity.

BT_MAP_CONVO_PARAM_MASK_READ_STATUS 

Read status.

BT_MAP_CONVO_PARAM_MASK_VER_CNTR 

Version counter.

BT_MAP_CONVO_PARAM_MASK_SUMMARY 

Summary.

BT_MAP_CONVO_PARAM_MASK_PARTICIPANTS 

Participants.

BT_MAP_CONVO_PARAM_MASK_PARTICIPANT_UCI 

Participant UCI.

BT_MAP_CONVO_PARAM_MASK_PARTICIPANT_DISP_NAME 

Participant display name.

BT_MAP_CONVO_PARAM_MASK_PARTICIPANT_CHAT_STATE 

Participant chat state.

BT_MAP_CONVO_PARAM_MASK_PARTICIPANT_LAST_ACTIVITY 

Participant last activity.

BT_MAP_CONVO_PARAM_MASK_PARTICIPANT_X_BT_UID 

Participant X-BT-UID.

BT_MAP_CONVO_PARAM_MASK_PARTICIPANT_NAME 

Participant name.

BT_MAP_CONVO_PARAM_MASK_PARTICIPANT_PRESENCE_AVAIL 

Participant presence availability.

BT_MAP_CONVO_PARAM_MASK_PARTICIPANT_PRESENCE_TEXT 

Participant presence text.

BT_MAP_CONVO_PARAM_MASK_PARTICIPANT_PRIORITY 

Participant priority.

◆ bt_map_filter_msg_type

#include <zephyr/bluetooth/classic/map.h>

MAP filter message type values.

Bitmask for filtering messages by type.

Enumerator
BT_MAP_FILTER_MSG_TYPE_NO_FILTERING 

No filtering.

BT_MAP_FILTER_MSG_TYPE_SMS_GSM 

SMS GSM.

BT_MAP_FILTER_MSG_TYPE_SMS_CDMA 

SMS CDMA.

BT_MAP_FILTER_MSG_TYPE_EMAIL 

Email.

BT_MAP_FILTER_MSG_TYPE_MMS 

MMS.

BT_MAP_FILTER_MSG_TYPE_IM 

Instant Message.

◆ bt_map_filter_priority

#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.

◆ bt_map_filter_read_status

#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.

◆ bt_map_fraction_deliver

#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.

◆ bt_map_fraction_request

#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.

◆ 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.

◆ 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.

Enumerator
BT_MAP_MSG_EXT_DATA_FACEBOOK_LIKES 

Number of Facebook likes.

BT_MAP_MSG_EXT_DATA_TWITTER_FOLLOWERS 

Number of Twitter followers.

BT_MAP_MSG_EXT_DATA_TWITTER_RETWEETS 

Number of Twitter retweets.

BT_MAP_MSG_EXT_DATA_GOOGLE_1S 

Number of Google +1s.

◆ 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.

◆ bt_map_ntf_filter_mask

#include <zephyr/bluetooth/classic/map.h>

MAP notification filter mask bits.

Bitmask for filtering which event types to receive notifications for.

Enumerator
BT_MAP_NTF_FILTER_MASK_NEW_MSG 

NewMessage.

BT_MAP_NTF_FILTER_MASK_MSG_DELETED 

MessageDeleted.

BT_MAP_NTF_FILTER_MASK_MSG_SHIFT 

MessageShift.

BT_MAP_NTF_FILTER_MASK_SENDING_SUCCESS 

SendingSuccess.

BT_MAP_NTF_FILTER_MASK_SENDING_FAILURE 

SendingFailure.

BT_MAP_NTF_FILTER_MASK_DELIVERY_SUCCESS 

DeliverySuccess.

BT_MAP_NTF_FILTER_MASK_DELIVERY_FAILURE 

DeliveryFailure.

BT_MAP_NTF_FILTER_MASK_MEM_FULL 

MemoryFull.

BT_MAP_NTF_FILTER_MASK_MEM_AVAIL 

MemoryAvailable.

BT_MAP_NTF_FILTER_MASK_READ_STATUS_CHANGED 

ReadStatusChanged.

BT_MAP_NTF_FILTER_MASK_CONVO_CHANGED 

ConversationChanged.

BT_MAP_NTF_FILTER_MASK_PARTICIPANT_PRESENCE_CHANGED 

ParticipantPresenceChanged.

BT_MAP_NTF_FILTER_MASK_PARTICIPANT_CHAT_STATE_CHANGED 

ParticipantChatStateChanged.

BT_MAP_NTF_FILTER_MASK_MSG_EXT_DATA_CHANGED 

MessageExtendedDataChanged.

BT_MAP_NTF_FILTER_MASK_MSG_REMOVED 

MessageRemoved.

◆ 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.

◆ bt_map_param_mask

#include <zephyr/bluetooth/classic/map.h>

MAP parameter mask bits.

Bitmask for selecting which message attributes to include.

Enumerator
BT_MAP_PARAM_MASK_SUBJECT 

Subject.

BT_MAP_PARAM_MASK_DATETIME 

Datetime.

BT_MAP_PARAM_MASK_SENDER_NAME 

Sender name.

BT_MAP_PARAM_MASK_SENDER_ADDRESSING 

Sender addressing.

BT_MAP_PARAM_MASK_RECIPIENT_NAME 

Recipient name.

BT_MAP_PARAM_MASK_RECIPIENT_ADDRESSING 

Recipient addressing.

BT_MAP_PARAM_MASK_TYPE 

Type.

BT_MAP_PARAM_MASK_SIZE 

Size.

BT_MAP_PARAM_MASK_RECEPTION_STATUS 

Reception status.

BT_MAP_PARAM_MASK_TEXT 

Text.

BT_MAP_PARAM_MASK_ATTACHMENT_SIZE 

Attachment size.

BT_MAP_PARAM_MASK_PRIORITY 

Priority.

BT_MAP_PARAM_MASK_READ 

Read.

BT_MAP_PARAM_MASK_SENT 

Sent.

BT_MAP_PARAM_MASK_PROTECTED 

Protected.

BT_MAP_PARAM_MASK_REPLYTO_ADDRESSING 

Replyto addressing.

BT_MAP_PARAM_MASK_DELIVERY_STATUS 

Delivery status.

BT_MAP_PARAM_MASK_CONVO_ID 

Conversation ID.

BT_MAP_PARAM_MASK_CONVO_NAME 

Conversation name.

BT_MAP_PARAM_MASK_DIRECTION 

Direction.

BT_MAP_PARAM_MASK_ATTACHMENT_MIME 

Attachment MIME.

◆ bt_map_presence

#include <zephyr/bluetooth/classic/map.h>

MAP presence availability states.

Enumeration of possible presence states for the message owner.

Enumerator
BT_MAP_PRESENCE_UNKNOWN 

Unknown presence state.

BT_MAP_PRESENCE_OFFLINE 

Offline.

BT_MAP_PRESENCE_ONLINE 

Online.

BT_MAP_PRESENCE_AWAY 

Away.

BT_MAP_PRESENCE_DO_NOT_DISTURB 

Do not disturb.

BT_MAP_PRESENCE_BUSY 

Busy.

BT_MAP_PRESENCE_IN_A_MEETING 

In a meeting.

◆ 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.

◆ bt_map_set_folder_flags

#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.

◆ 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.

◆ 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.

◆ bt_map_supported_features

#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.

Enumerator
BT_MAP_NTF_REG_FEATURE 

Notification registration feature.

BT_MAP_NTF_FEATURE 

Notification feature.

BT_MAP_BROWSING_FEATURE 

Browsing feature.

BT_MAP_UPLOADING_FEATURE 

Uploading feature.

BT_MAP_DELETE_FEATURE 

Delete feature.

BT_MAP_INST_INFO_FEATURE 

Instance information feature.

BT_MAP_EXT_EVENT_REPORT_V11 

Extended event report version 1.1.

BT_MAP_EXT_EVENT_REPORT_V12 

Extended event version 1.2.

BT_MAP_MSG_FORMAT_V11 

Message format version 1.1.

BT_MAP_MSG_LISTING_FORMAT_V11 

Message listing format version 1.1.

BT_MAP_PERSISTENT_MSG_HANDLE 

Persistent message handle.

BT_MAP_DB_ID 

Database identifier.

BT_MAP_FOLDER_VER_CNTR 

Folder version counter.

BT_MAP_CONVO_VER_CNTR 

Conversation version counter.

BT_MAP_PARTICIPANT_PRESENCE_CHANGE_NTF 

Participant presence change notification.

BT_MAP_PARTICIPANT_CHAT_STATE_CHANGE_NTF 

Participant chat state change notification.

BT_MAP_PBAP_CONTACT_XREF 

PBAP contact cross reference.

BT_MAP_NTF_FILTERING 

Notification filtering.

BT_MAP_UTC_OFFSET_TIMESTAMP_FORMAT 

UTC offset timestamp format.

BT_MAP_SUPPORTED_FEATURES_CONN_REQ 

Supported features in connect request.

BT_MAP_CONVO_LISTING 

Conversation listing.

BT_MAP_OWNER_STATUS 

Owner status.

BT_MAP_MSG_FORWARDING 

Message forwarding.

◆ bt_map_supported_msg_type

#include <zephyr/bluetooth/classic/map.h>

MAP supported message types.

Bitmask indicating which message types are supported by a MAS instance.

Enumerator
BT_MAP_MSG_TYPE_EMAIL 

Email message type.

BT_MAP_MSG_TYPE_SMS_GSM 

SMS GSM message type.

BT_MAP_MSG_TYPE_SMS_CDMA 

SMS CDMA message type.

BT_MAP_MSG_TYPE_MMS 

MMS message type.

BT_MAP_MSG_TYPE_IM 

Instant messaging type.

◆ 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.