libadblockplus
 All Classes Namespaces Functions Variables Typedefs Enumerations Pages
Public Member Functions | Protected Member Functions | Friends | List of all members
AdblockPlus::Notification Class Reference

Wrapper for an Adblock Plus notification object. More...

#include <Notification.h>

Inheritance diagram for AdblockPlus::Notification:
Inheritance graph
[legend]
Collaboration diagram for AdblockPlus::Notification:
Collaboration graph
[legend]

Public Member Functions

 Notification (const Notification &src)
 Copy constructor.
 
 Notification (Notification &&src)
 Move constructor.
 
Notificationoperator= (const Notification &src)
 Assignment operator.
 
Notificationoperator= (Notification &&src)
 Move assignment operator.
 
NotificationType GetType () const
 Retrieves the type of this notification. More...
 
NotificationTexts GetTexts () const
 Retrieves the title and message of this notification. More...
 
std::vector< std::string > GetLinks () const
 Retrieves the URLs which should be mapped to the links in the message. More...
 
void MarkAsShown ()
 Marks this notification as shown. More...
 
- Public Member Functions inherited from AdblockPlus::JsValue
 JsValue (JsValue &&src)
 
 JsValue (const JsValue &src)
 
JsValueoperator= (const JsValue &src)
 
JsValueoperator= (JsValue &&src)
 
bool IsUndefined () const
 
bool IsNull () const
 
bool IsString () const
 
bool IsNumber () const
 
bool IsBool () const
 
bool IsObject () const
 
bool IsArray () const
 
bool IsFunction () const
 
std::string AsString () const
 
StringBuffer AsStringBuffer () const
 
int64_t AsInt () const
 
bool AsBool () const
 
JsValueList AsList () const
 
std::vector< std::string > GetOwnPropertyNames () const
 Returns a list of property names if this is an object (see IsObject()). More...
 
JsValue GetProperty (const std::string &name) const
 Returns a property value if this is an object (see IsObject()). More...
 
void SetStringBufferProperty (const std::string &name, const StringBuffer &val)
 Sets a property value string if this is an object (see IsObject()). More...
 
std::string GetClass () const
 Returns the value's class name, e.g. Array for arrays (see IsArray()). More...
 
JsValue Call (const JsValueList &params=JsValueList()) const
 Invokes the value as a function (see IsFunction()). More...
 
JsValue Call (const JsValueList &params, const AdblockPlus::JsValue &thisValue) const
 Invokes the value as a method (see IsFunction()). More...
 
JsValue Call (const JsValue &arg) const
 Invokes the value as a function (see IsFunction()) with single parameter. More...
 
v8::Local< v8::Value > UnwrapValue () const
 
void SetProperty (const std::string &name, const std::string &val)
 Sets a property value if this is an object (see IsObject()). More...
 
void SetProperty (const std::string &name, const StringBuffer &val)
 Sets a property value if this is an object (see IsObject()). More...
 
void SetProperty (const std::string &name, int64_t val)
 Sets a property value if this is an object (see IsObject()). More...
 
void SetProperty (const std::string &name, bool val)
 Sets a property value if this is an object (see IsObject()). More...
 
void SetProperty (const std::string &name, const JsValue &value)
 Sets a property value if this is an object (see IsObject()). More...
 
void SetProperty (const std::string &name, const char *val)
 Sets a property value if this is an object (see IsObject()). More...
 
void SetProperty (const std::string &name, int val)
 Sets a property value if this is an object (see IsObject()). More...
 

Protected Member Functions

 Notification (JsValue &&jsValue)
 Constructor. More...
 

Friends

class FilterEngine
 

Additional Inherited Members

- Protected Attributes inherited from AdblockPlus::JsValue
JsEnginePtr jsEngine
 

Detailed Description

Wrapper for an Adblock Plus notification object.

Constructor & Destructor Documentation

AdblockPlus::Notification::Notification ( JsValue &&  jsValue)
explicitprotected

Constructor.

Parameters
jsValueJsValue&& notification JavaScript object.

Member Function Documentation

std::vector<std::string> AdblockPlus::Notification::GetLinks ( ) const

Retrieves the URLs which should be mapped to the links in the message.

Returns
List of links.
NotificationTexts AdblockPlus::Notification::GetTexts ( ) const

Retrieves the title and message of this notification.

Returns
Translated texts.
NotificationType AdblockPlus::Notification::GetType ( ) const

Retrieves the type of this notification.

Returns
Type of this notification.
void AdblockPlus::Notification::MarkAsShown ( )

Marks this notification as shown.

It is only relevant for question notifications. Other notifications are marked automatically.


The documentation for this class was generated from the following file: