phoneclientserver/phoneclient/inc/extcall/extcall_aiw/cphcltextphonedialdata.h
changeset 51 12bc758d6a02
parent 33 8d5d7fcf9b59
equal deleted inserted replaced
48:78df25012fda 51:12bc758d6a02
   183         /**
   183         /**
   184         * Defines if mathing is allowed.
   184         * Defines if mathing is allowed.
   185         * @since Series 60 3.2
   185         * @since Series 60 3.2
   186         * @return Returns the allow match setting information.
   186         * @return Returns the allow match setting information.
   187         */
   187         */
   188         IMPORT_C  TBool AllowMatch() const;
   188         TBool AllowMatch() const;
   189         
   189         
   190         /**
   190         /**
   191         * Bearer capability.
   191         * Bearer capability.
   192         * @since Series 60 3.2
   192         * @since Series 60 3.2
   193         * @return Returns bearer capability.
   193         * @return Returns bearer capability.
   194         */
   194         */
   195         IMPORT_C const TPhCltBearerCapability& Bearer() const;
   195         const TPhCltBearerCapability& Bearer() const;
   196         
   196         
   197         /**
   197         /**
   198         * Gives the current call type.
   198         * Gives the current call type.
   199         * @since Series 60 3.2
   199         * @since Series 60 3.2
   200         * @return Current call type.
   200         * @return Current call type.
   201         */
   201         */
   202         IMPORT_C  TPhCltCallType CallType() const ;   
   202         TPhCltCallType CallType() const ;   
   203          
   203          
   204         /**
   204         /**
   205         * Contact link field.
   205         * Contact link field.
   206         * @since Series 60 3.2
   206         * @since Series 60 3.2
   207         * @return Returns contack link item.
   207         * @return Returns contack link item.
   208         */
   208         */
   209         IMPORT_C const TDesC8& ContactLink() const;
   209         const TDesC8& ContactLink() const;
   210         
   210         
   211         
   211         
   212         /**
   212         /**
   213         * End other calls param.
   213         * End other calls param.
   214         * @since Series 60 3.2
   214         * @since Series 60 3.2
   215         * @return Returns ETrue if other calls will be terminated.
   215         * @return Returns ETrue if other calls will be terminated.
   216         *                 EFalse if calls are not terminated.
   216         *                 EFalse if calls are not terminated.
   217         */
   217         */
   218         IMPORT_C TBool EndOtherCalls() const;
   218         TBool EndOtherCalls() const;
   219         
   219         
   220         /**
   220         /**
   221         * Intiate Call
   221         * Intiate Call
   222         * @since Series 60 3.2
   222         * @since Series 60 3.2
   223         * @return Returns ETrue if call is itiate call EFalse otherwise
   223         * @return Returns ETrue if call is itiate call EFalse otherwise
   224         */
   224         */
   225         IMPORT_C  TBool InitiateCall() const;
   225         TBool InitiateCall() const;
   226         
   226         
   227         /**
   227         /**
   228         * Name.
   228         * Name.
   229         * @since Series 60 3.2
   229         * @since Series 60 3.2
   230         * @return Returns name.
   230         * @return Returns name.
   231         */
   231         */
   232         IMPORT_C  const TPhCltNameBuffer& Name() const;
   232         const TPhCltNameBuffer& Name() const;
   233         
   233         
   234         
   234         
   235         /**
   235         /**
   236         * Redial information.
   236         * Redial information.
   237         * @since Series 60 3.2
   237         * @since Series 60 3.2
   238         * @return Return the redial status,
   238         * @return Return the redial status,
   239         */
   239         */
   240         IMPORT_C  TInt Redial() const;  
   240         TInt Redial() const;  
   241         
   241         
   242         /**
   242         /**
   243         * Redial maximum duration
   243         * Redial maximum duration
   244         * @since Series 60 3.2
   244         * @since Series 60 3.2
   245         * @return Returns redial max duration.
   245         * @return Returns redial max duration.
   246         */
   246         */
   247         IMPORT_C const TTimeIntervalSeconds RedialMaximumDuration() const;      
   247         const TTimeIntervalSeconds RedialMaximumDuration() const;      
   248                    
   248                    
   249         
   249         
   250         /** 
   250         /** 
   251         * Return in failure.
   251         * Return in failure.
   252         * @since Series 60 3.2
   252         * @since Series 60 3.2
   257         /**
   257         /**
   258         * SAT Call.
   258         * SAT Call.
   259         * @since Series 60 3.2
   259         * @since Series 60 3.2
   260         * @return Returns ETrue if SAT call EFalse if not.
   260         * @return Returns ETrue if SAT call EFalse if not.
   261         */
   261         */
   262         IMPORT_C  TBool SATCall() const;
   262         TBool SATCall() const;
   263         
   263         
   264         /** 
   264         /** 
   265         * SendKey pressed.
   265         * SendKey pressed.
   266         * @since Series 60 3.2
   266         * @since Series 60 3.2
   267         * @return Return ETrue if SendKey used.
   267         * @return Return ETrue if SendKey used.
   268         */
   268         */
   269         IMPORT_C TBool SendKeyPressed() const;
   269         TBool SendKeyPressed() const;
   270         
   270         
   271         /**
   271         /**
   272         * Show Number.
   272         * Show Number.
   273         * @since Series 60 3.2
   273         * @since Series 60 3.2
   274         * @return Returns the number visibility.
   274         * @return Returns the number visibility.
   275         */
   275         */
   276         IMPORT_C TBool ShowNumber() const;
   276         TBool ShowNumber() const;
   277         
   277         
   278         /**
   278         /**
   279         * Sub address.
   279         * Sub address.
   280         * @since Series 60 3.2
   280         * @since Series 60 3.2
   281         * @return Returns SAT call sub address.
   281         * @return Returns SAT call sub address.
   282         */
   282         */
   283         IMPORT_C  const TPhCltSubAddress& SubAddress() const;
   283         const TPhCltSubAddress& SubAddress() const;
   284         
   284         
   285         /**
   285         /**
   286         * Gives the current phone number.
   286         * Gives the current phone number.
   287         * @since Series 60 3.2
   287         * @since Series 60 3.2
   288         * @return Telephone number.
   288         * @return Telephone number.
   289         */
   289         */
   290         IMPORT_C  const TPhCltTelephoneNumber& TelephoneNumber() const;
   290         const TPhCltTelephoneNumber& TelephoneNumber() const;
   291         
   291         
   292         /**
   292         /**
   293         * Gives the current window group id.
   293         * Gives the current window group id.
   294         * @since Series 60 3.2
   294         * @since Series 60 3.2
   295         * @return Window group id. 
   295         * @return Window group id. 
   296         */     
   296         */     
   297         IMPORT_C  TInt WindowGroup() const; 
   297         TInt WindowGroup() const; 
   298         
   298         
   299         /**
   299         /**
   300          * Gives the user to user information.
   300          * Gives the user to user information.
   301          * @since S60 v3.2
   301          * @since S60 v3.2
   302          * @return User to user information.
   302          * @return User to user information.
   303          */
   303          */
   304         IMPORT_C const TDesC& UUI() const;
   304         const TDesC& UUI() const;
   305         
   305         
   306     public: // Access - Setters
   306     public: // Access - Setters
   307     
   307     
   308         /**
   308         /**
   309         * Set whether the name entered in SetName should be matched
   309         * Set whether the name entered in SetName should be matched
   312         * This should be set EFalse only if phone number has not been
   312         * This should be set EFalse only if phone number has not been
   313         * taken from phonebook.
   313         * taken from phonebook.
   314         *
   314         *
   315         * @param aAllowMatch Whether to allow matches.
   315         * @param aAllowMatch Whether to allow matches.
   316         */
   316         */
   317         IMPORT_C  void SetAllowMatch( TBool aAllowMatch );
   317         void SetAllowMatch( TBool aAllowMatch );
   318     
   318     
   319         /**
   319         /**
   320         * Set the bearer capability.
   320         * Set the bearer capability.
   321         * @since Series 60 3.2
   321         * @since Series 60 3.2
   322         * @param aBearer The bearer capabilities as defined in GSM 04.08.
   322         * @param aBearer The bearer capabilities as defined in GSM 04.08.
   323         * @leaves KErrArgument if aBearer's length is longer than KAiwBearerLength
   323         * @leaves KErrArgument if aBearer's length is longer than KAiwBearerLength
   324         */
   324         */
   325         IMPORT_C void SetBearerL( const TPhCltBearerCapability& aBearer );
   325         void SetBearerL( const TPhCltBearerCapability& aBearer );
   326         
   326         
   327         /**
   327         /**
   328         * Sets call type.
   328         * Sets call type.
   329         * @since Series 60 3.2
   329         * @since Series 60 3.2
   330         * @param aCallType calls' type.
   330         * @param aCallType calls' type.
   331         */
   331         */
   332         IMPORT_C void SetCallType( TPhCltCallType aCallType );
   332         void SetCallType( TPhCltCallType aCallType );
   333         
   333         
   334         /**
   334         /**
   335         * Set contact link.
   335         * Set contact link.
   336         * @since Series 60 3.2
   336         * @since Series 60 3.2
   337         * @param aContactLink Contact link information.
   337         * @param aContactLink Contact link information.
   338         */
   338         */
   339        IMPORT_C void SetContactLinkL( const TDesC8& aContactLink );
   339         void SetContactLinkL( const TDesC8& aContactLink );
   340         
   340         
   341         
   341         
   342         /**
   342         /**
   343         * Set parameter for end other calls. 
   343         * Set parameter for end other calls. 
   344         * @since Series 60 3.2
   344         * @since Series 60 3.2
   345         * If this is set to ETrue, other calls will be terminated before
   345         * If this is set to ETrue, other calls will be terminated before
   346         * dial. Default is EFalse.
   346         * dial. Default is EFalse.
   347         * @param aEndCalls Are the other calls ended.
   347         * @param aEndCalls Are the other calls ended.
   348         */
   348         */
   349         IMPORT_C void SetEndOtherCalls( TBool aEndCalls  );
   349         void SetEndOtherCalls( TBool aEndCalls  );
   350         
   350         
   351         /**
   351         /**
   352         * Set Initiate call Etrue or EFalse
   352         * Set Initiate call Etrue or EFalse
   353         *@since Series 60 3.2
   353         *@since Series 60 3.2
   354         * @param aInitCall ETrue if call is intiate call
   354         * @param aInitCall ETrue if call is intiate call
   355         */
   355         */
   356         IMPORT_C void SetInitiateCall( TBool aInitCall );
   356         void SetInitiateCall( TBool aInitCall );
   357         
   357         
   358         
   358         
   359         /**
   359         /**
   360         * Set the name of the person who is to be called.
   360         * Set the name of the person who is to be called.
   361         * @since Series 60 3.2
   361         * @since Series 60 3.2
   362         * @param aName The name of the person being called.
   362         * @param aName The name of the person being called.
   363         * @leaves KErrArgument if aName length is over 50 characters.
   363         * @leaves KErrArgument if aName length is over 50 characters.
   364         */
   364         */
   365         IMPORT_C void SetNameL( const TPhCltNameBuffer& aName );
   365         void SetNameL( const TPhCltNameBuffer& aName );
   366         
   366         
   367         
   367         
   368         /**
   368         /**
   369         * Change the redial mode.
   369         * Change the redial mode.
   370         * @since Series 60 3.2
   370         * @since Series 60 3.2
   371         * @param aRedial The new redial status
   371         * @param aRedial The new redial status
   372         */
   372         */
   373   
   373         void SetRedial( TInt aRedial );
   374         IMPORT_C void SetRedial( TInt aRedial );
       
   375         
   374         
   376         /**
   375         /**
   377         * Set redial max duration.
   376         * Set redial max duration.
   378         * @since Series 60 3.2
   377         * @since Series 60 3.2
   379         * @param aDuration redial max duration.
   378         * @param aDuration redial max duration.
   380         */
   379         */
   381         IMPORT_C void SetRedialMaximumDuration( TTimeIntervalSeconds aMaximumRedialDuration );       
   380         void SetRedialMaximumDuration( TTimeIntervalSeconds aMaximumRedialDuration );
   382         
       
   383         
   381         
   384         /**
   382         /**
   385         * Set whether to return to number entry.
   383         * Set whether to return to number entry.
   386         *
   384         *
   387         * @param aReturn Whether to return to the number entry editor.
   385         * @param aReturn Whether to return to the number entry editor.
   388         */
   386         */
   389         IMPORT_C void SetReturnToNumberEntryOnFailure( TBool aReturn );
   387         void SetReturnToNumberEntryOnFailure( TBool aReturn );
   390                 
   388                 
   391         /**
   389         /**
   392         * Set wheteher this is a SAT originated call or not.
   390         * Set wheteher this is a SAT originated call or not.
   393         * If this function is not called, the originator is assumed to 
   391         * If this function is not called, the originator is assumed to 
   394         * be other than SAT.
   392         * be other than SAT.
   395         * @since Series 60 3.2
   393         * @since Series 60 3.2
   396         * @param aSATCall ETrue if SAT originated the call, EFalse otherwise.
   394         * @param aSATCall ETrue if SAT originated the call, EFalse otherwise.
   397         */
   395         */
   398         IMPORT_C void SetSATCall( TBool aSATCall );
   396         void SetSATCall( TBool aSATCall );
   399         
   397         
   400         
   398         
   401         /**
   399         /**
   402         * Set the value of SendKey.
   400         * Set the value of SendKey.
   403         *  @since Series 60 3.2
   401         *  @since Series 60 3.2
   404         * @param aSendKey The value of SendKey.
   402         * @param aSendKey The value of SendKey.
   405         */
   403         */
   406         IMPORT_C void SetSendKeyPressed( TBool aSendKey );
   404         void SetSendKeyPressed( TBool aSendKey );
   407         
   405         
   408         /**
   406         /**
   409         * Set the number visibility in the phone app.
   407         * Set the number visibility in the phone app.
   410         * @since Series 60 3.2
   408         * @since Series 60 3.2
   411         * If this is set to EFalse, then number is not shown or written to 
   409         * If this is set to EFalse, then number is not shown or written to 
   412         * log event.
   410         * log event.
   413         * @param aShowNumber Whether or not to show the number.
   411         * @param aShowNumber Whether or not to show the number.
   414         */
   412         */
   415         IMPORT_C void SetShowNumber( TBool aShowNumber );
   413         void SetShowNumber( TBool aShowNumber );
   416         
   414         
   417         /**
   415         /**
   418         * Set the calling party subaddress.
   416         * Set the calling party subaddress.
   419         * Defined in ITU-T I.330 and 3GPP TS 11.14.
   417         * Defined in ITU-T I.330 and 3GPP TS 11.14.
   420         * @since Series 60 3.2
   418         * @since Series 60 3.2
   421         * @param aSubAddress The calling party subaddress.
   419         * @param aSubAddress The calling party subaddress.
   422         * @leaves KErrArgument if aSubAddress length is longer than 
   420         * @leaves KErrArgument if aSubAddress length is longer than 
   423         * KAiwSubAddressLength
   421         * KAiwSubAddressLength
   424         */
   422         */
   425         IMPORT_C void SetSubAddressL( const TPhCltSubAddress& aSubAddress );
   423         void SetSubAddressL( const TPhCltSubAddress& aSubAddress );
   426         
   424         
   427         /**
   425         /**
   428         * Sets the phone number.
   426         * Sets the phone number.
   429         * @since Series 60 3.2
   427         * @since Series 60 3.2
   430         * @param aNumber Phone number, which maximum length is
   428         * @param aNumber Phone number, which maximum length is
   431         * KMaximumPhoneNumberLength.
   429         * KMaximumPhoneNumberLength.
   432         * @leaves KErrArgument if aPhoneNumber length is over KMaximumPhoneNumberLength
   430         * @leaves KErrArgument if aPhoneNumber length is over KMaximumPhoneNumberLength
   433         */
   431         */
   434         IMPORT_C void SetTelephoneNumber( const TPhCltTelephoneNumber& aNumber );
   432         void SetTelephoneNumber( const TPhCltTelephoneNumber& aNumber );
   435         
   433         
   436         /**
   434         /**
   437         * Sets the window group identifier. When call is ended, set window group is actived.
   435         * Sets the window group identifier. When call is ended, set window group is actived.
   438         * @since Series 60 3.2
   436         * @since Series 60 3.2
   439         * @param aWindowGroup Window group id.
   437         * @param aWindowGroup Window group id.
   440         */
   438         */
   441         IMPORT_C void SetWindowGroup( TInt aWindowGroup );
   439         void SetWindowGroup( TInt aWindowGroup );
   442      
   440      
   443         /**
   441         /**
   444         * Set the value of xSP Service Id. 
   442         * Set the value of xSP Service Id. 
   445         *
   443         *
   446         * @param aServiceId The value of Service Id.
   444         * @param aServiceId The value of Service Id.
   459          * Sets user to user information. Maximum length is 
   457          * Sets user to user information. Maximum length is 
   460          * KPhCltUUILength.
   458          * KPhCltUUILength.
   461          * @param aUUI User to user information.
   459          * @param aUUI User to user information.
   462          * @since S60 v3.2
   460          * @since S60 v3.2
   463          */
   461          */
   464         IMPORT_C void SetUUIL( const TDesC& aUUI );
   462          void SetUUIL( const TDesC& aUUI );
   465         
       
   466       
       
   467         
       
   468                 
       
   469                       
   463                       
   470     // Constructors
   464     // Constructors
   471     
   465     
   472      private: 
   466      private: 
   473      
   467