TS 29.198-15
Open Service Access (OSA) API –
Part 15: Multi-media Messaging (MM) Service Capability Feature (SCF)
V9.0.0 (PDF)
2009/12 98 p.
V8.0.0
2008/12 98 p.
V7.1.1
2007/12 98 p.
V6.6.1
2007/12 94 p.
- Rapporteur:
- Mr. Unmehopa, Musa
full Table of Contents for TS 29.198-15 Word version: 9.0.0
0 Introduction p. 7
1 Scope p. 9
2 References p. 9
3 Definitions and abbreviations p. 10
3.1 Definitions p. 10
3.2 Abbreviations p. 10
4 Multi Media Messaging SCF p. 10
5 Sequence Diagrams p. 11
5.1 Sending messages and receiving delivery notification p. 11
5.2 Sending, and receiving messages in same context p. 13
5.3 Setting notification of received messages p. 14
5.4 Using Mailbox functions p. 15
5.5 Using Mailbox to send and receive p. 17
5.6 Setting notification of received messages p. 19
6 Class Diagrams p. 20
7 The Service Interface Specifications p. 21
7.1 Interface Specification Format p. 21
7.1.1 Interface Class p. 21
7.1.2 Method descriptions p. 21
7.1.3 Parameter descriptions p. 21
7.1.4 State Model p. 21
7.2 Base Interface p. 22
7.3 Service Interfaces p. 22
7.3.1 Overview p. 22
7.4 Generic Service Interface p. 23
8 Multi Media Messaging Interface Classes p. 24
8.1 Interface Class IpMultiMediaMessagingManager p. 25
8.1.1 Method openMailbox() p. 25
8.1.2 Method openMultiMediaMessaging() p. 26
8.1.3 Method createNotification() p. 27
8.1.4 Method destroyNotification() p. 28
8.1.5 Method changeNotification() p. 28
8.1.6 Method getNextNotification() p. 28
8.1.7 Method enableNotifications() p. 29
8.1.8 Method disableNotifications() p. 30
8.2 Interface Class IpAppMultiMediaMessagingManager p. 31
8.2.1 Method mailboxTerminated() p. 31
8.2.2 Method reportNotification() p. 31
8.2.3 Method notificationsInterrupted() p. 32
8.2.4 Method notificationsResumed() p. 32
8.2.5 Method multiMediaMessagingTerminated() p. 32
8.2.6 Method terminateMultipleMailboxes() p. 32
8.2.7 Method terminateMultipleMultiMediaMessagingSessions() p. 33
8.3 Interface Class IpMailbox p. 34
8.3.1 Method close() p. 35
8.3.2 Method getMessageInfoPropertiesReq() p. 35
8.3.3 Method setMessageInfoPropertiesReq() p. 35
8.3.4 Method createFolderReq() p. 36
8.3.5 Method getFoldersReq() p. 36
8.3.6 Method deleteFolderReq() p. 37
8.3.7 Method copyFolderReq() p. 37
8.3.8 Method moveFolderReq() p. 38
8.3.9 Method putMessageReq() p. 38
8.3.10 Method copyMessageReq() p. 39
8.3.11 Method moveMessageReq() p. 40
8.3.12 Method deleteMessageReq() p. 40
8.3.13 Method listMessagesReq() p. 41
8.3.14 Method listMessageBodyPartsReq() p. 42
8.3.15 Method getMessageBodyPartsReq() p. 42
8.3.16 Method getMessageHeadersReq() p. 43
8.3.17 Method getMessageContentReq() p. 44
8.3.18 Method getFullMessageReq() p. 44
8.3.19 Method getMailboxInfoPropertiesReq() p. 45
8.3.20 Method getFolderInfoPropertiesReq() p. 45
8.4 Interface Class IpAppMailbox p. 47
8.4.1 Method getMessageInfoPropertiesRes() p. 48
8.4.2 Method setMessageInfoPropertiesRes() p. 49
8.4.3 Method setMessageInfoPropertiesErr() p. 49
8.4.4 Method getMailboxInfoPropertiesErr() p. 49
8.4.5 Method getFolderInfoPropertiesErr() p. 50
8.4.6 Method getMessageInfoPropertiesErr() p. 50
8.4.7 Method createFolderRes() p. 51
8.4.8 Method createFolderErr() p. 51
8.4.9 Method getFoldersRes() p. 51
8.4.10 Method getFoldersErr() p. 52
8.4.11 Method deleteFolderRes() p. 52
8.4.12 Method deleteFolderErr() p. 52
8.4.13 Method copyFolderRes() p. 53
8.4.14 Method copyFolderErr() p. 53
8.4.15 Method moveFolderRes() p. 54
8.4.16 Method moveFolderErr() p. 54
8.4.17 Method putMessageRes() p. 54
8.4.18 Method putMessageErr() p. 55
8.4.19 Method copyMessageRes() p. 55
8.4.20 Method copyMessageErr() p. 55
8.4.21 Method moveMessageRes() p. 56
8.4.22 Method moveMessageErr() p. 56
8.4.23 Method deleteMessageRes() p. 56
8.4.24 Method deleteMessageErr() p. 57
8.4.25 Method listMessagesRes() p. 57
8.4.26 Method listMessagesErr() p. 58
8.4.27 Method listMessageBodyPartsRes() p. 58
8.4.28 Method listMessageBodyPartsErr() p. 58
8.4.29 Method getMessageBodyPartsRes() p. 59
8.4.30 Method getMessageBodyPartsErr() p. 59
8.4.31 Method getMessageHeadersRes() p. 59
8.4.32 Method getMessageHeadersErr() p. 60
8.4.33 Method getMessageContentRes() p. 60
8.4.34 Method getMessageContentErr() p. 61
8.4.35 Method getFullMessageRes() p. 61
8.4.36 Method getFullMessageErr() p. 61
8.4.37 Method getMailboxInfoPropertiesRes() p. 62
8.4.38 Method getFolderInfoPropertiesRes() p. 62
8.5 Interface Class IpMultiMediaMessaging p. 63
8.5.1 Method sendMessageReq() p. 63
8.5.2 Method cancelMessageReq() p. 64
8.5.3 Method queryStatusReq() p. 65
8.5.4 Method close() p. 65
8.5.5 Method sendMessageWithNotifyReq() p. 66
8.6 Interface Class IpAppMultiMediaMessaging p. 68
8.6.1 Method sendMessageRes() p. 68
8.6.2 Method sendMessageErr() p. 69
8.6.3 Method cancelMessageRes() p. 69
8.6.4 Method cancelMessageErr() p. 69
8.6.5 Method queryStatusRes() p. 70
8.6.6 Method queryStatusErr() p. 70
8.6.7 Method messageStatusReport() p. 70
8.6.8 Method messageReceived() p. 71
8.6.9 Method sendMessageWithNotifyRes() p. 71
8.6.10 Method sendMessageWithNotifyErr() p. 72
9 State Transition Diagrams p. 73
10 Multi-Media Messaging Service Properties p. 73
11 Data Definitions p. 74
11.1 Multi-Media Messaging data definitions p. 74
11.1.1 IpMultiMediaMessagingManager p. 74
11.1.2 IpMultiMediaMessagingManagerRef p. 74
11.1.3 IpAppMultiMediaMessagingManager p. 74
11.1.4 IpAppMultiMediaMessagingManagerRef p. 74
11.1.5 IpMailbox p. 74
11.1.6 IpMailboxRef p. 74
11.1.7 IpAppMailbox p. 74
11.1.8 IpAppMailboxRef p. 74
11.1.9 IpMultiMediaMessaging p. 74
11.1.10 IpMultiMediaMessagingRef p. 74
11.1.11 IpAppMultiMediaMessaging p. 74
11.1.12 IpAppMultiMediaMessagingRef p. 75
11.1.13 TpBodyPartDescription p. 75
11.1.14 TpBodyPartDescriptionList p. 75
11.1.15 TpBodyPart p. 75
11.1.16 TpBodyPartList p. 75
11.1.17 TpDeliveryTime p. 75
11.1.18 TpDeliveryTimeType p. 76
11.1.19 TpFolderInfoProperty p. 76
11.1.20 TpFolderInfoPropertyName p. 76
11.1.21 TpFolderInfoPropertySet p. 76
11.1.22 TpGenericHeaderField p. 76
11.1.23 TpListMessagesCriteria p. 77
11.1.24 TpMailboxFolderStatusInformation p. 77
11.1.25 TpMailboxIdentifier p. 77
11.1.26 TpMailboxIdentifierSet p. 77
11.1.27 TpMailboxInfoProperty p. 77
11.1.28 TpMailboxInfoPropertyName p. 77
11.1.29 TpMailboxInfoPropertySet p. 78
11.1.30 TpMailboxMessageStatus p. 78
11.1.31 TpMessageDeliveryType p. 78
11.1.32 TpMessageInfoProperty p. 78
11.1.33 TpMessageInfoPropertyName p. 79
11.1.34 TpMessageInfoPropertySet p. 79
11.1.35 TpMessageHeaderFieldType p. 80
11.1.36 TpMessageHeaderField p. 81
11.1.37 TpMessageHeaderFieldSet p. 81
11.1.38 TpMessagePriority p. 81
11.1.39 TpMessageDeliveryReportType p. 82
11.1.40 TpMessageTreatment p. 82
11.1.41 TpMessageTreatmentType p. 82
11.1.42 TpMessageTreatmentSet p. 82
11.1.43 TpMultiMediaMessagingIdentifier p. 82
11.1.44 TpMultiMediaMessagingIdentifierSet p. 83
11.1.45 TpQueryStatusReport p. 83
11.1.46 TpQueryStatusReportSet p. 83
11.1.47 TpTerminatingAddressList p. 83
11.2 Event Notification data definitions p. 84
11.2.1 TpMessagingEventName p. 84
11.2.2 TpMessagingEventCriteria p. 84
11.2.3 TpMessagingEventCriteriaSet p. 84
11.2.4 TpNewMailboxMessageArrivedCriteria p. 84
11.2.5 TpNewMessageArrivedCriteria p. 85
11.2.6 TpMessagingEventInfo p. 85
11.2.7 TpMessagingEventInfoSet p. 85
11.2.8 TpNewMailboxMessageArrivedInfo p. 85
11.2.9 TpNewMessageArrivedInfo p. 86
11.2.10 TpMessageDescription p. 86
11.2.11 TpMessageDescriptionList p. 86
11.2.12 TpMessagingNotificationRequested p. 86
11.2.13 TpMessagingNotificationRequestedSet p. 86
11.2.14 TpMessagingNotificationRequestedSetEntry p. 87
11.2.15 TpNewMessageStatusReportArrivedInfo p. 87
11.3 Error type data definitions p. 88
12 Exception Classes p. 90
A (Normative) OMG IDL Description of Multi-Media Messaging SCF p. 91
B W3C WSDL Description of Multi-Media Messaging SCF p. 92
C Java API Description of the Multi-Media Messaging SCF p. 93
D Description of Parlay X Web Services Part 1: Common Definitions Multi Media Messaging for 3GPP2 cdma2000 networks p. 94
D.1 General Exceptions p. 94
D.2 Specific Exceptions p. 94
D.2.1 Clause 1: Scope p. 94
D.2.2 Clause 2: References p. 94
D.2.3 Clause 3: Definitions and abbreviations p. 94
D.2.4 Clause 4: Multi Media Messaging SCF p. 94
D.2.5 Clause 5: Sequence Diagrams p. 94
D.2.6 Clause 6: Class Diagrams p. 95
D.2.7 Clause 7: The Service Interface Specifications p. 95
D.2.8 Clause 8: Multi Media Messaging Interface Classes p. 95
D.2.9 Clause 9: State Transition Diagrams p. 95
D.2.10 Clause 10: Multi-Media Messaging Service Properties p. 95
D.2.11 Clause 11: Data Definitions p. 95
D.2.12 Clause 12: Exception Classes p. 95
D.2.13 Annex A (normative): OMG IDL Description of Multi-Media Messaging SCF p. 95
D.2.14 Annex B (informative): W3C WSDL Description of Multi-Media Messaging SCF p. 95
D.2.15 Annex C (informative): Java API Description of the Multi-Media Messaging SCF p. 95
$ Change history p. 96
