michael@0: /* -*- Mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; tab-width: 40 -*- */
michael@0: /* vim: set ts=2 et sw=2 tw=40: */
michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
michael@0:  * You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #include "nsISupports.idl"
michael@0: 
michael@0: [scriptable, uuid(efd352af-9eee-48dc-8e92-4d4fdbc89ecb)]
michael@0: interface nsIDOMMozVoicemailStatus : nsISupports
michael@0: {
michael@0:   readonly attribute unsigned long serviceId;
michael@0: 
michael@0:   /**
michael@0:    * Whether or not there are messages waiting in the voicemail box
michael@0:    */
michael@0:   readonly attribute boolean hasMessages;
michael@0: 
michael@0:   /**
michael@0:    * The total message count. Some voicemail indicators will only specify that
michael@0:    * messages are waiting, but not the actual number. In that case, the value
michael@0:    * of messageCount will be -1, indicating the unknown message count.
michael@0:    *
michael@0:    * Logic for a voicemail notification might look something like:
michael@0:    * if (status.hasMessages) {
michael@0:    *   // show new voicemail notification
michael@0:    *   if (status.messageCount > 0) {
michael@0:    *     // add a label for the message count
michael@0:    *   }
michael@0:    * } else {
michael@0:    *   // hide the voicemail notification
michael@0:    * }
michael@0:    */
michael@0:   readonly attribute long messageCount;
michael@0: 
michael@0:   /**
michael@0:    * Return call number received for this voicemail status, or null if one
michael@0:    * wasn't provided.
michael@0:    */
michael@0:   readonly attribute DOMString returnNumber;
michael@0: 
michael@0:   /**
michael@0:    * Displayable return call message received for this voicemail status, or null
michael@0:    * if one wasn't provided.
michael@0:    */
michael@0:   readonly attribute DOMString returnMessage;
michael@0: };