LeechCraft  0.6.70-13729-g7046a9d2a7
Modular cross-platform feature rich live environment.
LC::AN::EF Namespace Reference

Namespace for various AN entity fields. More...

Variables

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

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

◆ DeltaCount

const QString LC::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 111 of file anconstantsdefs.cpp.

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

◆ EventCategory

const QString LC::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 105 of file anconstantsdefs.cpp.

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

◆ EventID

const QString LC::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 106 of file anconstantsdefs.cpp.

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

◆ EventType

const QString LC::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 108 of file anconstantsdefs.cpp.

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

◆ ExtendedText

const QString LC::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 110 of file anconstantsdefs.cpp.

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

◆ FullText

const QString LC::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 anconstantsdefs.cpp.

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

◆ IsSingleShot

const QString LC::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 114 of file anconstantsdefs.cpp.

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

◆ NotifyAudio

const QString LC::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 117 of file anconstantsdefs.cpp.

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

◆ NotifyPersistent

const QString LC::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 116 of file anconstantsdefs.cpp.

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

◆ NotifyTransient

const QString LC::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 115 of file anconstantsdefs.cpp.

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

◆ OpenConfiguration

const QString LC::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 113 of file anconstantsdefs.cpp.

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

◆ SenderID

const QString LC::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 104 of file anconstantsdefs.cpp.

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

◆ VisualPath

const QString LC::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 107 of file anconstantsdefs.cpp.

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