epoc32/include/mw/sipreferdialogassoc.h
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
     1 /*
     1 /*
     2 * Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 * Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     4 * This component and the accompanying materials are made available
     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
     5 * under the terms of "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     8 *
     8 *
     9 * Initial Contributors:
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    10 * Nokia Corporation - initial contribution.
    11 *
    11 *
    12 * Contributors:
    12 * Contributors:
    61 		* Two-phased constructor.
    61 		* Two-phased constructor.
    62 		* Should be used if response to the SIP request to be sent
    62 		* Should be used if response to the SIP request to be sent
    63 		* will create a SIP dialog association.
    63 		* will create a SIP dialog association.
    64 		* @pre aReferTo != 0
    64 		* @pre aReferTo != 0
    65 		* @param aDialog a dialog to be associated with
    65 		* @param aDialog a dialog to be associated with
    66 		* @param aReferTo referred-to resource
    66 		* @param aReferTo referred-to resource;
       
    67 		* Ownership is transferred
    67         * @return New object; the ownership is transferred
    68         * @return New object; the ownership is transferred
    68         * @leave KErrArgument if aReferTo == 0
    69         * @leave KErrArgument if aReferTo == 0
    69 		*/
    70 		*/
    70 		IMPORT_C static CSIPReferDialogAssoc*
    71 		IMPORT_C static CSIPReferDialogAssoc*
    71 			NewL(CSIPDialog& aDialog,
    72 			NewL(CSIPDialog& aDialog,
    75 		* Two-phased constructor.
    76 		* Two-phased constructor.
    76 		* Must be used if response to the SIP request to be sent
    77 		* Must be used if response to the SIP request to be sent
    77 		* will create a SIP dialog association.
    78 		* will create a SIP dialog association.
    78 		* @pre aReferTo != 0
    79 		* @pre aReferTo != 0
    79 		* @param aDialog a dialog to be associated with
    80 		* @param aDialog a dialog to be associated with
    80 		* @param aReferTo referred-to resource
    81 		* @param aReferTo referred-to resource;
       
    82 		* Ownership is transferred
    81         * @return New object; the ownership is transferred
    83         * @return New object; the ownership is transferred
    82         * @leave KErrArgument if aReferTo == 0
    84         * @leave KErrArgument if aReferTo == 0
    83 		*/
    85 		*/
    84 		IMPORT_C static CSIPReferDialogAssoc*
    86 		IMPORT_C static CSIPReferDialogAssoc*
    85 			NewLC(CSIPDialog& aDialog,
    87 			NewLC(CSIPDialog& aDialog,
    95         * @param aConnection a SIP connection to be used with
    97         * @param aConnection a SIP connection to be used with
    96         *        dialog association
    98         *        dialog association
    97         * @param aFrom originator's address; the ownership is transfered
    99         * @param aFrom originator's address; the ownership is transfered
    98         * @param aRemoteUri a remote target URI that identifies a resource that
   100         * @param aRemoteUri a remote target URI that identifies a resource that
    99         *		 the request is addressed to.
   101         *		 the request is addressed to.
   100 		* @param aReferTo referred-to resource
   102 		* @param aReferTo referred-to resource;
       
   103 		* Ownership is transferred
   101         * @param aTo logical recipient's address; if not defined
   104         * @param aTo logical recipient's address; if not defined
   102         *        the remote target uri will be used for To-header
   105         *        the remote target uri will be used for To-header
   103         *        construction; the ownership is transfered
   106         *        construction; the ownership is transfered
   104         * @param aContact a contact to be used in dialog creation. Must be
   107         * @param aContact a contact to be used in dialog creation. Must be
   105         *        given only if user intends to re-direct future requests; 
   108         *        given only if user intends to re-direct future requests; 
   125         * @param aConnection a SIP connection to be used with
   128         * @param aConnection a SIP connection to be used with
   126         *        dialog association
   129         *        dialog association
   127         * @param aFrom originator's address; the ownership is transfered
   130         * @param aFrom originator's address; the ownership is transfered
   128         * @param aRemoteUri a remote target URI that identifies a resource that
   131         * @param aRemoteUri a remote target URI that identifies a resource that
   129         *		 the request is addressed to.
   132         *		 the request is addressed to.
   130 		* @param aReferTo referred-to resource
   133 		* @param aReferTo referred-to resource;
       
   134 		* Ownership is transferred
   131         * @param aTo logical recipient's address; if not defined
   135         * @param aTo logical recipient's address; if not defined
   132         *        the remote target uri will be used for To-header
   136         *        the remote target uri will be used for To-header
   133         *        construction; the ownership is transfered
   137         *        construction; the ownership is transfered
   134         * @param aContact a contact to be used in dialog creation. Must be
   138         * @param aContact a contact to be used in dialog creation. Must be
   135         *        given only if user intends to re-direct future requests; 
   139         *        given only if user intends to re-direct future requests; 
   156         *        dialog association 
   160         *        dialog association 
   157         * @param aRemoteUri a remote target URI that identifies a resource that
   161         * @param aRemoteUri a remote target URI that identifies a resource that
   158         *		 the request is targeted to.
   162         *		 the request is targeted to.
   159         * @param aContext used for selecting outbound 
   163         * @param aContext used for selecting outbound 
   160         *        proxy and originator's address (AOR) and contact
   164         *        proxy and originator's address (AOR) and contact
   161         * @param aReferTo referred-to resource
   165         * @param aReferTo referred-to resource;
       
   166         * Ownership is transferred
   162         * @param aFrom originator's address. If not defined it will
   167         * @param aFrom originator's address. If not defined it will
   163         *        constructed using registration context (User's AOR);
   168         *        constructed using registration context (User's AOR);
   164         *        the ownership is transfered
   169         *        the ownership is transfered
   165         * @param aTo logical recipient's address; if not defined
   170         * @param aTo logical recipient's address; if not defined
   166         *        the remote target uri will be used for To-header
   171         *        the remote target uri will be used for To-header
   193         *        dialog association 
   198         *        dialog association 
   194         * @param aRemoteUri a remote target URI that identifies a resource that
   199         * @param aRemoteUri a remote target URI that identifies a resource that
   195         *		 the request is targeted to.
   200         *		 the request is targeted to.
   196         * @param aContext used for selecting outbound 
   201         * @param aContext used for selecting outbound 
   197         *        proxy and originator's address (AOR) and contact
   202         *        proxy and originator's address (AOR) and contact
   198         * @param aReferTo referred-to resource
   203         * @param aReferTo referred-to resource;
       
   204         * Ownership is transferred
   199         * @param aFrom originator's address. If not defined it will
   205         * @param aFrom originator's address. If not defined it will
   200         *        constructed using registration context (User's AOR);
   206         *        constructed using registration context (User's AOR);
   201         *        the ownership is transfered
   207         *        the ownership is transfered
   202         * @param aTo logical recipient's address; if not defined
   208         * @param aTo logical recipient's address; if not defined
   203         *        the remote target uri will be used for To-header
   209         *        the remote target uri will be used for To-header