|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.gsm.oneapi.mms.MMSRetrieve
public class MMSRetrieve
Field Summary | |
---|---|
static boolean |
dumpRequestAndResponse
|
Constructor Summary | |
---|---|
MMSRetrieve(ServiceEndpoints endPoints,
java.lang.String authorisationHeader)
Creates a new instance of the Receive MMS API main interface. |
Method Summary | |
---|---|
int |
cancelReceiptNotifications(java.lang.String subscriptionId)
Stop subscribing to message receipt notifications for all your received SMS |
RetrieveMMSMessageResponse |
retrieveMessageContent(java.lang.String registrationId,
java.lang.String messageId,
java.lang.String resFormat)
Retrieve the full contents of an MMS message (including attachments) sent to your Web application |
RetrieveMMSResponse |
retrieveMessages(java.lang.String registrationId,
int maxBatchSize)
Retrieve a list of MMS messages sent to your Web application |
void |
setAuthorisationHeader(java.lang.String authorisationHeader)
Can be used to update the service authorisation header |
void |
setEndpoints(ServiceEndpoints endPoints)
Can be used to update the service endpoints |
MMSMessageReceiptSubscriptionResponse |
subscribeToReceiptNotifications(java.lang.String destinationAddress,
java.lang.String notifyURL,
java.lang.String criteria,
java.lang.String notificationFormat,
java.lang.String clientCorrelator,
java.lang.String callbackData)
Start subscribing to notifications of MMS messages sent to your application |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static boolean dumpRequestAndResponse
Constructor Detail |
---|
public MMSRetrieve(ServiceEndpoints endPoints, java.lang.String authorisationHeader)
endPoints
- contains a set of service/ call specific endpointsauthorisationHeader
- Base 64 encoded username/ passwordServiceEndpoints
,
JSONRequest.getAuthorisationHeader(String, String)
Method Detail |
---|
public void setEndpoints(ServiceEndpoints endPoints)
endPoints
- contains a set of service/ call specific endpointsServiceEndpoints
public void setAuthorisationHeader(java.lang.String authorisationHeader)
authorisationHeader
- Base 64 encoded username/ passwordJSONRequest.getAuthorisationHeader(String, String)
public RetrieveMMSResponse retrieveMessages(java.lang.String registrationId, int maxBatchSize)
registrationId
- (mandatory) is agreed with your network operator for receiving messagesmaxBatchSize
- (mandatory) is the maximum number of messages to retrieve in this requestRetrieveMMSResponse
public RetrieveMMSMessageResponse retrieveMessageContent(java.lang.String registrationId, java.lang.String messageId, java.lang.String resFormat)
registrationId
- (mandatory) is agreed with your network operator for receiving messagesmessageId
- (mandatory) is the messageId obtained from the {link retrieveMessages} functionresFormat
- (mandatory) specifies the response format required. The only permitted value for verions 1 of OneAPI is 'JSON' ensuring a JSON Content-TypeRetrieveMMSMessageResponse
public MMSMessageReceiptSubscriptionResponse subscribeToReceiptNotifications(java.lang.String destinationAddress, java.lang.String notifyURL, java.lang.String criteria, java.lang.String notificationFormat, java.lang.String clientCorrelator, java.lang.String callbackData)
destinationAddress
- (mandatory) is the address/ MSISDN, or code agreed with the operator, to which people may send an MMS to your applicationnotifyURL
- (mandatory) is the URL to which you would like a notification of message receipts sentcriteria
- (optional) is case-insensitve text to match against the first word of the message, ignoring any leading whitespace. This allows you to reuse a short code among various applications, each of which can register their own subscription with different criterianotificationFormat
- (optional) is the content type that notifications will be sent in Ð for OneAPI v1.0 only JSON is supportedclientCorrelator
- (optional) uniquely identifies this create subscription request. If there is a communication failure during the request, using the same clientCorrelator when retrying the request allows the operator to avoid creating a duplicate subscriptioncallbackData
- (optional) is a function name or other data that you would like included when the POST is sent to your applicationMMSMessageReceiptSubscriptionResponse
public int cancelReceiptNotifications(java.lang.String subscriptionId)
subscriptionId
- (mandatory) contains the subscriptionId of a previously created SMS message receipt subscription
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |