1 /* 2 * Copyright (C) 2014 BlueKitchen GmbH 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. Neither the name of the copyright holders nor the names of 14 * contributors may be used to endorse or promote products derived 15 * from this software without specific prior written permission. 16 * 4. Any redistribution, use, or modification is done solely for 17 * personal benefit and not for any commercial purpose or for 18 * monetary gain. 19 * 20 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS 24 * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 27 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 28 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 29 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 30 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * Please inquire about commercial licensing options at 34 * [email protected] 35 * 36 */ 37 38 #ifndef __GOEP_CLIENT_H 39 40 #if defined __cplusplus 41 extern "C" { 42 #endif 43 44 #include "btstack_config.h" 45 #include <stdint.h> 46 47 // max len of phone number used for lookup in pbap_lookup_by_number 48 #define PBAP_MAX_PHONE_NUMBER_LEN 32 49 50 // max len of name reported in PBAP_SUBEVENT_CARD_RESULT 51 #define PBAP_MAX_NAME_LEN 32 52 // max len of vcard handle reported in PBAP_SUBEVENT_CARD_RESULT 53 #define PBAP_MAX_HANDLE_LEN 16 54 55 /* API_START */ 56 57 /** 58 * Setup PhoneBook Access Client 59 */ 60 void pbap_client_init(void); 61 62 /** 63 * @brief Create PBAP connection to a Phone Book Server (PSE) server on a remote deivce. 64 * @param handler 65 * @param addr 66 * @param out_cid to use for further commands 67 * @result status 68 */ 69 uint8_t pbap_connect(btstack_packet_handler_t handler, bd_addr_t addr, uint16_t * out_cid); 70 71 /** 72 * @brief Provide password for OBEX Authentication after receiving PBAP_SUBEVENT_AUTHENTICATION_REQUEST 73 * @param pbap_cid 74 * @param password (null terminated string) - not copied, needs to stay valid until connection completed 75 */ 76 uint8_t pbap_authentication_password(uint16_t pbap_cid, const char * password); 77 78 /** 79 * @brief Disconnects PBAP connection with given identifier. 80 * @param pbap_cid 81 * @return status 82 */ 83 uint8_t pbap_disconnect(uint16_t pbap_cid); 84 85 /** 86 * @brief Set current folder on PSE 87 * @param pbap_cid 88 * @param path - note: path is not copied 89 * @return status 90 */ 91 uint8_t pbap_set_phonebook(uint16_t pbap_cid, const char * path); 92 93 /** 94 * @brief Get size of phone book from PSE 95 * @param pbap_cid 96 * @return status 97 */ 98 uint8_t pbap_get_phonebook_size(uint16_t pbap_cid); 99 100 /** 101 * @brief Pull phone book from PSE 102 * @param pbap_cid 103 * @return status 104 */ 105 uint8_t pbap_pull_phonebook(uint16_t pbap_cid); 106 107 /** 108 * @brief Lookup contact(s) by phone number 109 * @param pbap_cid 110 * @param phone_number 111 * @return status 112 */ 113 uint8_t pbap_lookup_by_number(uint16_t pbap_cid, const char * phone_number); 114 115 /* API_END */ 116 117 #if defined __cplusplus 118 } 119 #endif 120 #endif 121