Referenz

Eigenschaften

Der Konstruktor einer Plugin-Klasse kann und sollte die folgenden Eigenschaften setzen:

      titel – Titel des Plugins

      autor – Autor des Plugins

      web – Web-Seite des Autors bzw. des Plugins, z.B. http://www.firma.xy

      mail – E-Mail-Adresse des Autors

      version – Versionsnummer des Plugins

      designedfor – Versionsnummer der für das Plugin empfohlenen b1gMail-Version

      type – BMPLUGIN_DEFAULT (Konstante) für ein Plugin ohne Widget-Funktionalitäten, BMPLUGIN_WIDGET (Konstante) für ein Plugin mit Widget-Funktionalitäten

Folgende Eigenschaften können gesetzt werden, um die Funktionen bzw. Fähigkeiten des Plugins zu kennzeichnen:

      admin_pages – „true“, wenn das Plugin im Adminbereich konfigurierbar sein soll

      admin_page_title – Titel des Plugins im Menü des Adminbereichs

      widgetTitle – Titel des Widgets (nur bei Widgets)

      widgetTemplate – Template-Datei des Widgets innerhalb des plugins/templates/-Ordners (nur bei Widgets)

      widgetIcon – Symbol des Widgets (16x16) innerhalb des Verzeichnisses plugins/templates/images/ (nur bei Widgets, verfügbar ab b1gMail 7.2)

      widgetPrefs – Gibt an, ob das Widget eine Einstellungs-Seite (true) hat, oder nicht (false) (nur bei Widgets, verfügbar ab b1gMail 7.2)

      widgetPrefsWidth – Gibt die Breite der Widget-Einstellungs-Seite in Pixel an (nur bei Widgets mit Einstellungs-Seite, verfügbar ab b1gMail 7.2)

      widgetPrefsHeight – Gibt die Höhe der Widget-Einstellungs-Seite in Pixel an (nur bei Widgets mit Einstellungs-Seite, verfügbar ab b1gMail 7.2)

      update_url – URL zu einem Update-Service, bei dem auf neue Versionen des Plugins geprüft werden kann. Bei auf my.b1gMail.com veröffentlichten Plugins kann hier der my.b1gMail.com-Update-Service angegeben werden, um den Benutzer auf neue Updates aufmerksam zu machen:
http://my.b1gmail.com/update_service/
Hinweis: Eine Prüfung auf Updates funktioniert dann erst, sobald das Plugin auf my.b1gMail.com veröffentlicht und freigeschaltet wurde.

Folgende Eigenschaften sollten nur gelesen werden:

      internal_name – Internet Name des Plugins, d.h. der Name des Plugin-Klasse

      installed – „true“, falls das Plugin installiert und aktiviert ist