phonesrv_plat/voice_mailbox_number_api/inc/cvoicemailboxentry.h
changeset 19 e44a8c097b15
parent 12 ae8abd0db65c
equal deleted inserted replaced
15:d7fc66ccd6fb 19:e44a8c097b15
    22 #include <voicemailboxdefs.h>
    22 #include <voicemailboxdefs.h>
    23 
    23 
    24 /**
    24 /**
    25  *  Container class for Voice Mailbox info.
    25  *  Container class for Voice Mailbox info.
    26  *  @lib vmbxengine.lib
    26  *  @lib vmbxengine.lib
    27  *  @since S60 v5.2
       
    28  */
    27  */
    29 
    28 
    30 class CVoiceMailboxEntry : public CBase
    29 class CVoiceMailboxEntry : public CBase
    31     {
    30     {
    32 public:
    31 public:
    43      */
    42      */
    44     IMPORT_C static CVoiceMailboxEntry* NewLC();
    43     IMPORT_C static CVoiceMailboxEntry* NewLC();
    45 
    44 
    46     /**
    45     /**
    47      * Destructor
    46      * Destructor
    48      * @since S60 v5.2
       
    49      *
    47      *
    50      */
    48      */
    51     virtual ~CVoiceMailboxEntry();
    49     virtual ~CVoiceMailboxEntry();
    52 
    50 
    53     /**
    51     /**
    54      * Gets the Voice Mailbox service.
    52      * Gets the Voice Mailbox service.
    55      *
    53      *
    56      * @since S60 v5.2
       
    57      * @return Mailbox service.
    54      * @return Mailbox service.
    58      */
    55      */
    59     IMPORT_C virtual TServiceId ServiceId() const;
    56     IMPORT_C virtual TServiceId ServiceId() const;
    60 
    57 
    61     /**
    58     /**
    62      * Sets the Voice Mailbox service to container.
    59      * Sets the Voice Mailbox service to container.
    63      *
    60      *
    64      * @since S60 v5.2
       
    65      * @param in aVmbxServiceId Voice Mailbox service.
    61      * @param in aVmbxServiceId Voice Mailbox service.
    66      */
    62      */
    67     virtual void SetServiceId(
    63     virtual void SetServiceId(
    68                             const TServiceId& aVmbxServiceId );
    64                             const TServiceId& aVmbxServiceId );
    69 
    65 
    70     /**
    66     /**
    71      * Gets the Voice Mailbox type.
    67      * Gets the Voice Mailbox type.
    72      *
    68      *
    73      * @since S60 v5.2
       
    74      * @return Mailbox type.
    69      * @return Mailbox type.
    75      */
    70      */
    76     IMPORT_C virtual TVmbxType VoiceMailboxType() const;
    71     IMPORT_C virtual TVmbxType VoiceMailboxType() const;
    77 
    72 
    78     /**
    73     /**
    79      * Sets the Voice Mailbox type to container.
    74      * Sets the Voice Mailbox type to container.
    80      *
    75      *
    81      * @since S60 v5.2
       
    82      * @param in aVmbxType Voice Mailbox type.
    76      * @param in aVmbxType Voice Mailbox type.
    83      */
    77      */
    84     IMPORT_C virtual void SetVoiceMailboxType(
    78     IMPORT_C virtual void SetVoiceMailboxType(
    85                             const TVmbxType& aVmbxType );
    79                             const TVmbxType& aVmbxType );
    86 
    80 
    87     /**
    81     /**
    88      * Gets the Voice Mailbox line type.
    82      * Gets the Voice Mailbox line type.
    89      *
    83      *
    90      * @since S60 v5.2
       
    91      * @return Mailbox line type.
    84      * @return Mailbox line type.
    92      *      EVmbxAlsLineDefault is returned if mailbox does not
    85      *      EVmbxAlsLineDefault is returned if mailbox does not
    93      *      support several lines.
    86      *      support several lines.
    94      */
    87      */
    95     IMPORT_C virtual TVmbxAlsLineType VmbxAlsLineType() const;
    88     IMPORT_C virtual TVmbxAlsLineType VmbxAlsLineType() const;
    96 
    89 
    97     /**
    90     /**
    98      * Sets the Voice Mailbox line type to container.
    91      * Sets the Voice Mailbox line type to container.
    99      * EVmbxAlsLineDefault is used by default.
    92      * EVmbxAlsLineDefault is used by default.
   100      *
    93      *
   101      * @since S60 v5.2
       
   102      * @param in aLine Selected Voice Mailbox line type.
    94      * @param in aLine Selected Voice Mailbox line type.
   103      */
    95      */
   104     virtual void SetVmbxAlsLineType(
    96     virtual void SetVmbxAlsLineType(
   105                             const TVmbxAlsLineType& aLine );
    97                             const TVmbxAlsLineType& aLine );
   106 
    98 
   107     /**
    99     /**
   108      * Gets the Voice Mailbox number or address.
   100      * Gets the Voice Mailbox number or address.
   109      *
   101      *
   110      * @since S60 v5.2
       
   111      * @param out aVmbxNumber If successful, contains the returned 
   102      * @param out aVmbxNumber If successful, contains the returned 
   112      *   mailbox number or address.
   103      *   mailbox number or address.
   113      * @return One of the system wide error codes.
   104      * @return One of the system wide error codes.
   114      */
   105      */
   115     IMPORT_C virtual TInt GetVmbxNumber( TPtrC& aVmbxNumber ) const;
   106     IMPORT_C virtual TInt GetVmbxNumber( TPtrC& aVmbxNumber ) const;
   116 
   107 
   117     /**
   108     /**
   118      * Sets the Voice Mailbox number or address to container.
   109      * Sets the Voice Mailbox number or address to container.
   119      *
   110      *
   120      * @since S60 v5.2
       
   121      * @param in aVmbxNumber New Voice Mailbox number or address.
   111      * @param in aVmbxNumber New Voice Mailbox number or address.
   122      * @return One of the system wide error codes.
   112      * @return One of the system wide error codes.
   123      */
   113      */
   124     IMPORT_C virtual TInt SetVmbxNumber( const TDesC& aVmbxNumber );
   114     IMPORT_C virtual TInt SetVmbxNumber( const TDesC& aVmbxNumber );
   125 
   115 
   126     /**
   116     /**
   127      * Gets the Voice Mailbox brand id.
   117      * Gets the Voice Mailbox brand id.
   128      *
   118      *
   129      * @since S60 v5.2
       
   130      * @param out aBrandId If successful, contains the returned Brand id.
   119      * @param out aBrandId If successful, contains the returned Brand id.
   131      * @return One of the system wide error codes.
   120      * @return One of the system wide error codes.
   132      */
   121      */
   133     IMPORT_C virtual TInt GetBrandId( TPtrC8& aBrandId ) const;
   122     IMPORT_C virtual TInt GetBrandId( TPtrC8& aBrandId ) const;
   134 
   123 
   135     /**
   124     /**
   136      * Sets the Voice Mailbox Brand Id to container.
   125      * Sets the Voice Mailbox Brand Id to container.
   137      *
   126      *
   138      * @since S60 v5.2
       
   139      * @param in aBrandId New Brand Id.
   127      * @param in aBrandId New Brand Id.
   140      * @return One of the system wide error codes.
   128      * @return One of the system wide error codes.
   141      */
   129      */
   142     virtual TInt SetBrandId(
   130     virtual TInt SetBrandId(
   143                             const TDesC8& aBrandId );
   131                             const TDesC8& aBrandId );
   144 
   132 
   145     /**
   133     /**
   146      * Gets the VoIp name.
   134      * Gets the VoIp name.
   147      *
   135      *
   148      * @since S60 v5.2
       
   149      * @param out aVmbxName If successful, contains the returned mailbox name.
   136      * @param out aVmbxName If successful, contains the returned mailbox name.
   150      * @return One of the system wide error codes.
   137      * @return One of the system wide error codes.
   151      */
   138      */
   152     IMPORT_C virtual TInt GetVmbxName( TPtrC& aVmbxName ) const;
   139     IMPORT_C virtual TInt GetVmbxName( TPtrC& aVmbxName ) const;
   153 
   140 
   154     /**
   141     /**
   155      * Sets the VoIp name to container.
   142      * Sets the VoIp name to container.
   156      *
   143      *
   157      * @since S60 v5.2
       
   158      * @param in aVmbxName New Voice Mailbox name.
   144      * @param in aVmbxName New Voice Mailbox name.
   159      * @return One of the system wide error codes.
   145      * @return One of the system wide error codes.
   160      */
   146      */
   161     IMPORT_C virtual TInt SetVmbxName( const TDesC& aVmbxName );
   147     IMPORT_C virtual TInt SetVmbxName( const TDesC& aVmbxName );
   162 
   148 
   163     /**
   149     /**
   164      * Gets the type of memory location.
   150      * Gets the type of memory location.
   165      *
   151      *
   166      * @since S60 v5.2
       
   167      * @return Memory location type.
   152      * @return Memory location type.
   168      */
   153      */
   169     IMPORT_C virtual TVmbxMemoryLocation UsingMemoryLocation( ) const;
   154     IMPORT_C virtual TVmbxMemoryLocation UsingMemoryLocation( ) const;
   170 
   155 
   171     /**
   156     /**
   172      * Resets the container to initial state.
   157      * Resets the container to initial state.
   173      *
   158      *
   174      * @since S60 v5.2
       
   175      */
   159      */
   176     IMPORT_C virtual void Reset();
   160     IMPORT_C virtual void Reset();
   177 
   161 
   178     /**
   162     /**
   179      * Sets the using memory location to entry.
   163      * Sets the using memory location to entry.
   180      *
   164      *
   181      * @since S60 v5.2
       
   182      * @param in aType Memory location type.
   165      * @param in aType Memory location type.
   183      */
   166      */
   184     virtual void SetUsingMemoryLocation( 
   167     virtual void SetUsingMemoryLocation( 
   185                                      const TVmbxMemoryLocation& aType );
   168                                      const TVmbxMemoryLocation& aType );
   186 
   169 
   187 protected:
   170 protected:
   188 
   171 
   189     /**
   172     /**
   190      * Second phase constructor.
   173      * Second phase constructor.
   191      *
   174      *
   192      * @since S60 v5.2
       
   193      */
   175      */
   194     void ConstructL();
   176     void ConstructL();
   195 
   177 
   196 private:
   178 private:
   197 
   179 
   198      /**
   180      /**
   199      * Default constructor.
   181      * Default constructor.
   200      *
   182      *
   201      * @since S60 v5.2
       
   202      */
   183      */
   203 
   184 
   204     CVoiceMailboxEntry();
   185     CVoiceMailboxEntry();
   205 
   186 
   206 private: // data
   187 private: // data