LeechCraft  0.6.70-10870-g558588d6ec
Modular cross-platform feature rich live environment.
LeechCraft::AN::EF Namespace Reference

Namespace for various AN entity fields. More...

Variables

const QString SenderID { "org.LC.AdvNotifications.SenderID" }
 The plugin ID of the sender (QByteArray or QString). More...
 
const QString EventCategory { "org.LC.AdvNotifications.EventCategory" }
 The category of the event (QString). More...
 
const QString EventID { "org.LC.AdvNotifications.EventID" }
 The ID of the event (QString). More...
 
const QString VisualPath { "org.LC.AdvNotifications.VisualPath" }
 Visual path to this event (QStringList). More...
 
const QString EventType { "org.LC.AdvNotifications.EventType" }
 The type of the event (QString). More...
 
const QString FullText { "org.LC.AdvNotifications.FullText" }
 The detailed text of the event (QString). More...
 
const QString ExtendedText { "org.LC.AdvNotifications.ExtendedText" }
 The even more detailed text than FullText (QString). More...
 
const QString DeltaCount { "org.LC.AdvNotifications.DeltaCount" }
 The change in event count (int). More...
 
const QString Count { "org.LC.AdvNotifications.Count" }
 The new total event count (int). More...
 
const QString OpenConfiguration { "org.LC.AdvNotifications.OpenConfiguration" }
 Whether configuration dialog should be opened (bool). More...
 
const QString IsSingleShot { "org.LC.AdvNotifications.SingleShot" }
 Whether the created rule should be single-shot (bool). More...
 
const QString NotifyTransient { "org.LC.AdvNotifications.NotifyTransient" }
 Whether a transient notifier should be enabled by default in the rule being created (bool). More...
 
const QString NotifyPersistent { "org.LC.AdvNotifications.NotifyPersistent" }
 Whether a persistent notifier should be enabled by default in the rule being created (bool). More...
 
const QString NotifyAudio { "org.LC.AdvNotifications.NotifyAudio" }
 Whether an audio notifier should be enabled by default in the rule being created (bool). More...
 

Detailed Description

Namespace for various AN entity fields.

This namespace contains various constants for widely-used fields in an AdvancedNotifications-related Entity structure. Both event notification fields and rule creation fields are mentioned.

Variable Documentation

◆ Count

const QString LeechCraft::AN::EF::Count { "org.LC.AdvNotifications.Count" }

The new total event count (int).

This field represents how many events with the given EventID are there pending now.

Note
Either this field or the DeltaCount field should be present for event notification entities.

Definition at line 138 of file entityfields.h.

Referenced by LeechCraft::Util::MakeAN().

◆ DeltaCount

const QString LeechCraft::AN::EF::DeltaCount { "org.LC.AdvNotifications.DeltaCount" }

The change in event count (int).

This field represents the change in the count of the events with the given EventID.

For example, if two messages arrive simultaneously from the same contact in an IM client, this field should be equal to 2.

Note
Either this field or the Count field should be present for event notification entities.

Definition at line 128 of file entityfields.h.

Referenced by LeechCraft::Util::MakeAN().

◆ EventCategory

const QString LeechCraft::AN::EF::EventCategory { "org.LC.AdvNotifications.EventCategory" }

The category of the event (QString).

To notify about an event, this field should contain one of the predefined event categories (like CatIM, CatDownloads and so on). To cancel an event (for example, when all unread messages have been read), this field should contain the CatEventCancel category.

Note
This field is required for event notification entities.
This field is required for rule creation entities.

Definition at line 67 of file entityfields.h.

Referenced by LeechCraft::Util::MakeAN(), LeechCraft::Util::MakeANCancel(), and LeechCraft::Util::MakeANRule().

◆ EventID

const QString LeechCraft::AN::EF::EventID { "org.LC.AdvNotifications.EventID" }

The ID of the event (QString).

Events relating to the same object (like IM messages from the same contact) should have the same event ID.

Note
This field is required for event notification entities.
This field is required for rule creation entities.

Definition at line 78 of file entityfields.h.

Referenced by LeechCraft::Util::MakeAN(), LeechCraft::Util::MakeANCancel(), and LeechCraft::Util::MakeANRule().

◆ EventType

const QString LeechCraft::AN::EF::EventType { "org.LC.AdvNotifications.EventType" }

The type of the event (QString).

This field should contain one of the event types related to the given EventCategory, like TypeIMAttention or TypeIMIncMsg for the CatIM category.

Note
This field is also used when creating rules. In this case, it should contain a QStringList with all the event types the rule being created relates to.
This field is required for event notification entities.
This field is required for rule creation entities.

Definition at line 103 of file entityfields.h.

Referenced by LeechCraft::Util::MakeAN(), and LeechCraft::Util::MakeANRule().

◆ ExtendedText

const QString LeechCraft::AN::EF::ExtendedText { "org.LC.AdvNotifications.ExtendedText" }

The even more detailed text than FullText (QString).

Note
This field is optional for event notification entities.

Definition at line 115 of file entityfields.h.

Referenced by LeechCraft::Util::MakeAN().

◆ FullText

const QString LeechCraft::AN::EF::FullText { "org.LC.AdvNotifications.FullText" }

The detailed text of the event (QString).

Note
This field is optional for event notification entities.

Definition at line 109 of file entityfields.h.

Referenced by LeechCraft::Util::MakeAN().

◆ IsSingleShot

const QString LeechCraft::AN::EF::IsSingleShot { "org.LC.AdvNotifications.SingleShot" }

Whether the created rule should be single-shot (bool).

Note
This field is optional for rule creation entities.

Definition at line 152 of file entityfields.h.

Referenced by LeechCraft::Util::MakeANRule().

◆ NotifyAudio

const QString LeechCraft::AN::EF::NotifyAudio { "org.LC.AdvNotifications.NotifyAudio" }

Whether an audio notifier should be enabled by default in the rule being created (bool).

Note
This field is optional for rule creation entities.

Definition at line 173 of file entityfields.h.

Referenced by LeechCraft::Util::MakeANRule().

◆ NotifyPersistent

const QString LeechCraft::AN::EF::NotifyPersistent { "org.LC.AdvNotifications.NotifyPersistent" }

Whether a persistent notifier should be enabled by default in the rule being created (bool).

Note
This field is optional for rule creation entities.

Definition at line 166 of file entityfields.h.

Referenced by LeechCraft::Util::MakeANRule().

◆ NotifyTransient

const QString LeechCraft::AN::EF::NotifyTransient { "org.LC.AdvNotifications.NotifyTransient" }

Whether a transient notifier should be enabled by default in the rule being created (bool).

Note
This field is optional for rule creation entities.

Definition at line 159 of file entityfields.h.

Referenced by LeechCraft::Util::MakeANRule().

◆ OpenConfiguration

const QString LeechCraft::AN::EF::OpenConfiguration { "org.LC.AdvNotifications.OpenConfiguration" }

Whether configuration dialog should be opened (bool).

If this field is set to true,

Note
This field is optional for rule creation entities.

Definition at line 146 of file entityfields.h.

Referenced by LeechCraft::Util::MakeANRule().

◆ SenderID

const QString LeechCraft::AN::EF::SenderID { "org.LC.AdvNotifications.SenderID" }

The plugin ID of the sender (QByteArray or QString).

Note
This field is required for event notification entities.
This field is required for rule creation entities and should be equal to org.LC.AdvNotifications.RuleRegister.

Definition at line 53 of file entityfields.h.

Referenced by LeechCraft::Util::MakeAN(), LeechCraft::Util::MakeANCancel(), and LeechCraft::Util::MakeANRule().

◆ VisualPath

const QString LeechCraft::AN::EF::VisualPath { "org.LC.AdvNotifications.VisualPath" }

Visual path to this event (QStringList).

This field should contain the list of human-readable strings that allow grouping of various events into tree-like structures.

Note
This field is required for event notification entities.

Definition at line 87 of file entityfields.h.

Referenced by LeechCraft::Util::MakeAN().