epoc32/include/mw/csendingserviceinfo.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2002-2004 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* 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
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:   Encapsulates the ECom plugged sending service data.
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
williamr@2
    20
#ifndef CSENDINGSERVICEINFO_H
williamr@2
    21
#define CSENDINGSERVICEINFO_H
williamr@2
    22
williamr@2
    23
// INCLUDES
williamr@2
    24
#include <e32Base.h>
williamr@2
    25
//#include <SendUi.h>     // TSendingCapabilities
williamr@2
    26
williamr@2
    27
// FORWARD DECLARATIONS
williamr@2
    28
class TSendingCapabilities;
williamr@2
    29
class CSendingServiceInfoImpl;
williamr@2
    30
williamr@2
    31
// CLASS DECLARATION
williamr@2
    32
williamr@2
    33
/**
williamr@2
    34
 * Encapsulates the ECom plugged sending service data.
williamr@2
    35
 *
williamr@2
    36
 * @lib Sendui
williamr@2
    37
 * @since Series 60 3.0
williamr@2
    38
 */ 
williamr@2
    39
class CSendingServiceInfo : public CBase
williamr@2
    40
    {
williamr@2
    41
    public:
williamr@2
    42
    
williamr@2
    43
    enum TServiceFeatures
williamr@2
    44
        {
williamr@2
    45
        EServiceInValid = 1,
williamr@2
    46
        EServiceHidden = 2,
williamr@2
    47
        EServiceCanSendDirectly = 4,
williamr@2
    48
        ENotUsed3 = 8
williamr@2
    49
        };
williamr@2
    50
        
williamr@2
    51
    public:  // Constructors and destructor
williamr@2
    52
    
williamr@2
    53
        /**
williamr@2
    54
        * Two-phased constructor.
williamr@2
    55
        * @return Pointer to object of CSendingServiceInfo.
williamr@2
    56
        */
williamr@2
    57
        IMPORT_C static CSendingServiceInfo* NewL();
williamr@2
    58
        
williamr@2
    59
        /**
williamr@2
    60
        * Two-phased constructor.
williamr@2
    61
        * @return Pointer to object of CSendingServiceInfo.
williamr@2
    62
        */
williamr@2
    63
        IMPORT_C static CSendingServiceInfo* NewLC();
williamr@2
    64
williamr@2
    65
        /**
williamr@2
    66
        * Destructor.
williamr@2
    67
        */
williamr@2
    68
        IMPORT_C virtual ~CSendingServiceInfo();
williamr@2
    69
williamr@2
    70
    public: // New functions
williamr@2
    71
williamr@2
    72
        /**
williamr@2
    73
        * Creates a copy of CSendingServiceInfo object.
williamr@2
    74
        * @since Series 60 3.0
williamr@2
    75
        * @return A pointer to the new copy of the CSendingServiceInfo object.
williamr@2
    76
        */
williamr@2
    77
        IMPORT_C CSendingServiceInfo* CopyLC() const;
williamr@2
    78
williamr@2
    79
        /**
williamr@2
    80
        * Set service human readable name.
williamr@2
    81
        * Service name is used in editors "To"-field.
williamr@2
    82
        * @since Series 60 3.0
williamr@2
    83
        * @param aServiceName Service human readable name.
williamr@2
    84
        * @return None.
williamr@2
    85
        */
williamr@2
    86
        IMPORT_C void SetServiceNameL( const TDesC& aServiceName );
williamr@2
    87
williamr@2
    88
        /**
williamr@2
    89
        * Returns service human readable name.
williamr@2
    90
        * Service name is used in editors "To"-field.
williamr@2
    91
        * @since Series 60 3.0
williamr@2
    92
        * @return Service human readable name.
williamr@2
    93
        */
williamr@2
    94
        IMPORT_C const TPtrC ServiceName() const;
williamr@2
    95
williamr@2
    96
        /**
williamr@2
    97
        * Set service human readable name for the "Send"-menu.
williamr@2
    98
        * @since Series 60 3.0
williamr@2
    99
        * @param aServiceMenuName Service human readable name for the
williamr@2
   100
        *        "Send"-menu.
williamr@2
   101
        * @return None.
williamr@2
   102
        */
williamr@2
   103
        IMPORT_C void SetServiceMenuNameL( const TDesC& aServiceMenuName );
williamr@2
   104
williamr@2
   105
        /**
williamr@2
   106
        * Returns service human readable name for the "Send"-menu.
williamr@2
   107
        * @since Series 60 3.0
williamr@2
   108
        * @return Service human readable name for the "Send"-menu.
williamr@2
   109
        */
williamr@2
   110
        IMPORT_C const TPtrC ServiceMenuName() const;
williamr@2
   111
williamr@2
   112
        /**
williamr@2
   113
        * Set service address.
williamr@2
   114
        * @since Series 60 3.0
williamr@2
   115
        * @param aServiceAddress Service address.
williamr@2
   116
        * @return None.
williamr@2
   117
        */
williamr@2
   118
        IMPORT_C void SetServiceAddressL( const TDesC& aServiceAddress );
williamr@2
   119
williamr@2
   120
        /**
williamr@2
   121
        * Returns service address. 
williamr@2
   122
        * @since Series 60 3.0
williamr@2
   123
        * @return Service address.
williamr@2
   124
        */
williamr@2
   125
        IMPORT_C const TPtrC ServiceAddress() const;
williamr@2
   126
williamr@2
   127
        /**
williamr@2
   128
        * Set sending service id.
williamr@2
   129
        * @since Series 60 3.0
williamr@2
   130
        * @param aServiceId Service id.
williamr@2
   131
        * @return None.
williamr@2
   132
        */
williamr@2
   133
        IMPORT_C void SetServiceId( TUid aServiceId );
williamr@2
   134
williamr@2
   135
        /**
williamr@2
   136
        * Returns sending service id.
williamr@2
   137
        * @since Series 60 3.0
williamr@2
   138
        * @return Service id.
williamr@2
   139
        */
williamr@2
   140
        IMPORT_C TUid ServiceId() const;
williamr@2
   141
williamr@2
   142
        /**
williamr@2
   143
        * Set sending service provider id.
williamr@2
   144
        * @since Series 60 3.0
williamr@2
   145
        * @param aServiceProviderId Service provider id.
williamr@2
   146
        * @return None.
williamr@2
   147
        */
williamr@2
   148
        IMPORT_C void SetServiceProviderId( TUid aServiceProviderId );
williamr@2
   149
williamr@2
   150
        /**
williamr@2
   151
        * Returns sending service provider id.
williamr@2
   152
        * @since Series 60 3.0
williamr@2
   153
        * @return Service provider id.
williamr@2
   154
        */
williamr@2
   155
        IMPORT_C TUid ServiceProviderId() const;
williamr@2
   156
williamr@2
   157
        
williamr@2
   158
          /**
williamr@2
   159
        * Returns sending service technology type id.
williamr@2
   160
        * @since Series 60 3.2
williamr@2
   161
        * @return Service id.
williamr@2
   162
        */
williamr@2
   163
        IMPORT_C void SetTechnologyTypeId( TUid aTechnologyType );
williamr@2
   164
        /**
williamr@2
   165
        * Returns sending service technology type id.
williamr@2
   166
        * @since Series 60 3.2
williamr@2
   167
        * @return Service id.
williamr@2
   168
        */
williamr@2
   169
        IMPORT_C TUid TechnologyTypeId() const;
williamr@2
   170
williamr@2
   171
williamr@2
   172
        /**
williamr@2
   173
        * Set service sending capabilities.
williamr@2
   174
        * @since Series 60 3.0
williamr@2
   175
        * @param aServiceCapabilities Service sending capabilities.
williamr@2
   176
        * @return None.
williamr@2
   177
        */
williamr@2
   178
        IMPORT_C void SetServiceCapabilities(
williamr@2
   179
            TSendingCapabilities aServiceCapabilities );
williamr@2
   180
williamr@2
   181
        /**
williamr@2
   182
        * Returns service sending capabilities.
williamr@2
   183
        * @since Series 60 3.0
williamr@2
   184
        * @return Service sending capabilities.
williamr@2
   185
        */
williamr@2
   186
        IMPORT_C TSendingCapabilities ServiceCapabilities() const;
williamr@2
   187
williamr@2
   188
       /**
williamr@2
   189
        * Set sending service features
williamr@2
   190
        * @since Series 60 3.2
williamr@2
   191
        * @param aServiceCapabilities Sending service features.
williamr@2
   192
        * @return None.
williamr@2
   193
        */
williamr@2
   194
        IMPORT_C void SetServiceFeatures(
williamr@2
   195
            TInt aServiceFeatures );
williamr@2
   196
williamr@2
   197
        /**
williamr@2
   198
        * Returns service features.
williamr@2
   199
        * @since Series 60 3.2
williamr@2
   200
        * @return Sending service features.
williamr@2
   201
        */
williamr@2
   202
        IMPORT_C TInt ServiceFeatures() const;
williamr@2
   203
        
williamr@2
   204
williamr@2
   205
    private:
williamr@2
   206
williamr@2
   207
williamr@2
   208
        /**
williamr@2
   209
        * C++ default constructor.
williamr@2
   210
        */
williamr@2
   211
        CSendingServiceInfo();
williamr@2
   212
williamr@2
   213
        /**
williamr@2
   214
        * By default Symbian 2nd phase constructor is private.
williamr@2
   215
        */
williamr@2
   216
        void ConstructL();
williamr@2
   217
williamr@2
   218
    private:  // Data
williamr@2
   219
williamr@2
   220
        CSendingServiceInfoImpl*            iServiceInfoImpl;
williamr@2
   221
    };
williamr@2
   222
williamr@2
   223
#endif      // CSENDINGSERVICEINFO_H
williamr@2
   224
williamr@2
   225
// End of File