PBAP PCE API

结构体
struct	pbap_pce_pull_phone_book_param_t
	电话簿参数。 更多...
struct	pbap_pce_pull_vcard_listing_param_t
	vCard列表对象参数。 更多...
struct	pbap_pce_pull_vcard_entry_param_t
	vCard参数。 更多...
struct	pbap_pce_callbacks_t
	PBAP回调函数接口定义。 更多...

宏定义
#define	PBAP_MASK_LEN   8
	PBAP掩码长度。
#define	PBAP_ERROR_OFFSET   0x100
	PBAP错误码偏移。

类型定义
typedef void(*	pbap_pce_conn_state_changed_callback) (const bd_addr_t *bd_addr, profile_connect_state_t state)
	连接状态变化回调函数。
typedef void(*	pbap_pce_phone_book_size_callback) (const bd_addr_t *bd_addr, unsigned short size)
	电话簿大小回调函数。
typedef void(*	pbap_pce_trans_complete_callback) (const bd_addr_t *bd_addr)
	传输完成回调函数。
typedef void(*	pbap_pce_receive_data_callback) (const bd_addr_t *bd_addr, const unsigned char *data, int len)
	接收到数据回调函数。
typedef void(*	pbap_pce_error_code_callback) (const bd_addr_t *bd_addr, int code)
	上报错误码回调函数。

枚举
enum	pbap_format_vcard_t { PBAP_FORMAT_VCARD21 = 0x00 , PBAP_FORMAT_VCARD30 }
	PBAP vCard格式取值。 更多...
enum	pbap_repositories_t { PBAP_REPOSITORY_LOCAL = 0x01 , PBAP_REPOSITORY_SIM }
	PBAP存储位置。 更多...
enum	pbap_order_type_t { PBAP_ORDER_INDEXED = 0x00 , PBAP_ORDER_ALPHANUMERIC , PBAP_ORDER_PHONETIC }
	PBAP排序类型。 更多...
enum	pbap_search_property_t { PBAP_SEARCH_PROPERTY_NAME = 0x00 , PBAP_SEARCH_PROPERTY_NUMBER , PBAP_SEARCH_PROPERTY_SOUND }
	PBAP搜索属性。 更多...
enum	pbap_property_mask_t {   PBAP_PROPERTY_MASK_VERSION = 0x00 , PBAP_PROPERTY_MASK_FN , PBAP_PROPERTY_MASK_N , PBAP_PROPERTY_MASK_PHOTO ,   PBAP_PROPERTY_MASK_BDAY , PBAP_PROPERTY_MASK_ADR , PBAP_PROPERTY_MASK_LABEL , PBAP_PROPERTY_MASK_TEL ,   PBAP_PROPERTY_MASK_EMAIL , PBAP_PROPERTY_MASK_MAILER , PBAP_PROPERTY_MASK_RTY_MASK_TZ , PBAP_PROPERTY_MASK_GEO ,   PBAP_PROPERTY_MASK_TITLE , PBAP_PROPERTY_MASK_RTY_MASK_ROLE , PBAP_PROPERTY_MASK_LOGO , PBAP_PROPERTY_MASK_RTY_MASK_AGENT ,   PBAP_PROPERTY_MASK_ORG , PBAP_PROPERTY_MASK_NOTE , PBAP_PROPERTY_MASK_REV , PBAP_PROPERTY_MASK_SOUND ,   PBAP_PROPERTY_MASK_URL , PBAP_PROPERTY_MASK_UID , PBAP_PROPERTY_MASK_KEY , PBAP_PROPERTY_MASK_NICKNAME ,   PBAP_PROPERTY_MASK_RTY_MASK_RTY_MASK_CATEGORIES , PBAP_PROPERTY_MASK_RTY_MASK_PROID , PBAP_PROPERTY_MASK_CLASS , PBAP_PROPERTY_MASK_RTY_MASK_RTY_MASK_SORT_STRING ,   PBAP_PROPERTY_MASK_X_IRMC_CALL_DATETIME , PBAP_PROPERTY_MASK_RTY_MASK_X_BT_SPEEDDIALKEY , PBAP_PROPERTY_MASK_RTY_MASK_X_BT_UCI , PBAP_PROPERTY_MASK_X_BT_UID ,   PBAP_PROPERTY_MASK_FILTER = 0x27 , PBAP_PROPERTY_MASK_INVALID = 0xFF }
	PBAP属性掩码取值。 更多...
enum	pbap_error_codes_t {   PBAP_ERROR_OK = 0x100 , PBAP_ERROR_BAD_REQUEST , PBAP_ERROR_NOT_IMPLEMENTED , PBAP_ERROR_UNAUTHORIZED ,   PBAP_ERROR_PRECONDITION_FAILED , PBAP_ERROR_NOT_FOUND , PBAP_ERROR_NOT_ACCEPTABLE , PBAP_ERROR_SERVICE_UNAVAILABLE ,   PBAP_ERROR_FORBIDDEN }
	PBAP错误码。 更多...

函数
int	pbap_pce_connect (const bd_addr_t *bd_addr)
	建立与PSE的连接。
int	pbap_pce_disconnect (const bd_addr_t *bd_addr)
	建立与PSE的连接。
int	pbap_pce_get_device_connect_state (const bd_addr_t *bd_addr)
	查询PBAP client连接状态。
int	pbap_pce_pull_phone_book (const bd_addr_t *bd_addr, const pbap_pce_pull_phone_book_param_t *param)
	下载电话簿对象。
int	pbap_pce_set_phone_book (const bd_addr_t *bd_addr, const unsigned char *name)
	设置虚拟文件夹体系结构中的当前文件夹。
int	pbap_pce_pull_vcard_listing (const bd_addr_t *bd_addr, const pbap_pce_pull_vcard_listing_param_t *param)
	检索PSE的电话簿列表对象。
int	pbap_pce_pull_vcard_entry (const bd_addr_t *bd_addr, const pbap_pce_pull_vcard_entry_param_t *param)
	检索特定的vCard。
int	pbap_pce_stop_trans (const bd_addr_t *bd_addr)
	停止传输。
int	pbap_pce_register_callbacks (pbap_pce_callbacks_t *func)
	注册PBAP回调函数。

变量
unsigned char	pbap_pce_pull_phone_book_param_t::property_selector [8]
unsigned char	pbap_pce_pull_phone_book_param_t::vcard_selector [8]
unsigned short	pbap_pce_pull_phone_book_param_t::max_list_count
unsigned short	pbap_pce_pull_phone_book_param_t::list_offset
unsigned char *	pbap_pce_pull_phone_book_param_t::name
unsigned char	pbap_pce_pull_phone_book_param_t::format
unsigned char	pbap_pce_pull_phone_book_param_t::reset_new_missed_calls
unsigned char	pbap_pce_pull_phone_book_param_t::vcard_selector_operator
unsigned char	pbap_pce_pull_vcard_listing_param_t::vcard_selector [8]
unsigned short	pbap_pce_pull_vcard_listing_param_t::max_list_count
unsigned short	pbap_pce_pull_vcard_listing_param_t::list_offset
unsigned char *	pbap_pce_pull_vcard_listing_param_t::name
unsigned char *	pbap_pce_pull_vcard_listing_param_t::search_value
unsigned char	pbap_pce_pull_vcard_listing_param_t::search_property
unsigned char	pbap_pce_pull_vcard_listing_param_t::order
unsigned char	pbap_pce_pull_vcard_listing_param_t::reset_new_missed_calls
unsigned char	pbap_pce_pull_vcard_listing_param_t::vcard_selector_operator
unsigned char	pbap_pce_pull_vcard_entry_param_t::property_selector [8]
unsigned char *	pbap_pce_pull_vcard_entry_param_t::name
unsigned char	pbap_pce_pull_vcard_entry_param_t::format
pbap_pce_conn_state_changed_callback	pbap_pce_callbacks_t::state_changed_cb
pbap_pce_phone_book_size_callback	pbap_pce_callbacks_t::phone_book_sized_cb
pbap_pce_trans_complete_callback	pbap_pce_callbacks_t::trans_complete_cb
pbap_pce_receive_data_callback	pbap_pce_callbacks_t::receive_data_cb
pbap_pce_error_code_callback	pbap_pce_callbacks_t::error_code_cb

详细描述

宏定义说明

PBAP_ERROR_OFFSET

#define PBAP_ERROR_OFFSET   0x100

PBAP错误码偏移。

PBAP_MASK_LEN

#define PBAP_MASK_LEN   8

PBAP掩码长度。

类型定义说明

pbap_pce_conn_state_changed_callback

typedef void(* pbap_pce_conn_state_changed_callback) (const bd_addr_t *bd_addr, profile_connect_state_t state)

连接状态变化回调函数。

pbap_pce_error_code_callback

typedef void(* pbap_pce_error_code_callback) (const bd_addr_t *bd_addr, int code)

上报错误码回调函数。

pbap_pce_phone_book_size_callback

typedef void(* pbap_pce_phone_book_size_callback) (const bd_addr_t *bd_addr, unsigned short size)

电话簿大小回调函数。

pbap_pce_receive_data_callback

typedef void(* pbap_pce_receive_data_callback) (const bd_addr_t *bd_addr, const unsigned char *data, int len)

接收到数据回调函数。

pbap_pce_trans_complete_callback

typedef void(* pbap_pce_trans_complete_callback) (const bd_addr_t *bd_addr)

传输完成回调函数。

枚举类型说明

pbap_error_codes_t

enum pbap_error_codes_t

PBAP错误码。

枚举值
PBAP_ERROR_OK	PBAP错误码 正常
PBAP_ERROR_BAD_REQUEST	PBAP错误码 错误请求
PBAP_ERROR_NOT_IMPLEMENTED	PBAP错误码 未执行
PBAP_ERROR_UNAUTHORIZED	PBAP错误码 未授权
PBAP_ERROR_PRECONDITION_FAILED	PBAP错误码 预置条件失败
PBAP_ERROR_NOT_FOUND	PBAP错误码 未找到
PBAP_ERROR_NOT_ACCEPTABLE	PBAP错误码 不可接受
PBAP_ERROR_SERVICE_UNAVAILABLE	PBAP错误码 服务不可用
PBAP_ERROR_FORBIDDEN	PBAP错误码 禁止

pbap_format_vcard_t

enum pbap_format_vcard_t

PBAP vCard格式取值。

枚举值
PBAP_FORMAT_VCARD21	PBAP vCard格式v2.1
PBAP_FORMAT_VCARD30	PBAP vCard格式v3.0

pbap_order_type_t

enum pbap_order_type_t

PBAP排序类型。

枚举值
PBAP_ORDER_INDEXED	PBAP排序顺序为索引序
PBAP_ORDER_ALPHANUMERIC	PBAP排序顺序为字典序
PBAP_ORDER_PHONETIC	PBAP排序顺序为语音序

pbap_property_mask_t

enum pbap_property_mask_t

PBAP属性掩码取值。

枚举值
PBAP_PROPERTY_MASK_VERSION	PBAP属性 vCard版本
PBAP_PROPERTY_MASK_FN	PBAP属性 格式化名称
PBAP_PROPERTY_MASK_N	PBAP属性 名称的结构化表示
PBAP_PROPERTY_MASK_PHOTO	PBAP属性 相关图像或照片
PBAP_PROPERTY_MASK_BDAY	PBAP属性 生日
PBAP_PROPERTY_MASK_ADR	PBAP属性 收货地址
PBAP_PROPERTY_MASK_LABEL	PBAP属性 标签
PBAP_PROPERTY_MASK_TEL	PBAP属性 电话号码
PBAP_PROPERTY_MASK_EMAIL	PBAP属性 电子邮件地址
PBAP_PROPERTY_MASK_MAILER	PBAP属性 电子邮件
PBAP_PROPERTY_MASK_RTY_MASK_TZ	PBAP属性 时区
PBAP_PROPERTY_MASK_GEO	PBAP属性 地理位置
PBAP_PROPERTY_MASK_TITLE	PBAP属性 工作
PBAP_PROPERTY_MASK_RTY_MASK_ROLE	PBAP属性 组织内的角色
PBAP_PROPERTY_MASK_LOGO	PBAP属性 组织徽标
PBAP_PROPERTY_MASK_RTY_MASK_AGENT	PBAP属性 代表人员的vCard
PBAP_PROPERTY_MASK_ORG	PBAP属性 组织名称
PBAP_PROPERTY_MASK_NOTE	PBAP属性 注释
PBAP_PROPERTY_MASK_REV	PBAP属性 修订版本
PBAP_PROPERTY_MASK_SOUND	PBAP属性 姓名读音
PBAP_PROPERTY_MASK_URL	PBAP属性 统一资源定位器
PBAP_PROPERTY_MASK_UID	PBAP属性 唯一标识
PBAP_PROPERTY_MASK_KEY	PBAP属性 公共加密密钥
PBAP_PROPERTY_MASK_NICKNAME	PBAP属性 昵称
PBAP_PROPERTY_MASK_RTY_MASK_RTY_MASK_CATEGORIES	PBAP属性 类别
PBAP_PROPERTY_MASK_RTY_MASK_PROID	PBAP属性 产品ID
PBAP_PROPERTY_MASK_CLASS	PBAP属性 CLASS信息
PBAP_PROPERTY_MASK_RTY_MASK_RTY_MASK_SORT_STRING	PBAP属性 用于排序操作的字符串
PBAP_PROPERTY_MASK_X_IRMC_CALL_DATETIME	PBAP属性 时间戳
PBAP_PROPERTY_MASK_RTY_MASK_X_BT_SPEEDDIALKEY	PBAP属性 快速拨号快捷方式
PBAP_PROPERTY_MASK_RTY_MASK_X_BT_UCI	PBAP属性 统一主叫方标识符
PBAP_PROPERTY_MASK_X_BT_UID	PBAP属性 蓝牙联系人唯一标识符
PBAP_PROPERTY_MASK_FILTER	PBAP属性 私有过滤器
PBAP_PROPERTY_MASK_INVALID

pbap_repositories_t

enum pbap_repositories_t

PBAP存储位置。

枚举值
PBAP_REPOSITORY_LOCAL	PBAP电话簿存储位置在手机
PBAP_REPOSITORY_SIM	PBAP电话簿存储位置在SIM卡

pbap_search_property_t

enum pbap_search_property_t

PBAP搜索属性。

枚举值
PBAP_SEARCH_PROPERTY_NAME	PBAP搜索属性为名字
PBAP_SEARCH_PROPERTY_NUMBER	PBAP搜索属性为号码
PBAP_SEARCH_PROPERTY_SOUND	PBAP搜索属性为读音

函数说明

pbap_pce_connect()

int pbap_pce_connect

(

const bd_addr_t *

bd_addr

)

建立与PSE的连接。

pbap_pce_disconnect()

int pbap_pce_disconnect

(

const bd_addr_t *

bd_addr

)

建立与PSE的连接。

pbap_pce_get_device_connect_state()

int pbap_pce_get_device_connect_state

(

const bd_addr_t *

bd_addr

)

查询PBAP client连接状态。

pbap_pce_pull_phone_book()

int pbap_pce_pull_phone_book	(	const bd_addr_t *	bd_addr,
		const pbap_pce_pull_phone_book_param_t *	param
	)

下载电话簿对象。

pbap_pce_pull_vcard_entry()

int pbap_pce_pull_vcard_entry	(	const bd_addr_t *	bd_addr,
		const pbap_pce_pull_vcard_entry_param_t *	param
	)

检索特定的vCard。

pbap_pce_pull_vcard_listing()

int pbap_pce_pull_vcard_listing	(	const bd_addr_t *	bd_addr,
		const pbap_pce_pull_vcard_listing_param_t *	param
	)

检索PSE的电话簿列表对象。

pbap_pce_register_callbacks()

int pbap_pce_register_callbacks

(

pbap_pce_callbacks_t *

func

)

注册PBAP回调函数。

pbap_pce_set_phone_book()

int pbap_pce_set_phone_book	(	const bd_addr_t *	bd_addr,
		const unsigned char *	name
	)

设置虚拟文件夹体系结构中的当前文件夹。

pbap_pce_stop_trans()

int pbap_pce_stop_trans

(

const bd_addr_t *

bd_addr

)

停止传输。

变量说明

error_code_cb

pbap_pce_error_code_callback pbap_pce_callbacks_t::error_code_cb

format [1/2]

unsigned char pbap_pce_pull_phone_book_param_t::format

格式

format [2/2]

unsigned char pbap_pce_pull_vcard_entry_param_t::format

格式

list_offset [1/2]

unsigned short pbap_pce_pull_phone_book_param_t::list_offset

列表起始偏移量

list_offset [2/2]

unsigned short pbap_pce_pull_vcard_listing_param_t::list_offset

列表起始偏移量

max_list_count [1/2]

unsigned short pbap_pce_pull_phone_book_param_t::max_list_count

最大列表计数

max_list_count [2/2]

unsigned short pbap_pce_pull_vcard_listing_param_t::max_list_count

最大列表计数

name [1/3]

unsigned char* pbap_pce_pull_phone_book_param_t::name

名称

name [2/3]

unsigned char* pbap_pce_pull_vcard_listing_param_t::name

名称

name [3/3]

unsigned char* pbap_pce_pull_vcard_entry_param_t::name

名称

order

unsigned char pbap_pce_pull_vcard_listing_param_t::order

顺序

phone_book_sized_cb

pbap_pce_phone_book_size_callback pbap_pce_callbacks_t::phone_book_sized_cb

property_selector [1/2]

unsigned char pbap_pce_pull_phone_book_param_t::property_selector[8]

属性选择器

property_selector [2/2]

unsigned char pbap_pce_pull_vcard_entry_param_t::property_selector[8]

属性选择器

receive_data_cb

pbap_pce_receive_data_callback pbap_pce_callbacks_t::receive_data_cb

reset_new_missed_calls [1/2]

unsigned char pbap_pce_pull_phone_book_param_t::reset_new_missed_calls

重置新的未接呼叫

reset_new_missed_calls [2/2]

unsigned char pbap_pce_pull_vcard_listing_param_t::reset_new_missed_calls

重置新的未接呼叫

search_property

unsigned char pbap_pce_pull_vcard_listing_param_t::search_property

搜索属性

search_value

unsigned char* pbap_pce_pull_vcard_listing_param_t::search_value

搜索值

state_changed_cb

pbap_pce_conn_state_changed_callback pbap_pce_callbacks_t::state_changed_cb

trans_complete_cb

pbap_pce_trans_complete_callback pbap_pce_callbacks_t::trans_complete_cb

vcard_selector [1/2]

unsigned char pbap_pce_pull_phone_book_param_t::vcard_selector[8]

vCard选择器

vcard_selector [2/2]

unsigned char pbap_pce_pull_vcard_listing_param_t::vcard_selector[8]

vCard选择器

vcard_selector_operator [1/2]

unsigned char pbap_pce_pull_phone_book_param_t::vcard_selector_operator

vCard选择器运算符

vcard_selector_operator [2/2]

unsigned char pbap_pce_pull_vcard_listing_param_t::vcard_selector_operator

vCard选择器运算符