phonesrv_plat/converged_call_provider_api/inc/mccpforwardprovider.h
branchRCL_3
changeset 20 987c9837762f
parent 19 7d48bed6ce0c
equal deleted inserted replaced
19:7d48bed6ce0c 20:987c9837762f
    32 * MCCPCallObserver is used for general call related status, event, error etc notifications.
    32 * MCCPCallObserver is used for general call related status, event, error etc notifications.
    33 *
    33 *
    34 *  @since S60 3.2
    34 *  @since S60 3.2
    35 */
    35 */
    36 class MCCPForwardProvider
    36 class MCCPForwardProvider
    37     {
    37 	{
    38 protected:
    38 protected:
    39     /** 
    39     /** 
    40     * Protected destructor. Object cannot be deleted from plug-in client (CCE).
    40     * Protected destructor. Object cannot be deleted from plug-in client (CCE).
    41     * @since S60 3.2
    41     * @since S60 3.2
    42     */
    42     */
    43     virtual inline ~MCCPForwardProvider() {};
    43     virtual inline ~MCCPForwardProvider() {};
    44     
    44 	
    45 public:
    45 public:
    46     /**
    46     /**
    47     * Returns pointer to array containing addresses to forward the call to.
    47 	* Returns pointer to array containing addresses to forward the call to.
    48     * Index zero contains the first address. If there are no addresses available
    48 	* Index zero contains the first address. If there are no addresses available
    49     * returns an empty array.
    49 	* returns an empty array.
    50     * @since Series 60 3.2
    50 	* @since Series 60 3.2
    51     * @param none
    51 	* @param none
    52     * @return Reference to array containing addresses
    52 	* @return Reference to array containing addresses
    53     * @leave KErrNotReady call is not in forwarding state
    53     * @leave KErrNotReady call is not in forwarding state
    54     * @leave KErrNotSupported if call is not mobile originated
    54     * @leave KErrNotSupported if call is not mobile originated
    55     * @leave system error code 
    55     * @leave system error code 
    56     * @pre Call state is MCCPCallObserver::ECCPStateForwarding and call type is MO
    56     * @pre Call state is MCCPCallObserver::ECCPStateForwarding and call type is MO
    57     * @pre Call MCCPForwardObserver::ECCPMultipleChoices event is received
    57     * @pre Call MCCPForwardObserver::ECCPMultipleChoices event is received
    58     */
    58 	*/
    59     virtual const CDesC8Array& GetForwardAddressChoicesL() = 0;
    59 	virtual const CDesC8Array& GetForwardAddressChoicesL() = 0;
    60 
    60 
    61     /**
    61 	/**
    62     * Forward call to address at given index.
    62 	* Forward call to address at given index.
    63     * @since Series 60 3.2
    63 	* @since Series 60 3.2
    64     * @param aIndex Index of address where the call is to be forwarded. Address is 
    64 	* @param aIndex Index of address where the call is to be forwarded. Address is 
    65     * found in the array received from GetForwardAddressChoicesL. Index starts from zero.
    65 	* found in the array received from GetForwardAddressChoicesL. Index starts from zero.
    66     * @return none
    66 	* @return none
    67     * @leave KErrArgument Index is not in array
    67 	* @leave KErrArgument Index is not in array
    68     * @leave KErrNotReady Call is not in forwarding state
    68     * @leave KErrNotReady Call is not in forwarding state
    69     * @leave KErrNotSupported If call is not mobile originated
    69     * @leave KErrNotSupported If call is not mobile originated
    70     * @pre Call state is MCCPCallObserver::ECCPStateForwarding and call type is MO
    70     * @pre Call state is MCCPCallObserver::ECCPStateForwarding and call type is MO
    71     * @pre Call MCCPForwardObserver::ECCPMultipleChoices event is received
    71     * @pre Call MCCPForwardObserver::ECCPMultipleChoices event is received
    72     */
    72 	*/
    73     virtual void ForwardToAddressL( const TInt aIndex ) = 0;
    73 	virtual void ForwardToAddressL( const TInt aIndex ) = 0;
    74     
    74 	
    75     /**
    75     /**
    76     * Add an observer for forward related events.
    76     * Add an observer for forward related events.
    77     * Currently CCE will set only one observer.
    77     * Currently CCE will set only one observer.
    78     * @since S60 v3.2
    78     * @since S60 v3.2
    79     * @param aObserver Observer to add.
    79     * @param aObserver Observer to add.
    88     * @param aObserver Observer to remove.
    88     * @param aObserver Observer to remove.
    89     * @return KErrNone if removed succesfully. 
    89     * @return KErrNone if removed succesfully. 
    90     * @return KErrNotFound if observer was not found.
    90     * @return KErrNotFound if observer was not found.
    91     */
    91     */
    92     virtual TInt RemoveObserver( const MCCPForwardObserver& aObserver ) = 0;
    92     virtual TInt RemoveObserver( const MCCPForwardObserver& aObserver ) = 0;
    93     };
    93 	};
    94 
    94 
    95 
    95 
    96 #endif // MCCPFORWARDPROVIDER_H
    96 #endif // MCCPFORWARDPROVIDER_H