PiglerAPI
Public Slots | Signals | Public Member Functions | List of all members
QPiglerAPI Class Reference
Inheritance diagram for QPiglerAPI:
IPiglerTapHandler

Public Slots

qint32 init (QString name)
 
qint32 init ()
 
void setAppId (qint32 appId)
 
QString appName ()
 
qint32 setNotification (qint32 notificationId, QString title, QString message)
 
qint32 updateNotification (qint32 notificationId, QString title, QString message)
 
qint32 createNotification (QString title, QString message)
 
qint32 removeNotification (qint32 notificationId)
 
qint32 removeAllNotifications ()
 
qint32 getLastTappedNotification ()
 
qint32 setRemoveOnTap (qint32 notificationId, bool remove)
 
qint32 setLaunchAppOnTap (qint32 notificationId, bool launch)
 
qint32 setNotificationIcon (qint32 notificationId, QImage icon)
 
qint32 getNotificationsCount ()
 
void close ()
 
void setTapHandler (IPiglerTapHandler *handler)
 

Signals

void handleTap (qint32 notificationId)
 

Public Member Functions

 QPiglerAPI (QObject *parent=0)
 

Member Function Documentation

◆ appName

QString QPiglerAPI::appName ( )
slot
See also
PiglerAPI::GetAppName()
Returns
Current app name

◆ close

void QPiglerAPI::close ( )
slot

◆ createNotification

qint32 QPiglerAPI::createNotification ( QString  title,
QString  message 
)
slot
See also
PiglerAPI::SetNotification(TInt, TBuf<256>)
QPiglerAPI::setNotification(qint32, QString, QString)
Parameters
titleTitle text
messageBottom text
Returns
Notification id or error code

◆ getLastTappedNotification

qint32 QPiglerAPI::getLastTappedNotification ( )
slot
See also
PiglerAPI::GetLastTappedNotification()
Returns
Notification id or error code

◆ getNotificationsCount

qint32 QPiglerAPI::getNotificationsCount ( )
slot
See also
PiglerAPI::GetNotificationsCount()
Returns
Notifications count or error code
Since
v3

◆ init [1/2]

qint32 QPiglerAPI::init ( )
slot

◆ init [2/2]

qint32 QPiglerAPI::init ( QString  name)
slot

◆ removeAllNotifications

qint32 QPiglerAPI::removeAllNotifications ( )
slot
See also
PiglerAPI::RemoveAllNotifications()
Returns
Removed notifications count or error code

◆ removeNotification

qint32 QPiglerAPI::removeNotification ( qint32  notificationId)
slot
See also
PiglerAPI::RemoveNotification(TInt)
Parameters
notificationIdNotification id
Returns
Error code

◆ setAppId

void QPiglerAPI::setAppId ( qint32  appId)
slot
See also
PiglerAPI::SetAppId(TInt)
Parameters
appIdSymbian app UID

◆ setLaunchAppOnTap

qint32 QPiglerAPI::setLaunchAppOnTap ( qint32  notificationId,
bool  launch 
)
slot
See also
PiglerAPI::SetLaunchAppOnTap(TInt, TBool)
Parameters
notificationIdNotification id
launch
Returns
Error code

◆ setNotification

qint32 QPiglerAPI::setNotification ( qint32  notificationId,
QString  title,
QString  message 
)
slot
See also
PiglerAPI::SetNotification(TInt, TBuf<256>)
Parameters
notificationIdNotification id or 0 to create
titleTitle text
messageBottom text
Returns
Notification id or error code

◆ setNotificationIcon

qint32 QPiglerAPI::setNotificationIcon ( qint32  notificationId,
QImage  icon 
)
slot
See also
PiglerAPI::SetNotificationIcon(TInt, TPtrC8&)
Parameters
notificationIdNotification id
iconIcon image, recommended size is 52x52
Returns

◆ setRemoveOnTap

qint32 QPiglerAPI::setRemoveOnTap ( qint32  notificationId,
bool  remove 
)
slot
See also
PiglerAPI::SetRemoveOnTap(TInt, TBool)
Parameters
notificationIdNotification id
remove
Returns
Error code

◆ setTapHandler

void QPiglerAPI::setTapHandler ( IPiglerTapHandler handler)
slot
See also
PiglerAPI::SetTapHandler(IPiglerTapHandler*)
Parameters
handlerTap handler

◆ updateNotification

qint32 QPiglerAPI::updateNotification ( qint32  notificationId,
QString  title,
QString  message 
)
slot
See also
PiglerAPI::SetNotification(TInt, TBuf<256>)
QPiglerAPI::setNotification(qint32, QString, QString)
Parameters
notificationIdNotification id
titleTitle text
messageBottom text
Returns
Notification id or error code