|
1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies). |
|
2 // All rights reserved. |
|
3 // This component and the accompanying materials are made available |
|
4 // under the terms of "Eclipse Public License v1.0" |
|
5 // which accompanies this distribution, and is available |
|
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
7 // |
|
8 // Initial Contributors: |
|
9 // Nokia Corporation - initial contribution. |
|
10 // |
|
11 // Contributors: |
|
12 // |
|
13 // Description: |
|
14 // |
|
15 |
|
16 /** |
|
17 @file |
|
18 */ |
|
19 |
|
20 #ifndef __cfax32_INL |
|
21 #define __cfax32_INL |
|
22 |
|
23 /********************************************************************/ |
|
24 |
|
25 /** Sets the mode of operation during the fax session. |
|
26 There are three possible transmission modes: |
|
27 A standard fax machine style dial and transmit. |
|
28 An immediate transmit mode which is used if the phone is already off-hook on a voice call. |
|
29 A polling mode, in which the fax is set up as an answering machine. It sends the fax on request when |
|
30 dialled by a remote modem. |
|
31 There are four possible reception modes: |
|
32 A standard fax machine style wait for a ring and receive. |
|
33 An immediate receive which is used if the phone is already off-hook on a voice call. |
|
34 A dial and receive mode in which the modem dials up in voice mode and then switches to immediate receive. |
|
35 It is intended for use with faxback services which require users to dial manually and then press the start |
|
36 button on their fax machine. The number of seconds between the voice mode dial and the switch to fax receive |
|
37 mode is determined by TFaxSettings::iFaxOnDemandDelay. |
|
38 An automatic polling mode, in which the fax dials a remote answering machine, and requests it to send a fax. |
|
39 |
|
40 Notes: |
|
41 Some GSM networks do not allow switching between voice and fax or data modes, and hence cannot support the |
|
42 immediate transmit and immediate receive modes. This includes all networks in the UK. |
|
43 |
|
44 @param aMode Type of fax operation for the current session. |
|
45 |
|
46 @publishedPartner |
|
47 @released |
|
48 */ |
|
49 inline void CFaxTransfer::SetMode (TFaxMode aMode) |
|
50 { |
|
51 iMode = aMode; |
|
52 } |
|
53 |
|
54 /** Sets the telephone number to be dialled when sending a fax. |
|
55 This function does not check the validity of the number, which is simply sent to the modem |
|
56 as part of an ATD dial command in its raw state. |
|
57 The alternative function SetPhoneNumberL() should be used to resolve the phone number according to |
|
58 the current location and country. One of these functions must be called before CFaxTransfer::Start() |
|
59 when a fax is to be sent. |
|
60 |
|
61 @param aNumber Descriptor containing the phone number to be dialled. |
|
62 @publishedPartner |
|
63 @released |
|
64 */ |
|
65 inline void CFaxTransfer::SetPhoneNumber (TDesC8 & aNumber) |
|
66 { |
|
67 iPhoneNumber.Copy (aNumber); |
|
68 } |
|
69 |
|
70 /** |
|
71 Sets the RCall object name to use when transfering a fax. This method allows |
|
72 a client to use other ETel functionality to discover the incoming call name and |
|
73 then open it for its own use. If this function is not used, the fax server will |
|
74 open a new RCall object to send or receive the Fax. |
|
75 |
|
76 @see RLine::NotifyIncomingCall() |
|
77 |
|
78 @param aName Descriptor containing the RCall object name. |
|
79 @publishedPartner |
|
80 @released |
|
81 */ |
|
82 inline void CFaxTransfer::SetCallObjectName(TDesC& aName) |
|
83 { |
|
84 iCallName.Copy(aName); |
|
85 } |
|
86 |
|
87 /** |
|
88 Specifies the name of the fax store file in which to save incoming pages. |
|
89 If the file already exists the previous contents are lost. |
|
90 |
|
91 @param aName The name of a file in which to save received faxes. |
|
92 @publishedPartner |
|
93 @released |
|
94 */ |
|
95 inline void CFaxTransfer::SetReceiveFileName (const TFileName & aName) |
|
96 { |
|
97 iReceiveFileName.Copy (aName); |
|
98 } |
|
99 |
|
100 /********************************************************************/ |
|
101 |
|
102 #endif |