mirror of
https://repo.dactyloidae.xyz/Dactyloidae/UXP.git
synced 2026-09-26 02:17:34 +09:00
92 lines
3.7 KiB
Text
92 lines
3.7 KiB
Text
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#include "nsIAbItem.idl"
|
|
|
|
interface nsIAbCard;
|
|
interface nsISimpleEnumerator;
|
|
|
|
/**
|
|
* A collection of address book items.
|
|
*/
|
|
[scriptable, uuid(70f6123f-e06b-4101-9750-4ce73b38134b)]
|
|
interface nsIAbCollection : nsIAbItem {
|
|
|
|
/**
|
|
* Returns true if this collection is read-only.
|
|
*/
|
|
readonly attribute boolean readOnly;
|
|
|
|
/**
|
|
* Returns true if this collection is accessed over a network connection.
|
|
*/
|
|
readonly attribute boolean isRemote;
|
|
|
|
/**
|
|
* Returns true if this collection is accessed over a secure connection.
|
|
*
|
|
* If isRemote returns false, then this value MUST be false as well.
|
|
*/
|
|
readonly attribute boolean isSecure;
|
|
|
|
/**
|
|
* Returns an address book card for the specified email address if found.
|
|
*
|
|
* If there are multiple cards with the given email address, this method will
|
|
* return one of these cards in an implementation-defined manner.
|
|
*
|
|
* Matching is performed in a case-insensitive manner.
|
|
*
|
|
* This method performs a synchronous operation. If the collection cannot do
|
|
* the search in such a manner, then it should throw NS_ERROR_NOT_IMPLEMENTED.
|
|
*
|
|
* @param emailAddress The email address to find in any of the email address
|
|
* fields. If emailAddress is empty, the database won't
|
|
* be searched and the function will return as if no card
|
|
* was found.
|
|
* @return An nsIAbCard if one was found, else returns NULL.
|
|
* @exception NS_ERROR_NOT_IMPLEMENTED If the collection cannot do this.
|
|
*/
|
|
nsIAbCard cardForEmailAddress(in AUTF8String emailAddress);
|
|
|
|
/**
|
|
* Returns an address book card for the specified property if found.
|
|
*
|
|
* If there are multiple cards with the given value for the property, this
|
|
* method will return one of these cards in an implementation-defined manner.
|
|
*
|
|
* This method performs a synchronous operation. If the collection cannot do
|
|
* the search in such a manner, then it should throw NS_ERROR_NOT_IMPLEMENTED.
|
|
*
|
|
* If the property is not natively a string, it can still be searched for
|
|
* using the string-encoded value of the property, e.g. "0". See
|
|
* nsIAbCard::getPropertyAsAUTF8String for more information. Empty values will
|
|
* return no match, to prevent spurious results.
|
|
*
|
|
* @param aProperty The property to look for.
|
|
* @param aValue The value to search for.
|
|
* @param aCaseSensitive True if matching should be done case-sensitively.
|
|
* @result An nsIAbCard if one was found, else returns NULL.
|
|
* @exception NS_ERROR_NOT_IMPLEMENTED If the collection cannot do this.
|
|
*/
|
|
nsIAbCard getCardFromProperty(in string aProperty, in AUTF8String aValue,
|
|
in boolean aCaseSensitive);
|
|
|
|
/**
|
|
* Returns all address book cards with a specific property matching value
|
|
*
|
|
* This function is almost identical to getCardFromProperty, with the
|
|
* exception of returning all cards rather than just the first.
|
|
*
|
|
* @param aProperty The property to look for.
|
|
* @param aValue The value to search for.
|
|
* @param aCaseSensitive True if matching should be done case-sensitively.
|
|
* @result A nsISimpleEnumerator that holds nsIAbCard
|
|
* instances.
|
|
*/
|
|
nsISimpleEnumerator getCardsFromProperty(in string aProperty,
|
|
in AUTF8String aValue,
|
|
in boolean aCaseSensitive);
|
|
};
|