ncdengine/inc/ncdnodeuricontent.h
changeset 0 ba25891c3a9e
equal deleted inserted replaced
-1:000000000000 0:ba25891c3a9e
       
     1 /*
       
     2 * Copyright (c) 2006 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:   Contains MNcdNodeUriContent interface
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef M_NCD_NODE_URI_CONTENT_H
       
    20 #define M_NCD_NODE_URI_CONTENT_H
       
    21 
       
    22 
       
    23 #include "catalogsbase.h"
       
    24 #include "ncdinterfaceids.h"
       
    25 
       
    26 
       
    27 /**
       
    28  *  This interface provides functions to handle uri content.
       
    29  *  There can be only one URI content in a node. 
       
    30  *  URI item may have to be purchased before it can
       
    31  *  be used. So, purchase interface may have to be used before
       
    32  *  this content is available. 
       
    33  *
       
    34  *  @note URI items are not installed before usage. 
       
    35  *  They will be launched directly from the given URI 
       
    36  *  by using some application that Symbian OS sees fit
       
    37  *  when the URI is opened. 
       
    38  *
       
    39  *  @see MNcdNodePurchase
       
    40  *
       
    41  *  
       
    42  */
       
    43 class MNcdNodeUriContent : public virtual MCatalogsBase
       
    44     {
       
    45 
       
    46 public:
       
    47 
       
    48     /**
       
    49      * Unique identifier for the interface, required for all MCatalogsBase interfaces.
       
    50      *
       
    51      * 
       
    52      */
       
    53     enum { KInterfaceUid = ENcdNodeUriContentUid };
       
    54 
       
    55 
       
    56     /** 
       
    57      * This function gives the URI where the actual 
       
    58      * content is located. So, the actual content has not 
       
    59      * been given directly here. Instead the content may 
       
    60      * be used by some other application which is
       
    61      * started by the Symbian OS when the uri is opened.
       
    62      *
       
    63      * @return The URI that informs where the actual
       
    64      *  content is located. If the protocol has not defined any value, 
       
    65      *  then an empty string is returned.
       
    66      */
       
    67     virtual const TDesC& ContentUri() const = 0;
       
    68 
       
    69     /** 
       
    70      * Validity time in minutes for how long the target of the URI
       
    71      * received by calling ContentUri() is accessible. Notice that
       
    72      * the delta is not validity from the current time.
       
    73      *
       
    74      * @return The validity time in minutes for how long the target
       
    75      *  of the URI is accessible. If the protocol has not defined
       
    76      *  any value, then -1 is returned. Validity is counted from
       
    77      *  the time that the validity is sent in the protocol to
       
    78      *  the client.
       
    79      */
       
    80     virtual TInt ContentValidityDelta() const = 0;
       
    81 
       
    82 protected:
       
    83 
       
    84     /**
       
    85      * Destructor.
       
    86      *
       
    87      * @see MCatalogsBase::~MCatalogsBase
       
    88      */
       
    89     virtual ~MNcdNodeUriContent() {}
       
    90 
       
    91     };
       
    92 
       
    93 
       
    94 #endif // M_NCD_NODE_URI_CONTENT_H