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
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
|
/*
* Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
*
* Licensed under the Apache License, Version 2.0 (the License);
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an AS IS BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef __TIZEN_MESSAGING_H__
#define __TIZEN_MESSAGING_H__
#include <time.h>
#include <messages_types.h>
#include <messages_error.h>
#ifdef __cplusplus
extern "C"
{
#endif
/*
* @file messages.h
* @brief This file contains the messages API.
*/
/**
* @addtogroup CAPI_MESSAGING_MESSAGES_MODULE
* @{
*/
/**
* @brief Opens a handle for the messaging service.
*
* @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/message.read
*
* @remarks You must release @a service using messages_close_service().
*
* @param[out] service The message service handle
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_SERVER_NOT_READY Server is not read
* @retval #MESSAGES_ERROR_COMMUNICATION_WITH_SERVER_FAILED Communication with server failed
* @retval #MESSAGES_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @see messages_close_service()
*/
int messages_open_service(messages_service_h *service);
/**
* @brief Closes a handle for the messaging service.
*
* @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/message.read
*
* @param[in] service The message service handle
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_COMMUNICATION_WITH_SERVER_FAILED Communication with server failed
* @retval #MESSAGES_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @see messages_open_service()
*/
int messages_close_service(messages_service_h service);
/**
* @brief Creates a message handle.
*
* @since_tizen 2.3
*
* @remarks You must release @a msg using messages_destroy_message().
*
* @param[in] type The message type (#MESSAGES_TYPE_SMS or #MESSAGES_TYPE_MMS) \n
* If @a type is #MESSAGES_TYPE_UNKNOWN, #MESSAGES_ERROR_INVALID_PARAMETER occurs.
* @param[out] msg The message handle that is newly created if successful
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @see messages_destroy_message()
*/
int messages_create_message(messages_message_type_e type, messages_message_h *msg);
/**
* @brief Destroys a message handle and releases all its resources.
*
* @since_tizen 2.3
*
* @param[in] msg The message handle to destroy
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @see messages_create_message()
*/
int messages_destroy_message(messages_message_h msg);
/**
* @brief Gets the message ID of the message.
*
* @since_tizen 2.3
*
* @param[in] msg The message handle
* @param[out] msg_id The message ID
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_OPERATION_FAILED Messaging operation failed
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @see messages_search_message_by_id()
*/
int messages_get_message_id(messages_message_h msg, int *msg_id);
/**
* @brief Sets the SIM ID of the sending message.
*
* @since_tizen 2.3
*
* @param[in] msg The message handle
* @param[in] sim_id The SIM id to send message
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_OPERATION_FAILED Messaging operation failed
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @see messages_get_sim_id()
*/
int messages_set_sim_id(messages_message_h msg, int sim_id);
/**
* @brief Gets the SIM ID of the message.
*
* @since_tizen 2.3
*
* @param[in] msg The message handle
* @param[out] sim_id The SIM id of message
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_OPERATION_FAILED Messaging operation failed
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @see messages_set_sim_id()
*/
int messages_get_sim_id(messages_message_h msg, int *sim_id);
/**
* @brief Gets the message box type of the message.
*
* @since_tizen 2.3
*
* @param[in] msg The message handle
* @param[out] mbox The message box type
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*/
int messages_get_mbox_type(messages_message_h msg, messages_message_box_e *mbox);
/**
* @brief Gets the destination port of the message.
*
* @since_tizen 2.3
*
* @param[in] msg The message handle
* @param[out] port The destination port of the message
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @see messages_add_sms_listening_port()
*/
int messages_get_message_port(messages_message_h msg, int *port);
/**
* @brief Gets the type of the message.
*
* @since_tizen 2.3
*
* @param[in] msg The message handle
* @param[out] type The message type
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*/
int messages_get_message_type(messages_message_h msg, messages_message_type_e *type);
/**
* @brief Adds an recipient's address(phone number) to the message.
* @details The maximum number of recipients per a message is 10.
*
* @since_tizen 2.3
*
* @param[in] msg The message handle
* @param[in] address The recipient's address to receive a message \n
* The maximum length of @a address is @c 254.
* @param[in] type The recipient's type of the @a address
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @see messages_get_address()
* @see messages_remove_all_addresses()
*/
int messages_add_address(messages_message_h msg, const char *address, messages_recipient_type_e type);
/**
* @brief Gets the total number of recipients in the message.
*
* @since_tizen 2.3
*
* @param[in] msg The message handle
* @param[out] count The total number of recipients
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @see messages_add_address()
* @see messages_remove_all_addresses()
*/
int messages_get_address_count(messages_message_h msg, int *count);
/**
* @brief Gets a recipient's address with specified index.
*
* @since_tizen 2.3
*
* @remarks You must release @a address using free().
*
* @param[in] msg The message handle
* @param[in] index The zero-based index of an address to receive a message.
* @param[out] address The recipient's address with specified index
* @param[out] type The recipient's type of the @a address
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @see messages_add_address()
* @see messages_remove_all_addresses()
*/
int messages_get_address(messages_message_h msg, int index, char **address, messages_recipient_type_e *type);
/**
* @brief Removes all recipients in the message.
*
* @since_tizen 2.3
*
* @param[in] msg The message handle
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @see messages_add_address()
* @see messages_get_address()
*/
int messages_remove_all_addresses(messages_message_h msg);
/**
* @brief Sets the text of the message.
*
* @since_tizen 2.3
*
* @param[in] msg The message handle
* @param[in] text The text of the message \n
* The maximum length of @a text is @c 1530.
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @see messages_get_text()
*/
int messages_set_text(messages_message_h msg, const char *text);
/**
* @brief Gets the text of the message.
*
* @since_tizen 2.3
*
* @remarks You must release @a text using free().
*
* @param[in] msg The message handle
* @param[out] text The text of the message
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @see messages_set_text()
*/
int messages_get_text(messages_message_h msg, char **text);
/**
* @brief Gets the time of the message.
*
* @since_tizen 2.3
*
* @param[in] msg The message handle
* @param[out] time The time of the message
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*/
int messages_get_time(messages_message_h msg, time_t *time);
/**
* @brief Sends the message to all recipients.
*
* @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/message.write
*
* @param[in] service The message service handle
* @param[in] msg The message handle
* @param[in] save_to_sentbox Set to @c true to save the message in the sentbox,
* otherwise set to @c false to not save the message in the sentbox
* @param[in] callback The callback function
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_SENDING_FAILED Sending a message failed
* @retval #MESSAGES_ERROR_OPERATION_FAILED Messaging operation failed
* @retval #MESSAGES_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @see messages_sent_cb()
*/
int messages_send_message(messages_service_h service, messages_message_h msg, bool save_to_sentbox, messages_sent_cb callback, void *user_data);
/**
* @brief Gets the message count in the specific message box.
* @since_tizen 2.3
*
* @privlevel public
* @privilege %http://tizen.org/privilege/message.read
*
* @param[in] service The message service handle
* @param[in] mbox The message box type
* @param[in] type The message type \n
* If @a type is #MESSAGES_TYPE_UNKNOWN, all SMS and MMS messages are counted.
* @param[out] count The number of messages
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_OPERATION_FAILED Messaging operation failed
* @retval #MESSAGES_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
*/
int messages_get_message_count(messages_service_h service,
messages_message_box_e mbox, messages_message_type_e type,
int *count);
/**
* @brief Searches for messages.
*
* @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/message.read
*
* @remarks You must release @a message_array using messages_free_message_array().
*
* @param[in] service The message service handle
* @param[in] mbox The message box type
* @param[in] type The message type \n
* If @a type is #MESSAGES_TYPE_UNKNOWN, all SMS and MMS messages are searched.
* @param[in] keyword The keyword search in the text and subject
* @param[in] address The recipient address
* @param[in] offset The start position (base @c 0)
* @param[in] limit The maximum amount of messages to get \n
* In case of @c 0, this method passes to the callback all searched messages.
* @param[out] message_array The array of the message handle
* @param[out] length The number of messages of the @a message_array
* @param[out] total The count of the messages that have been retrieved as a result without applying @a limit and @a offset\ n
* The value can be used to calculate the total number of page views for the searched messages\ n
* For example, if the count of message search is @c 50 and the limit is @c 20, then using this value, you can notice the total page is @c 3.
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MESSAGES_ERROR_OPERATION_FAILED Messaging operation failed
* @retval #MESSAGES_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @see messages_free_message_array()
*/
int messages_search_message(messages_service_h service,
messages_message_box_e mbox,
messages_message_type_e type,
const char *keyword, const char *address,
int offset, int limit,
messages_message_h **message_array, int *length, int *total);
/**
* @brief Searches a message with the given message ID.
*
* @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/message.read
*
* @remarks You must release @a msg using messages_destroy_message().
*
* @param[in] service The message service handle
* @param[in] msg_id The message ID
* @param[out] msg The message handle that is newly created if successful
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MESSAGES_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @see messages_get_message_id()
*/
int messages_search_message_by_id(messages_service_h service, int msg_id, messages_message_h *msg);
/**
* @brief Frees the message array.
*
* @since_tizen 2.3
*
* @param[in] message_array The array of the message handle
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @see messages_search_message()
*/
int messages_free_message_array(messages_message_h *message_array);
/**
* @brief Retrieves the searched messages by invoking the given callback function iteratively.
*
* @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/message.read
*
* @param[in] service The message service handle
* @param[in] mbox The message box type
* @param[in] type The message type \n
* If @a type is #MESSAGES_TYPE_UNKNOWN, all SMS and MMS messages are searched.
* @param[in] keyword The keyword search in the text and subject
* @param[in] address The recipient address
* @param[in] offset The start position (base 0)
* @param[in] limit The maximum amount of messages to get \n
* In case of @c 0, this method passes to the callback all searched messages.
* @param[in] callback The callback function to get a message
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MESSAGES_ERROR_OPERATION_FAILED Messaging operation failed
* @retval #MESSAGES_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @post It invokes messages_search_cb().
*
* @see messages_search_cb()
*/
int messages_foreach_message(messages_service_h service,
messages_message_box_e mbox,
messages_message_type_e type,
const char *keyword, const char *address,
int offset, int limit,
messages_search_cb callback, void *user_data);
/**
* @brief Registers a callback to be invoked when an incoming message is received.
*
* @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/message.read
*
* @param[in] service The message service handle
* @param[in] callback The callback function
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_OPERATION_FAILED Messaging operation failed
* @retval #MESSAGES_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @post It will invoke messages_incoming_cb().
*
* @see messages_unset_message_incoming_cb()
* @see messages_incoming_cb()
*/
int messages_set_message_incoming_cb(messages_service_h service, messages_incoming_cb callback, void *user_data);
/**
* @brief Unregisters the callback function.
*
* @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/message.write
*
* @param[in] service The message service handle
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @see messages_set_message_incoming_cb()
* @see messages_incoming_cb()
*/
int messages_unset_message_incoming_cb(messages_service_h service);
/**
* @brief Adds an additional listening port for the incoming SMS messages.
*
* @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/message.read
*
* @param[in] service The message service handle
* @param[in] port The listening port for the SMS messages
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @see messages_set_message_incoming_cb()
* @see messages_get_message_port()
*/
int messages_add_sms_listening_port(messages_service_h service, int port);
/**
* @addtogroup CAPI_MESSAGING_MESSAGES_MMS_MODULE
* @{
*/
/**
* @brief Sets the subject of the message.
*
* @since_tizen 2.3
*
* @param[in] msg The message handle
* @param[in] subject The subject of the message \n
* The maximum length of @a subject is @c 120.
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @pre @a msg is created as a #MESSAGES_TYPE_MMS.
*
* @see messages_mms_get_subject()
*/
int messages_mms_set_subject(messages_message_h msg, const char *subject);
/**
* @brief Gets the subject of the message.
*
* @since_tizen 2.3
*
* @remarks You must release @a subject using free().
*
* @param[in] msg The message handle
* @param[out] subject The subject of the message
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @pre @a msg is created as a #MESSAGES_TYPE_MMS.
*
* @see messages_mms_set_subject()
*/
int messages_mms_get_subject(messages_message_h msg, char **subject);
/**
* @brief Adds the attachment to the MMS message.
*
* @since_tizen 2.3
*
* @param[in] msg The message handle
* @param[in] type The attachment type
* @param[in] path The file path to attach \n
* The maximum length of @a path is @c 1024.
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @pre @a msg is created as a #MESSAGES_TYPE_MMS.
*
* @see messages_mms_get_attachment()
* @see messages_mms_get_attachment_count()
* @see messages_mms_remove_all_attachments()
*/
int messages_mms_add_attachment(messages_message_h msg, messages_media_type_e type, const char *path);
/**
* @brief Gets the file path of the attachment with the specified index.
*
* @since_tizen 2.3
*
* @remarks You must release @a path using free().
*
* @param[in] msg The message handle
* @param[in] index The zero-based index of the attachment
* @param[out] type The attachment type
* @param[out] path The file path to attach
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @pre @a msg is created as a #MESSAGES_TYPE_MMS.
*
* @see messages_mms_add_attachment()
* @see messages_mms_get_attachment_count()
* @see messages_mms_remove_all_attachments()
*/
int messages_mms_get_attachment(messages_message_h msg, int index, messages_media_type_e *type, char **path);
/**
* @brief Gets the attachment with the specified index.
*
* @since_tizen 2.3
*
* @param[in] msg The message handle
* @param[out] count The total number of attachments
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @pre @a msg is created as a #MESSAGES_TYPE_MMS.
*
* @see messages_mms_add_attachment()
* @see messages_mms_get_attachment()
* @see messages_mms_remove_all_attachments()
*/
int messages_mms_get_attachment_count(messages_message_h msg, int *count);
/**
* @brief Removes all attachments to the MMS message.
*
* @since_tizen 2.3
*
* @param[in] msg The message handle
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
* @pre @a msg is created as a #MESSAGES_TYPE_MMS.
*
* @see messages_mms_add_attachment()
* @see messages_mms_get_attachment()
* @see messages_mms_get_attachment_count()
*/
int messages_mms_remove_all_attachments(messages_message_h msg);
/**
* @}
*/
/**
* @addtogroup CAPI_MESSAGING_MESSAGES_PUSH_MODULE
* @{
*/
/**
* @brief Registers a callback to be invoked when an WAP Push message is received.
*
* @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/message.read
*
* @param[in] service The message service handle
* @param[in] app_id The "X-WAP-Application-ID" to indicate a destination WAP Push application ID
* @param[in] callback The callback function
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*/
int messages_push_add_incoming_cb(messages_service_h service, const char *app_id,
messages_push_incoming_cb callback, void *user_data);
/**
* @brief Unregisters the WAP push incoming callback function.
*
* @since_tizen 2.3
*
* @param[in] service The message service handle
* @param[in] app_id The "X-WAP-Application-ID" to indicate a destination WAP Push application ID
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*/
int messages_push_remove_incoming_cb(messages_service_h service, const char *app_id);
/**
* @brief Registers an application to the mapping table of the WAP Push service.
*
* @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/message.write
*
* @param[in] service The message service handle
* @param[in] content_type The MIME content type of the content
* @param[in] app_id The "X-WAP-Application-ID" to indicate a destination WAP Push application ID
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*/
int messages_push_register(messages_service_h service, const char *content_type, const char *app_id);
/**
* @brief De-registers an application from the mapping table of the WAP Push service.
*
* @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/message.write
*
* @param[in] service The message service handle
* @param[in] content_type The MIME content type of the content
* @param[in] app_id The "X-WAP-Application-ID" to indicate a destination WAP Push application ID
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*/
int messages_push_deregister(messages_service_h service, const char *content_type, const char *app_id);
/**
* @brief Re-registers an application to the mapping table of the WAP Push service.
*
* @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/message.write
*
* @param[in] service The message service handle
* @param[in] content_type An element of the composite key for searching registered entry \n
* The MIME content type of the content.
* @param[in] app_id The composite key for searching mapping information \n
* The "X-WAP-Application-ID" to indicate a destination WAP Push application ID.
* @param[in] dst_content_type The MIME content type of the content
* @param[in] dst_app_id The "X-WAP-Application-ID" to indicate a destination WAP Push application ID
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MESSAGES_ERROR_NONE Successful
* @retval #MESSAGES_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MESSAGES_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
* @retval #MESSAGES_ERROR_NOT_SUPPORTED Not supported
*
*/
int messages_push_reregister(messages_service_h service, const char *content_type, const char *app_id,
const char *dst_content_type, const char *dst_app_id);
/**
* @}
*/
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#endif /* __TIZEN_MESSAGING_H__ */
|
