MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

OviNotificationState Class Reference

List of all members.

Public Types

enum   State { EStateOffline = 0, EStateConnecting = 1, EStateOnline = 2 }
enum   StateError {
  EErrorNone = 0, EErrorEnablerNotFound = 1, EErrorApplicationIdConflict = 2, EErrorMissingCredentials = 3,
  EErrorNoNetwork = 4, EErrorServiceUnavailable = 5, EErrorNotAllowed = 6, EErrorDisabledByUser = 7,
  EErrorNotificationIdInvalidated = 8, EErrorWidgetIdMismatch = 9, EErrorInvalidApplicationId = 10, EErrorInvalidServiceId = 11,
  EErrorEnablerExpired = 12
}

Public Slots

virtual State  sessionState ()
virtual QString  sessionStateString ()
virtual StateError  sessionError ()
virtual int  sessionErrorInteger ()
virtual QString  sessionErrorString ()

Public Member Functions

  OviNotificationState ()
  ~OviNotificationState ()

Properties

State  sessionState
StateError  sessionError

Friends

class  OviNotificationResponseHandler
class  OviNotificationSessionPrivate

Member Enumeration Documentation

Session states.

Enumerator:
EStateOffline 

No connection to XMPP core.

EStateConnecting 

Notifications Enabler is connecting, for the first time or after temporarily loosing connection.

EStateOnline 

Application has connected, it can receive messages.

Enumerator:
EErrorNone 

Used when succesfully changing session state.

EErrorEnablerNotFound 

Notifications Enabler cannot be found.

EErrorApplicationIdConflict 

Conflicting application id, same application id has already been registered.

EErrorMissingCredentials 

Notifications Enabler cannot get credentials to connect to server.

EErrorNoNetwork 

Network connection lost.

EErrorServiceUnavailable 

Ovi Notification Service is no longer available because service's authentication has expired.

EErrorNotAllowed 

A method that is not allowed to be called in the state was called.

EErrorDisabledByUser 

User has disabled all Ovi Notifications.

EErrorNotificationIdInvalidated 

User account has been changed.

EErrorWidgetIdMismatch 

Widget id is missing from widget XML configuration file file (info.plist/config.xml).

EErrorInvalidApplicationId 

Application id is invalid, too long applicationId or empty application id.

EErrorInvalidServiceId 

Returned when trying to request Notification Id with servie ID that ONE server does not accept.

EErrorEnablerExpired 

Returned when Notifications Enabler has expired.


Constructor & Destructor Documentation

OviNotificationState::OviNotificationState (  ) 
OviNotificationState::~OviNotificationState (  ) 

Member Function Documentation

virtual StateError OviNotificationState::sessionError (  )  [virtual, slot]

Returns the error

Returns:
OviNotificationInterface::StateError The error of the session
virtual int OviNotificationState::sessionErrorInteger (  )  [virtual, slot]

Returns the error as integer

Returns:
int The error of the session
virtual QString OviNotificationState::sessionErrorString (  )  [virtual, slot]

Returns the error as string

Returns:
QString OviNotificationInterface::StateError as string
virtual State OviNotificationState::sessionState (  )  [virtual, slot]

Returns the state.

Returns:
OviNotificationInterface::State The state of the session
virtual QString OviNotificationState::sessionStateString (  )  [virtual, slot]

Returns the state as string.

Returns:
QString OviNotificationInterface::State as string

Friends And Related Function Documentation

friend class OviNotificationResponseHandler [friend]
friend class OviNotificationSessionPrivate [friend]

Property Documentation

StateError OviNotificationState::sessionError [read]
State OviNotificationState::sessionState [read]

Copyright (C) 2010-2011 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. Contact: notifications.support@nokia.com This software, including documentation, is protected by copyright controlled by Nokia Corporation. All rights reserved. You may use this file only in accordance with the Nokia Developer Software Agreement version 2.0 and accompanying Ovi any additional terms. This material also contains confidential information which may not be disclosed to others without the prior written consent of Nokia.
Nokia Developer Software Agreement version 2.0 and accompanying Ovi any additional terms
MeeGo 1.2 Harmattan API