epoc32/include/mw/msencobrandinginterface.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 /*
     2 * Copyright (c) 2002-2007 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     5 * under the terms of "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    14 * Description:           Callback interface for co-branding interface.
    15 *
    16 */
    17 
    18 
    19 
    20 
    21 #ifndef M_SEN_COBRANDING_INTERFACE_H
    22 #define M_SEN_COBRANDING_INTERFACE_H
    23 
    24 // CLASS DECLARATION
    25 /**
    26  * Callback interface for co-branding.
    27  * Note: UID for this interface is KSenInterfaceUidCoBrandingObserver.
    28  *
    29  * Application that wishes to enable billing also needs to enable
    30  * following properties of client policy by calling
    31  * CSenXmlServiceDescription::SetPolicy( const TDesC8& aName, const TDesC8& aValue ):
    32  *
    33  *  - Application Info      [ <AppInfo/>,       KSenLocalnameAppInfo ]
    34  *  - WAP gateway address   [ <WAPGW"/>,        KSenLocalnameWAPGW   ] 
    35  *  - MWS namespace         [ <MwsNamespace/>,  KSenLocalnameMwsNamespace   ]
    36  *
    37  * If application does not provide WAP GW address as part of client policy,
    38  * it signalizes that application wants to skip communication with WAP GW
    39  * and talk directly with billing gateway instead. Typically, this depends
    40  * on operator spesific environment.
    41  */
    42 class MSenCoBrandingObserver
    43     {
    44     public:
    45     /**
    46     * This method is called when list of co-branding IDs is receieved during authentication.
    47     * @param aBrandIdListAsXmlSnippet is the list of brand IDs in form of XML snippet
    48     * @param aSelectedBrandId is supposed to point to the brand ID selected by the application
    49     * when this callback returns.
    50     * @return TBool indicates whether or not the application wants to proceed (enable)
    51     * the use of billing ecosystem or stop the whole progress.
    52     */
    53     virtual TBool OnGetBrandIdL(  const TDesC8& aBrandIdListAsXmlSnippet, RBuf8& aSelectedBrandId) = 0;
    54     };
    55 #endif // M_SEN_COBRANDING_INTERFACE_H
    56 
    57 // End of File