MozillaWiki

WebAPI/LogAPI: Difference between revisions

Page Discussion

WebAPI/LogAPI (view source)

Revision as of 23:53, 1 October 2014

2,287 bytes added ,  1 October 2014
no edit summary
No edit summary
 
(42 intermediate revisions by one other user not shown)
Line 1: Line 1:
== Proposer ==
José M. Cantera, Telefónica, jmcf@tid.es
== Use Cases ==
== Use Cases ==


To record the history of user activity with the device, particularly with communication services (Phone Calls, Messages, Social Networks, etc.)  
To record the history of user activity with the device, particularly with communication services (Phone Calls, Messages, Social Networks, etc.)
The Communications Log can have different views: Global or Per-Contact
 
Using the API the occurrence of incoming calls, missed calls, incoming messages, outgoing messages etc. is automatically recorded.


=== Consumers ===
=== Consumers ===
Line 9: Line 16:
=== Producers ===  
=== Producers ===  


* Dialer, SMS, e-mail, Facebook, Twitter, ...  
* Dialer, SMS, e-mail, Facebook, Twitter, ...


== WebIDL ==
== WebIDL ==


<pre>
<pre>
[NoInterfaceObject]
interface NavigatorLog {
    readonly attribute LogManager mozLog;
};
Navigator implements NavigatorLog;
[NoInterfaceObject]
interface LogManager : EventTarget  {
interface LogManager : EventTarget  {
     DOMRequest put(LogEntry entry);
     DOMRequest put(LogEntry entry);
     DOMRequest delete(DOMString entryId);
     DOMRequest delete(DOMString entryId); // Delete one entry
     DOMRequest clear(LogClearOptions coptions);
     DOMRequest clear(LogClearOptions coptions); // To clear the log for maintenance purposes
     // Entries are always returned ordered by timestamp
     // Entries are always returned ordered by timestamp (desc)
     DOMRequest find(LogFindOptions options);
     DOMRequest find(optional LogFindFilter filter,optional IteratorOptions iopts);
          
          
   attribute Function onentryadded;
   attribute Function? onentryadded; // To listen for log changes
  };
  };


interface LogIterator
// The iterator will be initialized with a window indicated in the iteration parameters
{
[NoInterfaceObject]
   DOMRequest next(optional unsigned short n);
interface DOMIterator {
   attribute unsigned long position;
   DOMRequest next();  // request to refresh the window of objects with the next
  DOMRequest prev();  // request to refresh the window of objects with the prev
  DOMRequest skipTo(unsigned long chunk);
   readonly attribute boolean hasMore;
  readonly attribute unsigned long count;  // total number of objects
  readonly attribute any[]? values;  // Contains the current window of objects
  readonly attribute chunkSize;
};
};


dictionary LogFindFilter {
  DOMString? contactId;
  Date? from;  // for defining a time interval
  Date? to;      // for defining a time interval
  DOMString? service;  // to filter by service
  DOMString? type;    // to filter by Log type
};


dictionary LogFindOptions
dictionary LogClearOptions {
{
  Date deadline; // To clear all the entries older than the date passed as parameter
  attribute unsigned long maxRecords;
  DOMString? contactId; // To clear all the entries corresponding to a contact
  attribute DOMString contactId;
  DOMString? tel;           // To clear all the entries corresponding to a tel number
  attribute Date from;
  attribute Date to;
  attribute DOMString service;
};
};


interface LogEntryProperties  
dictionary IteratorOptions {
{
  unsigned long? maxRecords = -1;  // Max number of records to be returned (-1 means all)
   attribute DOMString type;                       // possible values: ['incoming', 'outgoing'']
  unsigned long? chunkSize = 10;    // Chunk size for the iterator
   attribute DOMString status;                   // [missed, new]
};
   attribute DOMString[] contactId;             // ContactId
 
   attribute DOMString[] tel;                       // Tel number if not in contacts
interface LogEntryProperties {
   attribute DOMString objectId;               // Object id (for example SMS message on the SMS database)
   attribute DOMString type; // possible values: ['incoming', 'outgoing'']
   attribute DOMString service;                 // oneOf ['SMS', 'Telephony', 'Facebook', 'Twitter']  
   attribute DOMString? status; // [missed, new]        
   attribute DOMString title;             
   attribute DOMString[]? contactId; // ContactId    
   attribute DOMString description;
   attribute DOMString[]? tel; // Tel number if not in contacts
   attribute any extra;                               // Any extra data to be used by applications
   attribute DOMString? objectId; // Object id (for example SMS message on the SMS database)  
   attribute DOMString service; // oneOf ['SMS', 'Telephony', 'Facebook', 'Twitter']  
   attribute DOMString? title;             
   attribute DOMString? description;
   attribute any? extra; // Any extra data to be used by applications
};
};


[Constructor(LogEntryProperties properties)]
[Constructor(LogEntryProperties properties)]
interface LogEntry : LogEntryProperties  
interface LogEntry : LogEntryProperties {
{
   readonly attribute DOMString id;
   readonly attribute DOMString id;
   readonly attribute DOMTimestamp timestamp;                  // When this happened
   readonly attribute DOMTimestamp timestamp;                  // When happened
};
};
</pre>
== Examples ==
Get latest global 30 log entries (ordered by timestamp, newest to oldest) in chunks of 10
<pre>
var pageOptions = {maxNumber: 30, chunkSize: 10};
var req = navigator.mozLog.find(null,pageOptions);
req.onsuccess = function(e) {
  var iterator = e.target.result;
 
  doSomething(iterator.values);
  if(iterator.hasMore) {
    iterator.next();
  }
}
</pre>
Get all the log entries corresponding to a contactId
<pre>
var filterOptions = {contactId: 'ax1234'};
var req = navigator.mozLog.find(filterOptions);
req.onsuccess = function(e) {
  var iterator = e.target.result;
 
  var logEntries = iterator.values;
  for(var c = 0; c < logEntries.length; c++) {
    window.console.log('LogEntry: ', logEntries[c].type,logEntries[c].timestamp);
  }
  if(iterator.hasMore) {
    iterator.next();
  }
}
</pre>
[[Category:Web APIs]]
Chaasof
Confirmed users
1,340

edits

Retrieved from "https://wiki.allizom.org/Special:MobileDiff/424413...1021386"