The Bondi Communication Log Module: bondi.commlog - Version 1.0

Methods

getSMSLog

Get the list of selected SMSs

Signature

PendingOperation getSMSLog(CommLogSMSSuccessCallback successCallback, ErrorCallback errorCallback, ShortArray messageFolders, Map filter);

Gets an array of Strings containing IDs for sms messages stored within the selected folders and matching the selected filter.

This is an asynchronous method.

In a search using this method, if more than one value is used, then the AND operator will be used betwwen all values to perform the search.

In a search using strings, the search conductes is case sensitive. If the string is found anywhere inside the key object value, the entire object will be returned.

Parameters

• successCallback: function called when the invocation ends successfully, the response object is used to retrieve the array of SMS objects.
• errorCallback: function called when an error occurs, the input parameter is an Error object with a code giving information about the type of error that occurred.
• messageFolders: Array of ints stating in which message folders the web app has to look for messages. It can't be null. Array values must be 0 (INBOX_FOLDER),1 (SENT_FOLDER),2 (OUTBOX_FOLDER) or 3 (DRAFT_FOLDER).
• filter: Array of key-value pairs acting as a filter for searching messages. Supported keys:
  body: String. This represents the body of the sms
  recipients: String. Semicolom(;) separated string containing the recipients list
  store: Boolean. Indicates if the sms will be stored in the sent messages folder. True -> Stored
  Supported keys are also returned in a string array by getSMSSupportedPropertyKeys.

Return value

PendingOperation in order to cancel the async call.

Exceptions

• SecurityError: PERMISSION_DENIED_ERROR when access is denied by the security policy.
• DeviceAPIError: INVALID_ARGUMENT if parameters are not valid If parameters are not valid If folder isn't one of the following: INBOX_FOLDER,SENT_FOLDER, OUTBOX_FOLDER or DRAFT_FOLDER If some of the filter parameters are not supported

API features

http://bondi.omtp.org/api/commlog.sms.get

Code example

        bondi.commlog.getSMSLog(successCallback, errorCallback,
                { bondi.commlog.INBOX_FOLDER, bondi.commlog.OUTBOX_FOLDER}, 
                { Recipient:"+34666666666", Body:"Huesca"});

        function successCallback(response) {
                var messages = response;
                // Get first message in the list of results
                var sms = messages[0];
        }
 
        function errorCallback(response) {
                alert( "The following error code is: " +  response.code);
        }
 

getMMSLog

Get the list of selected MMSs

Signature

PendingOperation getMMSLog(CommLogMMSSuccessCallback successCallback, ErrorCallback errorCallback, ShortArray messageFolders, Map filter);

Gets an array of Strings containing IDs for MMS messages stored within the selected folders matching the selected filter.

In a search using this method, if more than one value is used, then the AND operator will be used betwwen all values to perform the search.

In a search using strings, the search conductes is case sensitive. If the string is found anywhere inside the key object value, the entire object will be returned.

This is an asynchronous method.

Parameters

• successCallback: function called when the invocation ends successfully, use response object to retrieve the array of MMS objects.
• errorCallback: function called when an error occurs, the input parameter is an Error object with a code giving information about the type of error that occurred.
• messageFolders: Array of ints stating in which message folders the web app has to look for messages. It can't be null. Array values must be 0 (INBOX_FOLDER),1 (SENT_FOLDER),2 (OUTBOX_FOLDER) or 3 (DRAFT_FOLDER).
• filter: Array of key-value pairs acting as a filter for searching messages. Supported keys:
  body: String. This represents the body of the mms as defined in
  recipients: String. Semicolom(;) separated string containing the recipients' addresses as defined
  store: Boolean. Indicates if the mms will be stored in the sent messages folder. True -> Stored
  attachments: String with the file name or path. It's the file attached to the mms.
  Supported keys are also returned in a string array by getMMSSupportedPropertyKeys method

Return value

PendingOperation in order to cancel the async call.

Exceptions

• SecurityError: PERMISSION_DENIED_ERROR when access is denied by the security policy.
• DeviceAPIError: INVALID_ARGUMENT If parameters are not valid If folder isn't one of the following: INBOX_FOLDER,SENT_FOLDER, OUTBOX_FOLDER or DRAFT_FOLDER If some of the filter parameters are not supported.

API features

http://bondi.omtp.org/api/commlog.mms.get

Code example

        bondi.commlog.getMMSLog(successCallback, errorCallback,
                { bondi.commlog.INBOX_FOLDER, bondi.commlog.OUTBOX_FOLDER}, 
                {Recipient:"+34666666666", Body:"Huesca"});
 
        function successCallback(response) {
                var messages = response;
                // Get first MMS in the list of results
                var mms = messages[0];
        }
 
        function errorCallback(response) {
                alert( "The following error code is: " +  response.code);
        }
 

getEmailLog

Get the list of selected Emails

Signature

PendingOperation getEmailLog(CommLogEmailSuccessCallback successCallback, ErrorCallback errorCallback, ShortArray messageFolders, Map filter);

In a search using this method, if more than one value is used, then the AND operator will be used betwwen all values to perform the search.

In a search using strings, the search conductes is case sensitive. If the string is found anywhere inside the key object value, the entire object will be returned.

Parameters

• successCallback: function called when the invocation ends successfully, the response object is used to retrieve the array of Strings containing message IDs.
• errorCallback: function called when an error occurs, the input parameter is an Error object with a code giving information about the type of error that occurred.
• messageFolders: Array of Ints stating in which message folders the web app should look for messages.It can't be null. Array values must be 0 (INBOX_FOLDER),1 (SENT_FOLDER),2 (OUTBOX_FOLDER) or 3 (DRAFT_FOLDER).
• filter: Array of key-value pairs acting as a filter for searching messages.
  from: String. The address used to send the email. It must be configured on the default messaging application of the phone. Addresses should be of the format defined in RFC 5322 3.4
  to: String. Semicolom(;) separated string containing the recipients list. Addresses should be of the format defined in RFC 5322 3.4
  cc: String. Semicolom(;) separated string containing the cc recipients list. Addresses should be of the format defined in RFC 5322 3.4
  bcc: String. Semicolom(;) separated string containing the bcc recipients list. Addresses should be of the format defined in RFC 5322 3.4
  subject: String. Resume of the email content in the format defined in RFC 5322 2.2
  body: String. Email text in the format defined in RFC 5322 2.3
  attachments: String with the file name or path. It's the file attached to the email.
  store: Boolean. Indicates if the mms will be stored in the sent messages folder. True -> Stored Supported keys are also returned in a string array by getEmailSupportedPropertyKeys method.

Return value

PendingOperation in order to cancel the async call.

Exceptions

• SecurityError: PERMISSION_DENIED_ERROR when access is denied by the security policy.
• DeviceAPIError: INVALID_ARGUMENT If parameters are not valid. If folder isn't one of the following: INBOX_FOLDER,SENT_FOLDER, OUTBOX_FOLDER or DRAFT_FOLDER. If some of the filter parameters are not supported.

API features

http://bondi.omtp.org/api/commlog.email.get

Code example

        bondi.commlog.getEmailLog(successCallback, errorCallback,
                { bondi.commlog.INBOX_FOLDER, bondi.commlog.OUTBOX_FOLDER}, 
                { Recipient:"+34666666666", Body:"Huesca"});
 
        function successCallback(response) {
                var messages = response;
                // Get first email in the list of results
                var email = messages[0];
        }
 
        function errorCallback(response) {
                alert( "The following error code is: " +  response);
        }
 

getCallLog

Get the list of selected Calls

Signature

PendingOperation getCallLog(CommLogCallSuccessCallback successCallback, ErrorCallback errorCallback, ShortArray callFolder, Map filter);

Gets an array of Strings containing IDs for calls stored within the selected folders and matching the selected filter.

In a search using this method, if more than one value is used, then the AND operator will be used betwwen all values to perform the search.

In a search using strings, the search conductes is case sensitive. If the string is found anywhere inside the key object value, the entire object will be returned.

This is an asynchronous method.

Parameters

• successCallback: function called when the invocation ends successfully, the response object is used to retrieve the array of Strings containing call IDs.
• errorCallback: function called when an error occurs, the input parameter is an Error object with a code giving information about the type of error that occurred.
• callFolder: Array of Ints stating in which message folders the web app should loook for calls. It can't be null. Array values must be 0 (MISSED_CALLS_FOLDER),1(RECEIVED_CALLS_FOLDER) or 2(INITIATED_CALLS_FOLDER).
• filter: Array of key-value pairs acting as a filter for searching calls. Supported keys:
  phoneNumber: String. The destination or the caller phone number
  startTime: Date. The datetime when the call was done, receieved or missed.
  duration: Long. Time in seconds with the duration of the call Supported keys are returned in a string array by getCallSupportedPropertyKeys.

Return value

PendingOperation in order to cancel the async call.

Exceptions

• SecurityError: PERMISSION_DENIED_ERROR when access is denied by the security policy.
• DeviceAPIError: INVALID_ARGUMENT If parameters are not valid. If folder isn't one of the following: MISSED_CALLS_FOLDER, RECEIVED_CALLS_FOLDER or INITIATED_CALLS_FOLDER. If some of the filter parameters are not supported.

Code example

        var callsArray = new Array();
        callsArray.push(bondi.commlog.MISSED_CALLS_FOLDER);
        callsArray.push(bondi.commlog.RECEIVED_CALLS_FOLDER);
        bondi.commlog.getCallsLog(successCallback,errorCallback,callsArray, {phoneNumber:"+34666666666"});

        function successCallback(response)
        {
                // Get first call in the list of results
                var myCall = response[0];
        }

        function errorCallback(response)
        {
                alert( "The following error code is: " +  response.code);
        }
 

getSMSSupportedPropertyKeys

Get the property keys of SMSs

Signature

StringArray getSMSSupportedPropertyKeys();

This method returns a list of the public SMS property keys. That is to say it returns all the parameters we can use to create an SMS (body, recipients, store...) and supported by the getSMSLog filter parameter.

Return value

Array of Strings containing the names of the message object public properties.

Code example

        var myBody = "New body for a draft message";
        var attributes = bondi.commlog.getSMSSupportedPropertyKeys();
        if (attributes[1] == "body") {
                var sms = bondi.messaging.createSMS();
                sms.setProperty(attributes[1],myBody);
        }
 

getMMSSupportedPropertyKeys

Get the property keys of MMSs

Signature

StringArray getMMSSupportedPropertyKeys();

This method returns a list of the public MMS property keys. That is to say it returns all the parameters we can use to create an MMS (body, recipients, store, attachments...) and supported by the getMMSLog filter parameter.

Return value

Array of Strings containing the names of the message object public properties.

Code example

        var myBody = "New body for a draft message";
        var attributes = bondi.commlog.getMMSSupportedPropertyKeys();
        if (attributes[1] == "body") {
                var mms = bondi.messaging.createMMS();
                mms.setProperty(attributes[1], myBody);
        }
 

getEmailSupportedPropertyKeys

Get the property keys of Emails

Signature

StringArray getEmailSupportedPropertyKeys();

This method returns a list of the public Email property keys. That is to say it returns all the parameters we can use to create an Email (body, subject, store, attachments...) and supported by the getEmaillLog filter parameter.

Return value

Array of Strings containing the names of the message object public properties.

Code example

        var myBody = "New body for a draft message";
        var attributes = bondi.commlog.getEmailSupportedPropertyKeys();
        if (attributes[1] == "body") {
                var email = bondi.messaging.createEmail();
                email.setProperty(attributes[1], myBody);
        }
 

getCallSupportedPropertyKeys

Gets the call attributes supported by the getCallLog filter parameter.

Signature

StringArray getCallSupportedPropertyKeys();

Return value

Array of Strings containing the names of the call object public properties.

Code example

        var attributes = bondi.commlog.getCallSupportedPropertyKeys();
        if (attributes[1] == "phoneNumber") {
                var phoneNumber = call.getProperty(attributes[1]);
        }