Echo / T3212_B2B_723 · Files

SmsBtMapCSrvGprot.h 30.6 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 
/*****************************************************************************
*  Copyright Statement:
*  --------------------
*  This software is protected by Copyright and the information contained
*  herein is confidential. The software may not be copied and the information
*  contained herein may not be used or disclosed except with the written
*  permission of MediaTek Inc. (C) 2005
*
*  BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
*  THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
*  RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
*  AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
*  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
*  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
*  NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
*  SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
*  SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
*  THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
*  NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
*  SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
*  BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
*  LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
*  AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
*  OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
*  MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE. 
*
*  THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
*  WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
*  LAWS PRINCIPLES.  ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
*  RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
*  THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/

/*****************************************************************************
 *
 * Filename:
 * ---------
 *  SmsBtMapCSrvGProt.h
 *
 * Project:
 * --------
 *  MAUI
 *
 * Description:
 * ------------
 *  SMS Service Global prototype declaration
 *
 * Author:
 * -------
 * -------
 *
 *============================================================================
 *             HISTORY
 * Below this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *------------------------------------------------------------------------------
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 *
 * removed!
 *
 *------------------------------------------------------------------------------
 * Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *============================================================================
 *****************************************************************************/
#ifndef __SRV_SMS_BTMAPC_GPROT_H__
#define __SRV_SMS_BTMAPC_GPROT_H__

//#ifndef __SRV_SMS_BTMAPC_TEST__
//#define __SRV_SMS_BTMAPC_TEST__
//#endif

#ifdef __MMI_BT_MAP_CLIENT__
#define __SRV_SMS_BTMAPC__
#endif

#include "MMI_features.h"
#include "MMIDataType.h"
#include "kal_general_types.h"
#include "custom_mmi_default_value.h"
#include "ps_public_enum.h"
#include "stack_config.h"
#include "customer_ps_inc.h"
#include "nvram_common_defs.h"
#include "mmi_rp_srv_sms_def.h"
#include "SmsSrvGprot.h"
#include "MapSrvGprot.h"
#include "custom_btmapc_config.h"

#define SRV_BT_MAP_MAX_SENDER_NAME_LEN 40

typedef enum
{
    SRV_SMS_BTMAPC_BOX_NONE         = 0x00,    /* None */
    SRV_SMS_BTMAPC_BOX_INBOX        = 0x01,    /* Inbox, listed all message received from MSE */
    SRV_SMS_BTMAPC_BOX_OUTBOX       = 0x02,    /* Outbox, listed all message sent to network from MSE */
    SRV_SMS_BTMAPC_BOX_DRAFTS       = 0x04,    /* Drafts, listed all draft messages from both local and MSE */
    SRV_SMS_BTMAPC_BOX_UNSENT       = 0x08,    /* Unsent, listed all messages to be sent to network from MSE*/
    SRV_SMS_BTMAPC_BOX_DELETED      = 0x10,
    SRV_SMS_BTMAPC_BOX_ROOT         = 0x20,
    SRV_SMS_BTMAPC_BOX_RESERVED     = 0x40
} srv_sms_btmapc_box_enum;

typedef struct
{
    srv_bt_mapc_result_enum error;
}srv_sms_btmapc_conn_struct;

typedef struct
{
    U16 msg_id;         /* Message ID */
    srv_sms_btmapc_box_enum box_type;
    U8  *content;       /* Conent of New Message */
    void *msg_data;     /* Detail information of new SMS, refer to srv_sms_new_msg_struct */
} srv_sms_btmapc_event_new_sms_struct;



/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_init
 * DESCRIPTION
 * 
 * PARAMETERS
 *  void
 * RETURNS
 *  SMS_HANDLE
 *****************************************************************************/
void srv_sms_btmapc_init(void);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_connect
 * DESCRIPTION
 * 
 * PARAMETERS
 *  void
 * RETURNS
 *  SMS_HANDLE
 *****************************************************************************/

S32 srv_sms_btmapc_connect(
          int app_id,
          SrvSmsCallbackFunc callback_func,
          void *user_data);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_disconnect
 * DESCRIPTION
 * 
 * PARAMETERS
 *  void
 * RETURNS
 *  SMS_HANDLE
 *****************************************************************************/

void srv_sms_btmapc_disconnect(
          S32 hd,
          SrvSmsCallbackFunc callback_func,
          void *user_data);


/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_get_msg_list
 * DESCRIPTION
 *  Get The MessageList From MSE or Cache
 * PARAMETERS
 *  is_refresh          :   [IN]        if get the list from MSE
 *  box_type   :   [IN]        The Box type
 *  callback_func   :   [IN]        Callback Function
 *  user_data       :   [IN]        User Data
 * RETURNS
 *  SMS_HANDLE
 *****************************************************************************/

extern SMS_HANDLE srv_sms_btmapc_get_msg_list(
                MMI_BOOL is_refresh,
                srv_sms_btmapc_box_enum box_type,
                SrvSmsCallbackFunc callback_func,
                void *user_data);

extern MMI_BOOL srv_sms_btmapc_cancel_op(SMS_HANDLE srv_hd);


/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_read_msg
 * DESCRIPTION
 *  1. Read Message's Data, included message status, number, content and other attributes
 *     (Storage Type, SIM Card, Profile element, etc.) indicated by the flag;
 *  2. The buffer to save the content should be provided by caller.
 *  3. The Callback Action Data Structure is srv_sms_btmapc_read_msg_cb_struct;
 * PARAMETERS
 *  msg_id          :   [IN]        Message ID
 *  change_status   :   [IN]        Whether change the UNREAD Msg to READ
 *  msg_data        :   [IN/OUT]    Message Data For Filling back read data
 *  callback_func   :   [IN]        Callback Function
 *  user_data       :   [IN]        User Data
 * RETURNS
 *  SMS_HANDLE
 *****************************************************************************/
extern SMS_HANDLE srv_sms_btmapc_read_msg(
                    U16 msg_id,
                    MMI_BOOL change_status,
                    srv_sms_msg_data_struct* msg_data,
                    SrvSmsCallbackFunc callback_func,
                    void* user_data);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_get_save_handle
 * DESCRIPTION
 *  Get a SMS_HANDLE For Saving or Updating Message
 * PARAMETERS
 *  void
 * RETURNS
 *  SMS_HANDLE
 *****************************************************************************/
extern SMS_HANDLE srv_sms_btmapc_get_save_handle(void);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_save_msg
 * DESCRIPTION
 *  1. Save a new message to  Storage.
 *  2. The Callers need to get a  save handle by API srv_sms_btmapc_get_save_handle() first,
 *     then they can call the seting API (srv_sms_set_content() etc.) to set the parameters
 *     they concerned.
 *  3. If Caller specify those parameters (Status, Address, Content, SIM Card, Storage Type,
 *     Profile element, we will use them, otherwise, it will user the defaut value.
 *  4. The Callback Action Data Struct is srv_sms_save_msg_cb_struct.
 * PARAMETERS
 *  save_handle     :   [IN]        Save Handle
 *  callback_func   :   [IN]        Callback Function
 *  user_data       :   [IN]        User Data
 * RETURNS
 *  void
 *****************************************************************************/
extern void srv_sms_btmapc_save_msg(
                SMS_HANDLE save_handle,
                SrvSmsCallbackFunc callback_func,
                void* user_data);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_delete_msg
 * DESCRIPTION
 *  1. Delete an existed message in local and MSE;
 *  2. If the message is not existed or delete fail in MSE, the result is FALSE;
 *  3. The Callback Action Data Structure is srv_sms_btmapc_delete_msg_cb_struct;
 * PARAMETERS
 *  msg_id          :   [IN]        Message ID
 *  callback_func   :   [IN]        Callback Function
 *  user_data       :   [IN]        User Data
 * RETURNS
 *  SMS_HANDLE
 *****************************************************************************/
extern SMS_HANDLE srv_sms_btmapc_delete_msg(
                    U16 msg_id,
                    SrvSmsCallbackFunc callback_func,
                    void* user_data);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_get_msg
 * DESCRIPTION
 *  1. Fetch the message from MSE;
 * PARAMETERS
 *  msg_id          :   [IN]        Message ID
 *  callback_func   :   [IN]        Callback Function
 *  user_data       :   [IN]        User Data
 * RETURNS
 *  SMS_HANDLE
 *****************************************************************************/

extern SMS_HANDLE srv_sms_btmapc_get_msg(
                U16 msg_id,
                SrvSmsCallbackFunc callback_func,
                void *user_data);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_change_msg_status
 * DESCRIPTION
 *  1. Change message's status in MSE;
 *  2. The Callback Action Data Structure is srv_sms_change_msg_status_cb_struct;
 * PARAMETERS
 *  msg_id          :   [IN]        Message ID
 *  status          :   [IN]        Destination Status
 *  callback_func   :   [IN]        Callback Function
 *  user_data       :   [IN]        User Data
 * RETURNS
 *  SMS_HANDLE
 *****************************************************************************/
extern SMS_HANDLE srv_sms_btmapc_change_msg_status(
                    U16 msg_id,
                    srv_sms_status_enum status,
                    SrvSmsCallbackFunc callback_func,
                    void* user_data);


/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_query_msg
 * DESCRIPTION
 *  1. Query the messages with some properties.
 *  2. The caller can set the query_flag, and the corresponding paramenters of
 *     the propertied they wanted. The folder ID is mandatory in the current version;
 *  3. The caller also can specify the sort flag, in the current version, we only 
 *     support sorting by timestamp.
 *  4. The Callback Action Data Structure is srv_sms_query_msg_cb_struct;
 * PARAMETERS
 *  query_data      :   [IN]        Query Data
 *  callback_func   :   [IN]        Callback Function
 *  user_data       :   [IN]        User Data
 * RETURNS
 *  void
 *****************************************************************************/
extern void srv_sms_btmapc_query_msg(
                srv_sms_query_struct* query_data,
                SrvSmsCallbackFunc callback_func,
                void* user_data);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_sort_msg
 * DESCRIPTION
 *  1. Sort the messages list.
 *  2. In the current version, we only support sorting by timestamp.
 * PARAMETERS
 *  msg_id_array    :   [IN]        Message ID Array
 *  msg_num         :   [IN]        Message Number
 *  sort_flag       :   [IN]        Sorting Type Flag
 *  order_flag      :   [IN]        Ordering Flag
 * RETURNS
 *  void
 *****************************************************************************/
extern void srv_sms_btmapc_sort_msg(
                U16* msg_id_array,
                U16 msg_num,
                srv_sms_sort_enum sort_flag,
                srv_sms_order_enum order_flag);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_get_msg_asc_address
 * DESCRIPTION
 *  Get Message's Address (ASCII Format)
 * PARAMETERS
 *  msg_id          :   [IN]        Message ID
 * RETURNS
 *  S8*
 *****************************************************************************/
extern const S8* srv_sms_btmapc_get_msg_asc_address(U16 msg_id);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_get_msg_address
 * DESCRIPTION
 *  Get Message's Address (UCS2 Format)
 * PARAMETERS
 *  msg_id          :   [IN]        Message ID
 *  ucs2_addr_buff  :   [IN]        ucs2 address
 * RETURNS
 *  S8*
 *****************************************************************************/
extern void srv_sms_btmapc_get_msg_address(U16 msg_id, S8* ucs2_addr_buff);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_get_msg_addr_num
 * DESCRIPTION
 *  Get Message's mutli Address's number
 * PARAMETERS
 *  msg_id          :   [IN]        Message ID
 * RETURNS
 *  U16
 *****************************************************************************/
extern U16 srv_sms_btmapc_get_msg_addr_num(U16 msg_id);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_get_multi_addr
 * DESCRIPTION
 *  Get Message's Address
 * PARAMETERS
 *  addr_buff       :   [IN]        ucs2 address buffer
 *  msg_id          :   [IN]        Message ID
 * RETURNS
 *  S8*
 *****************************************************************************/
extern void srv_sms_btmapc_get_msg_multi_addr(
                WCHAR* addr_buff,
                srv_sms_status_enum* send_status,
                U16 msg_id,
                U16 addr_index);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_get_msg_sender_name
 * DESCRIPTION
 *  Get Message's Sender name.
 *  This API only for SMSBT application Internal Using
 * PARAMETERS
 *  msg_id          :   [IN]        Message ID
 * RETURNS
 *  S8*
 *****************************************************************************/
extern const S8* srv_sms_btmapc_get_msg_sender_name(U16 msg_id);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_get_msg_content
 * DESCRIPTION
 *  Get Message's Content For List Display.
 *  This API only for SMSBT application Internal Using
 * PARAMETERS
 *  msg_id          :   [IN]        Message ID
 * RETURNS
 *  S8*
 *****************************************************************************/
extern const S8* srv_sms_btmapc_get_msg_content(U16 msg_id);


/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_get_msg_content_async
 * DESCRIPTION
 *  1. Get Message's Content (For List display) async(The Content is returned in
 *     the callback function).
 *  2. This API is only for This API only for SMSBT application Internal Using.
 *  3. The Callback Action Data Structure is srv_sms_get_msg_content_async_cb_struct.
 * PARAMETERS
 *  msg_id          :   [IN]        Message ID
 *  callback_func   :   [IN]        Callback Function
 *  user_data       :   [IN]        User Data
 * RETURNS
 *  void
 *****************************************************************************/
extern SMS_HANDLE srv_sms_btmapc_get_msg_content_async(
                    U16 msg_id,
                    SrvSmsCallbackFunc callback_func,
                    void *user_data);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_get_msg_timestamp
 * DESCRIPTION
 *  Get Message's Timestamp (MTTIME Format, and the Timestamp is local time)
 * PARAMETERS
 *  msg_id          [IN]        Message ID
 *  timestamp       [OUT]       Timestamp
 * RETURNS
 *  void
 *****************************************************************************/
extern void srv_sms_btmapc_get_msg_timestamp(U16 msg_id, MYTIME* timestamp);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_get_msg_timestamp_utc_sec
 * DESCRIPTION
 *  Get Message's timestamp (UTC Second format, and the Timestamp is local time)
 * PARAMETERS
 *  msg_id          :   [IN]        Message ID
 * RETURNS
 *  U32
 *****************************************************************************/
extern U32 srv_sms_btmapc_get_msg_timestamp_utc_sec(U16 msg_id);


/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_get_msg_pid
 * DESCRIPTION
 *  Get Message's PID (Protocol Identifier)
 * PARAMETERS
 *  msg_id      :   [IN]    Message ID
 * RETURNS
 *  srv_sms_pid_enum
 *****************************************************************************/
extern srv_sms_pid_enum srv_sms_btmapc_get_msg_pid(U16 msg_id);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_get_msg_status
 * DESCRIPTION
 *  Get Message's Status
 * PARAMETERS
 *  msg_id      :   [IN]        Message ID
 * RETURNS
 *  srv_sms_status_enum
 *****************************************************************************/
extern srv_sms_status_enum srv_sms_btmapc_get_msg_status(U16 msg_id);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_get_msg_mti
 * DESCRIPTION
 *  Get Message's MTI (Message Type Indication)
 * PARAMETERS
 *  msg_id       :   [IN]        Message ID
 * RETURNS
 *  srv_sms_mti_enum
 *****************************************************************************/
extern srv_sms_mti_enum srv_sms_btmapc_get_msg_mti(U16 msg_id);


/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_get_msg_port
 * DESCRIPTION
 *  Get Message's Destination Port Number
 * PARAMETERS
 *  msg_id          [IN]        Message ID
 * RETURNS
 *  U16
 *****************************************************************************/
extern U16 srv_sms_btmapc_get_msg_port(U16 msg_id);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_get_msg_size
 * DESCRIPTION
 *  Get Message's size, only for SMSBT application internal using
 * PARAMETERS
 *  msg_id      :    [IN]        Message ID
 * RETURNS
 *  U16
 *****************************************************************************/
extern U16 srv_sms_btmapc_get_msg_size(U16 msg_id);


/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_is_msg_exist
 * DESCRIPTION
 *  Check Wether the message is existed
 * PARAMETERS
 *  msg_id      :    [IN]        Message ID
 * RETURNS
 *  MMI_BOOL
 *****************************************************************************/
extern MMI_BOOL srv_sms_btmapc_is_msg_exist(U16 msg_id);


/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_get_unread_sms_num
 * DESCRIPTION
 *  Get Unread Message's number
 * PARAMETERS
 *  void
 * RETURNS
 *  The Unread Message's number
 *****************************************************************************/
extern U16 srv_sms_btmapc_get_unread_sms_num(void);


/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_get_msg_id
 * DESCRIPTION
 *  Get message ID of the message in the box list
 * PARAMETERS
 *  msg_box_type   : [IN]        Message Box List Type
 *  list_index     : [IN]        The position of message in the Box List
 * RETURNS
 *  The message ID
 *****************************************************************************/
extern U16 srv_sms_btmapc_get_msg_id(srv_sms_btmapc_box_enum msg_box_type, U16 list_index);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_get_list_size
 * DESCRIPTION
 *  Get number of the messages in a box list
 * PARAMETERS
 *  msg_box_type   : [IN]        Message Box List Type
 * RETURNS
 *  The message size
 *****************************************************************************/
extern U16 srv_sms_btmapc_get_list_size(srv_sms_btmapc_box_enum msg_box_type);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_get_list_type
 * DESCRIPTION
 *  Get a message(with specific status, storage tpye, folder type)'s Box the Box List Type
 * PARAMETERS
 *  status         : [IN]        Message Status
 *  storage_type   : [IN]        Storage Type
 *  folder_id      : [IN]        Folder Type
 * RETURNS
 *  srv_sms_box_enum
 *****************************************************************************/
extern srv_sms_btmapc_box_enum srv_sms_btmapc_get_list_type(
                            srv_sms_status_enum status,
                            srv_sms_storage_enum storage_type,
                            srv_sms_folder_enum folder_id);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_get_msg_list_index
 * DESCRIPTION
 *  Get position (list index) and box list type of the message
 * PARAMETERS
 *  msg_box_type  :  [OUT]       Message Box List type
 *  msg_id        :  [IN]        Message ID
 * RETURNS
 *  U16
 *****************************************************************************/
extern U16 srv_sms_btmapc_get_msg_list_index(srv_sms_btmapc_box_enum* msg_box_type, U16 msg_id);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_delete_msg_list
 * DESCRIPTION
 *  1. Delete all of the messages in the Message Box List.
 *  2. The Callback Action Data Structure is srv_sms_delete_msg_list_cb_struct.
 * PARAMETERS
 *  msg_box_type    :   [IN]        Message Box List Type
 *  sim_id          :   [IN]        SIM card id
 *  callback_func   :   [IN]        Callback Function
 *  user_data       :   [IN]        User Data
 * RETURNS
 *  void
 *****************************************************************************/
extern void srv_sms_btmapc_delete_msg_list(
                srv_sms_btmapc_box_enum msg_box_type,
                srv_sms_sim_enum sim_id,
                SrvSmsCallbackFunc callback_func,
                void* user_data);


/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_get_send_handle
 * DESCRIPTION
 *  1. send a new message by SMS HANDLE
 *  2. The Callers need to get a SMS send handle by API srv_sms_btmapc_get_send_handle() first,
 *     then they can call the seting API (srv_sms_btmapc_set_content() etc.) to set the parameters
 *     they concerned. Then Call srv_sms_btmapc_send_msg()to start to send SMS.
 *  3. If Caller specify those parameters (Status, Address, Content, SIM Card, Storage Type,
 *     Profile element, we will use them, otherwise, it will use the defaut value (If the 
 *     parameters is in the SMS setting, it will use the setting's value as defaut).
 *  4. The Callback Action Data is: S8 number[SRV_SMS_MAX_ADDR_LEN + 1].
 * PARAMETERS
 *  Void
 * RETURNS
 *  SMS_HANDLE
 *****************************************************************************/
extern SMS_HANDLE srv_sms_btmapc_get_send_handle(void);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_send_msg
 * DESCRIPTION
 *  Send SMS using SMS_HANDLE
 *  This sms handle is initialized after srv_sms_get_send_handle(),
 *  Send informations are set by calling srv_sms_set_xxx().
 * PARAMETERS
 *  send_handle     :   [IN]    SMS send hanlde
 *  callback_func   :   [IN]    Callback function        
 *  user_data       :   [IN]    User data 
 * RETURNS
 *  void
 *****************************************************************************/
extern void srv_sms_btmapc_send_msg(SMS_HANDLE send_handle, SrvSmsCallbackFunc callback_func, void *user_data);

extern void srv_sms_btmapc_free_send_handle(SMS_HANDLE sms_handle);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_abort
 * DESCRIPTION
 *  1. Abort an action (Read/Send/Save, etc); 
 *     In current version, it is only can abort a read action.
 *  2. The abort is a async operation, and it may be failed. The result is returned
 *     in the callback function of the aborted action(ex. Read).
 *     If the result is FALSE, and the cause is SRV_SMS_CAUSE_ABORT. it means the
 *     abort is success. Otherwise, the abort is failed.
 *  3. The callback function of the aborted action (Read/Send/Save, etc) will be called even if abort it.
 * PARAMETERS
 *  handle  :   [IN]    Handle of an action
 * RETURNS
 *  void
 *****************************************************************************/
extern void srv_sms_btmapc_abort(
                SMS_HANDLE handle,
                SrvSmsCallbackFunc callback_func,
                void* user_data);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_check_ucs2_number
 * DESCRIPTION
 *  check if the number is valid
 * PARAMETERS
 *  ucs2_num         [IN]       number (UCS2 Format)
 * RETURNS
 *  return true if number is valid, else return false
 *****************************************************************************/
extern MMI_BOOL srv_sms_btmapc_check_ucs2_number(char* ucs2_num);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_check_dst_number
 * DESCRIPTION
 *  check if the number is valid
 * PARAMETERS
 *  num         [IN]        Dst number
 *  numLen      [IN]        Number length
 * RETURNS
 *  return true if number is valid, else return false
 *****************************************************************************/
extern MMI_BOOL srv_sms_btmapc_check_dst_number(U8 *num, U8 numLen);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_set_content
 * DESCRIPTION
 *  set content.
 *  1>  The default content will consider as UCS2 text; And its default 
 *      DCS is UCS2;
 *  2>  If set the DCS as GSM Default 7Bit, we will change the DCS to UCS2 when 
 *      the content contains UCS2 characters. But if caller specify the DCS 
 *      to UCS2, we willn't change DCS even if the content don't contain UCS2
 *      characters.
 *  3>  If you want the specify the DCS, you need to call API srv_sms_set_content_dcs()
 *      to set the DCS. 
 *  4>  For the 8Bit DCS (SRV_SMS_DCS_8BIT), must set 8bit content, the content will be considered 
 *      as binary Data.
 *  5>  For the 7Bit DCS (SRV_SMS_DCS_7BIT), must set 7Bit content buffer.
 *  6>  Content size is buffer size, size of Bytes.
 * PARAMETERS
 *  sms_handle     :   [IN]    SMS hanlde
 *  content_buff   :   [IN]    S8 content_buff[content_size + ENCODING_LENGTH], content dcs is ucs2
 *  content_size   :   [IN]    size of Bytes  
 * RETURNS
 *  void
 *****************************************************************************/
extern void srv_sms_btmapc_set_content(SMS_HANDLE sms_handle, char *content_buff, U16 content_size);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_set_address
 * DESCRIPTION
 *  Set SMSBT send or save handle's recipient address
 * PARAMETERS
 *  sms_handle  :   [IN]    SMS hanlde
 *  ucs2_addr   :   [IN]    UCS2 Address  
 * RETURNS
 *  void
 *****************************************************************************/
extern MMI_BOOL srv_sms_btmapc_set_address(SMS_HANDLE sms_handle, char *ucs2_addr);

/*****************************************************************************
 * FUNCTION
 * srv_sms_btmapc_set_send_type
 * DESCRIPTION
 * Specify send message way. 
 * PARAMETERS
 *  sms_handle     :   [IN]    SMS hanlde
 *  type           :   [IN]    send message way      
 * RETURNS
 *  void
 *****************************************************************************/
extern void srv_sms_btmapc_set_send_type(SMS_HANDLE sms_handle, srv_sms_send_type_enum type);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_delete_msg_bitmap
 * DESCRIPTION
 *  1. Delete the messages indicated by the msg_bitmap;
 *  2. The Callback Action Data Structure is srv_sms_delete_msg_bitmap_cb_struct;
 * PARAMETERS
 *  msg_bitmap      :   [IN]        The bitmap of the Message IDs
 *  byte_size       :   [IN]        The byte number of the msg_bitmap
 *  callback_func   :   [IN]        Callback Function
 *  user_data       :   [IN]        User Data
 * RETURNS
 *  SMS_HANDLE
 *****************************************************************************/
extern SMS_HANDLE srv_sms_btmapc_delete_msg_bitmap(
                    U8 msg_bitmap[],
                    U16 byte_size,
                    SrvSmsCallbackFunc callback_func,
                    void* user_data);

/*****************************************************************************
 * FUNCTION
 *  srv_sms_btmapc_set_status
 * DESCRIPTION
 *  set the message status in local
 * PARAMETERS
 *  sms_handle       [IN]               
 * RETURNS
 *  void
 *****************************************************************************/
extern void srv_sms_btmapc_set_status(SMS_HANDLE sms_handle, srv_sms_status_enum status);

extern void srv_sms_btmapc_storage_reset_data(MMI_BOOL need_set_cntx);

#ifndef __MMI_TELEPHONY_SUPPORT__
extern void srv_sms_btmapc_delete_all();
#endif



#endif /* __SRV_SMS_BTMAPC_GPROT_H__ */