phonesrv_plat/voice_mailbox_number_api/inc/cvoicemailbox.h
changeset 19 e44a8c097b15
parent 12 ae8abd0db65c
child 23 427125ac6cb8
equal deleted inserted replaced
15:d7fc66ccd6fb 19:e44a8c097b15
    30 
    30 
    31 /**
    31 /**
    32  *  Parameter package for Voice Mailbox API operations.
    32  *  Parameter package for Voice Mailbox API operations.
    33  *
    33  *
    34  *  @lib vmbxengine.lib
    34  *  @lib vmbxengine.lib
    35  *  @since S60 v5.2
       
    36  */
    35  */
    37 class TVoiceMailboxParams
    36 class TVoiceMailboxParams
    38     {
    37     {
    39 public:
    38 public:
    40     /**
    39     /**
   169 public:
   168 public:
   170 
   169 
   171     /**
   170     /**
   172      * Retrieves voice mailbox entry for the specified service.
   171      * Retrieves voice mailbox entry for the specified service.
   173      *
   172      *
   174      * @since S60 v5.2
       
   175      * @param in Params Service id and type of the mailbox for which
   173      * @param in Params Service id and type of the mailbox for which
   176      *          a number/address should be defined.
   174      *          a number/address should be defined.
   177      * @param out aEntry If successful, a new result container is
   175      * @param out aEntry If successful, a new result container is
   178      *  created and ownership passed to the caller.
   176      *  created and ownership passed to the caller.
   179      * @return - KErrNone if an entry is found.
   177      * @return - KErrNone if an entry is found.
   190      *
   188      *
   191      * Some mailbox types may not support saving all arguments.
   189      * Some mailbox types may not support saving all arguments.
   192      * In that case unsupported arguments are ignored.
   190      * In that case unsupported arguments are ignored.
   193      * This method may display related UI notes or queries.
   191      * This method may display related UI notes or queries.
   194      *
   192      *
   195      * @since S60 v5.2
       
   196      * @param in aEntry The vmbx entry to save.
   193      * @param in aEntry The vmbx entry to save.
   197      * @return - KErrNone if the entry was saved
   194      * @return - KErrNone if the entry was saved
   198      *         - KErrNotSupported if not capable or allowed to execute this
   195      *         - KErrNotSupported if not capable or allowed to execute this
   199      *              for the specified mailbox service.
   196      *              for the specified mailbox service.
   200      *         - KErrArgument When illegal argument was passed.
   197      *         - KErrArgument When illegal argument was passed.
   212      * this method displays an error note and returns an error.
   209      * this method displays an error note and returns an error.
   213      * If client is interested, CheckConfiguration()
   210      * If client is interested, CheckConfiguration()
   214      * can be used to check permissions.
   211      * can be used to check permissions.
   215      *
   212      *
   216      *
   213      *
   217      * @since S60 v5.2
       
   218      * @param in aParams Service id and type of the mailbox for which
   214      * @param in aParams Service id and type of the mailbox for which
   219      *          a number/address should be defined.
   215      *          a number/address should be defined.
   220      * @param out aEntry If successful, a new result container is
   216      * @param out aEntry If successful, a new result container is
   221      *  created and ownership passed to the caller.
   217      *  created and ownership passed to the caller.
   222      * @return - KErrNone if the number was entered.
   218      * @return - KErrNone if the number was entered.
   239      * If editing for the specified mailbox service is not allowed, 
   235      * If editing for the specified mailbox service is not allowed, 
   240      * this method displays an error note and returns an error.
   236      * this method displays an error note and returns an error.
   241      * If client is interested, CheckConfiguration()
   237      * If client is interested, CheckConfiguration()
   242      * can be used to check permissions.
   238      * can be used to check permissions.
   243      *
   239      *
   244      * @since S60 v5.2
       
   245      * @param in aParams Service id and type of the mailbox.
   240      * @param in aParams Service id and type of the mailbox.
   246      * @param out aEntry If successful, a new result container is
   241      * @param out aEntry If successful, a new result container is
   247      *  created and ownership passed to the caller.
   242      *  created and ownership passed to the caller.
   248      * @return - KErrNone if the number was entered.
   243      * @return - KErrNone if the number was entered.
   249      *           aNumber will contain the vmbx number.
   244      *           aNumber will contain the vmbx number.
   258 
   253 
   259     /**
   254     /**
   260      * Displays a query on the screen asking the user to select a
   255      * Displays a query on the screen asking the user to select a
   261      * Voice Mailbox service.
   256      * Voice Mailbox service.
   262      *
   257      *
   263      * @since S60 v5.2
       
   264      * @param out aParams If successful,
   258      * @param out aParams If successful,
   265      *          contains selected mailbox info.
   259      *          contains selected mailbox info.
   266      * @return - KErrNone if successful.
   260      * @return - KErrNone if successful.
   267      *         - KErrCancel if user selected Cancel
   261      *         - KErrCancel if user selected Cancel
   268      *         - KErrNotFound if there is no defined voice number and
   262      *         - KErrNotFound if there is no defined voice number and
   281      *
   275      *
   282      * Only one notify request can be pending. Method will leave with KErrInUse
   276      * Only one notify request can be pending. Method will leave with KErrInUse
   283      *  if a second request is issued while one is active already.
   277      *  if a second request is issued while one is active already.
   284      * Leaves if the notify request could not be served.
   278      * Leaves if the notify request could not be served.
   285      *
   279      *
   286      * @since S60 v5.2
       
   287      * @param in aObserver The observer for the notification.
   280      * @param in aObserver The observer for the notification.
   288      * @param in aNotifyOnActiveLineOnly if this is ETrue, notify events will
   281      * @param in aNotifyOnActiveLineOnly if this is ETrue, notify events will
   289      *        be generated only if the vmbx number of the active ALS line is
   282      *        be generated only if the vmbx number of the active ALS line is
   290      *        changed, not if the number of the other line is changed. When
   283      *        changed, not if the number of the other line is changed. When
   291      *        there is no ALS support, this has no effect ie. notification
   284      *        there is no ALS support, this has no effect ie. notification
   296                                  const TBool aNotifyOnActiveLineOnly );
   289                                  const TBool aNotifyOnActiveLineOnly );
   297 
   290 
   298     /**
   291     /**
   299      * Cancels a notify request on a vmbx number change.
   292      * Cancels a notify request on a vmbx number change.
   300      *
   293      *
   301      * @since S60 v5.2
       
   302      */
   294      */
   303     IMPORT_C virtual void NotifyVmbxNumberChangeCancel();
   295     IMPORT_C virtual void NotifyVmbxNumberChangeCancel();
   304 
   296 
   305     /**
   297     /**
   306      * Checks the Voice Mailbox configuration to find out if a features
   298      * Checks the Voice Mailbox configuration to find out if a features
   307      * are disabled or enabled.
   299      * are disabled or enabled.
   308      *
   300      *
   309      * @since S60 v5.2
       
   310      * @param in aParams Specifies which mailbox capabilities,
   301      * @param in aParams Specifies which mailbox capabilities,
   311      *          the caller wants to check.
   302      *          the caller wants to check.
   312      * @param in aFlags Use TVmbxFeatureCapabilityFlag values 
   303      * @param in aFlags Use TVmbxFeatureCapabilityFlag values 
   313      *          for this parameter.
   304      *          for this parameter.
   314      *          Specifies what features client wants to check.
   305      *          Specifies what features client wants to check.
   321 
   312 
   322 
   313 
   323     /**
   314     /**
   324      * Checks the Voice Mailbox how many VoIP service Ids
   315      * Checks the Voice Mailbox how many VoIP service Ids
   325      *
   316      *
   326      * @since S60 v5.2
       
   327      * @param out aProfileIds
   317      * @param out aProfileIds
   328      * @return KErrNone if get service Ids successfully.
   318      * @return KErrNone if get service Ids successfully.
   329      */
   319      */
   330     IMPORT_C virtual TInt GetServiceIds( RIdArray& aProfileIds ) const;
   320     IMPORT_C virtual TInt GetServiceIds( RIdArray& aProfileIds ) const;
   331 
   321 
   333      * Saves provisioned entry to corresponding storage.
   323      * Saves provisioned entry to corresponding storage.
   334      *
   324      *
   335      * Some mailbox types may not support saving all arguments.
   325      * Some mailbox types may not support saving all arguments.
   336      * In that case unsupported arguments are ignored.
   326      * In that case unsupported arguments are ignored.
   337      *
   327      *
   338      * @since S60 v5.2
       
   339      * @param in aEntry The provisioned vmbx entry to save.
   328      * @param in aEntry The provisioned vmbx entry to save.
   340      * @return - KErrNone if the entry was saved
   329      * @return - KErrNone if the entry was saved
   341      *         - KErrNotSupported if not capable or allowed to execute this
   330      *         - KErrNotSupported if not capable or allowed to execute this
   342      *              for the specified mailbox service.
   331      *              for the specified mailbox service.
   343      *         - KErrArgument When illegal argument was passed.
   332      *         - KErrArgument When illegal argument was passed.
   348 protected:
   337 protected:
   349 
   338 
   350     /**
   339     /**
   351      * Second phase constructor.
   340      * Second phase constructor.
   352      *
   341      *
   353      * @since S60 v5.2
       
   354      */
   342      */
   355     void ConstructL();
   343     void ConstructL();
   356 
   344 
   357     /**
   345     /**
   358      * Default constructor.
   346      * Default constructor.
   359      *
   347      *
   360      * @since S60 v5.2
       
   361      */
   348      */
   362     CVoiceMailbox();
   349     CVoiceMailbox();
   363 
   350 
   364 private: // data
   351 private: // data
   365 
   352