epoc32/include/push/cwappushmsgutils.inl
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
// WAP Push Message Inline functions file for the Utility class
williamr@2
    15
// 
williamr@2
    16
//
williamr@2
    17
williamr@2
    18
#ifndef __CWAPPUSHMSGUTILS_INL_
williamr@2
    19
#define __CWAPPUSHMSGUTILS_INL_
williamr@2
    20
williamr@2
    21
williamr@2
    22
/**
williamr@2
    23
 * Returns a reference to the CMsvSession member of the class. 
williamr@2
    24
 * Used by other objects when they need to pass a reference to another 
williamr@2
    25
 * function, usually Push Entry class for Save or Retrieve. 
williamr@2
    26
 * 
williamr@2
    27
 * @return Reference to the iMsvSession class member. 
williamr@2
    28
 */
williamr@2
    29
inline CMsvSession& CWapPushMsgUtils::Session() const 
williamr@2
    30
	{
williamr@2
    31
	return *iMsvSession;
williamr@2
    32
	}
williamr@2
    33
williamr@2
    34
williamr@2
    35
/** 
williamr@2
    36
 * Inherited function that must be implemented. 
williamr@2
    37
 * Does not do anything as we do not need to respond to session events. 
williamr@2
    38
 * If there are any problems, calls to the session will leave. Things will be 
williamr@2
    39
 * tidied up then.
williamr@2
    40
 * @param TMsvSessionEvent enumeration indicating event that has just occured
williamr@2
    41
 * @param TAny* specific data
williamr@2
    42
 */
williamr@2
    43
inline void CWapPushMsgUtils::HandleSessionEventL(TMsvSessionEvent , TAny* , TAny* , TAny* )
williamr@2
    44
	{
williamr@2
    45
	}
williamr@2
    46
williamr@2
    47
williamr@2
    48
williamr@2
    49
/**
williamr@2
    50
 * Static function that determines whether an entry has been flagged 
williamr@2
    51
 * as Deleted. Hides the implementation of the deletion mechanism, and 
williamr@2
    52
 * avoids other classes having to perform bitwise operations.
williamr@2
    53
 * 
williamr@2
    54
 * @param aEntry Reference to an entry in the message server index
williamr@2
    55
 * @return TBool ETrue if the entry status is set to Deleted, otherwise EFalse.
williamr@2
    56
 */
williamr@2
    57
inline TBool CWapPushMsgUtils::IsDeleted(const TMsvEntry& aEntry)
williamr@2
    58
	{
williamr@2
    59
	// Must always be a Push Msg Entry, otherwise operation is pointless
williamr@2
    60
	__ASSERT_ALWAYS(aEntry.iMtm == KUidMtmWapPush, 
williamr@2
    61
				User::Panic(KMsgUtilsPanicTitle,EPushMsgUtilsNotValidPushMsg));
williamr@2
    62
	return ( (aEntry.MtmData1() & KPushMaskOnlyStatus) 
williamr@2
    63
					== CPushMsgEntryBase::EPushMsgStatusDeleted);
williamr@2
    64
	}
williamr@2
    65
williamr@2
    66
williamr@2
    67
#endif