IAdblockPlus

General notes

Esta interfaz esta diseñada para ser utilizada por aquellas extensiones que quieran integrarse con Adblock Plus. Entre otras cosas, permite obtener información de Adblock Plus o añadir suscripciones "especiales" que serán actualizadas por otra extensión.

if ("@adblockplus.org/abp/public;1" in Components.classes)
{
  var abpURL = Components.classes["@adblockplus.org/abp/public;1"]
                         .getService(Components.interfaces.nsIURI);
  var AdblockPlus = Components.utils.import(abpURL.spec, null).AdblockPlus;
  alert(AdblockPlus.subscriptionCount);
}
else
{
  // Adblock Plus is not installed
}

Methods and properties


void addPatterns ( arrayof wstring patterns )

Añade patrones a la lista de filtros definidos por el usuario

Version:
0.7.2.3 and higher
Arguments:
patterns: lista de patrones a añadir

AString getInstalledVersion ( )

Devuelve la versión de la extensión Adblock Plus instalada. Tenga en cuenta que se trata del número de versión que le entregan o bien el Administrador de extensiones o bien InstallTrigger, y que podría ser incorrecto si se usa este último (en Mozilla Suite o SeaMonkey).

Returns:
Versión de Adblock Plus, por ejemplo 0.7.0.1

IAdblockPlusSubscription getSubscription ( AString id )

Devuelve una suscripción a partir de su identificador

Arguments:
id: identificador de la suscripción (en las suscripciones normales es la URL de la suscripción)
Returns:
la suscripción solicitada o null si no existe ninguna suscripción con el identificador elegido

IAdblockPlusSubscription getSubscriptionAt ( PRInt32 index )

Devuelve una suscripción a partir de su posición en la lista

Arguments:
index: posición de la suscripción en la lista, con base cero
Returns:
la suscripción solicitada o null si el índice proporcionado no es válido

boolean removeExternalSubscription ( AString id )

Elimina una suscripción externa

Arguments:
id: identificador de la suscripción (para suscripciones externas puede ser cualquier cadena de texto)
Returns:
true si se ha conseguido eliminar la suscripción, false si la suscripción no existe o existe pero no está gestionada externamente

void removePatterns ( arrayof wstring patterns )

Elimina patrones de la lista de filtros definidos por el usuario

Version:
0.7.2.3 and higher
Arguments:
patterns: lista de patrones a eliminar

readonly PRInt32 subscriptionCount

Número de suscripciones de la lista (incluyendo las suscripciones especiales)


wstring updateExternalSubscription ( AString id, AUTF8String title, arrayof wstring patterns )

Actualiza una suscripción externa (a la crea si no existe dicha suscripción), que no será actualizada por Adblock Plus. La extensión que llama a este método tendrá la responsabilidad de actualizarla y eliminarla cuando ya no sea necesaria.

Adblock Plus 1.3 y posteriores: Las suscripciones externas ya no guardarán en el disco junto al resto de las suscripciones, en lugar de eso deberá llamar el método updateExternalSubscription() cada vez que se inicie el navegador para reponer la suscripción. El objetivo de esto es evitar que se mantenga una suscripción externa obsoleta en la lista si el usuario desinstala la suscripción que la gestiona.

También, antes de Adblock Plus 1.3 este método devolvía un valor booleano que indicaba si se podía crear la suscripción. En Adblock Plus 1.3 y versiones posteriores la creación de una suscripción ya no puede fallar, pero es posible que haya que sobrescribir su identificador — devolverá entonces el valor del nuevo identificador.

Arguments:
id: identificador de suscripción (en las suscripciones externas puede ser cualquier cadena de texto)
title: título para la nueva suscripción a crear. Este parámetro se ignorará si la suscripción ya existe.
patterns: lista de patrones de filtros que la suscripción debe incluir
Returns:
identificador efectivo de suscripción (que puede no ser exactamente igual que el parámetro id)