QDialOptions Class Reference
[QtTelephonyModule]

Detailed Description

The QDialOptions class provides an encapsulation of options for dialing an outgoing call.

Dial options are used with QPhoneCall::dial() when initiating an outgoing call. The following example demonstrates dialing a voice call:

    QPhoneCallManager mgr;
    QPhoneCall call = mgr.create( "Voice" );
    QDialOptions dialOptions;
    dialOptions.setNumber( "1234567" );
    call.dial( dialOptions );

See also QPhoneCall::dial() and QPhoneCall.

Member Type Documentation

enum QDialOptions::Bearer

This enumeration defines the bearer type to use for data traffic. The values are defined by 3GPP TS 27.007.

enum QDialOptions::CallerId

This enum defines how caller ID information should be transmitted during a dial.

enum QDialOptions::TransparentMode

This enumeration defines the data transparency modes for data traffic. The values are defined by 3GPP TS 27.007.

Member Function Documentation

QDialOptions::QDialOptions ()

Creates a dial options object with default values.

QDialOptions::QDialOptions ( const QDialOptions & other )

Makes a copy of other.

QDialOptions::~QDialOptions ()

Deletes this dial options object.

QString QDialOptions::apn () const

Returns the access point name for GPRS sessions.

See also setApn().

QDialOptions::Bearer QDialOptions::bearer () const

Returns the bearer type to use for data traffic. The default is DataCircuitAsyncUDI.

See also setBearer().

QDialOptions::CallerId QDialOptions::callerId () const

Returns the current caller-ID mode to use for this call. The default is DefaultCallerId.

See also setCallerId().

bool QDialOptions::closedUserGroup () const

Returns true if closed user group information should be used for this call, even if it is normally not used by default for calls; otherwise returns false. The default value is false.

See also setClosedUserGroup().

QUniqueId QDialOptions::contact () const

Returns the unique contact id associated with the call. The default is a null contact id.

See also setContact().

int QDialOptions::contextId () const

Returns the context identifier for GPRS sessions. Returns zero if the session is not GPRS.

See also setContextId().

QVariant QDialOptions::extensionOption ( const QString & name, const QVariant & def = QVariant() ) const

Returns the value of the extension option called name. If the option is not present, def will be returned as the default value.

See also setExtensionOption().

int QDialOptions::gsmSpeed () const

Returns the explicit 3GPP TS 27.007 bearer speed value. The default value of -1 indicates that the system will use a bearer speed value compatible with the explicit bit rate specified by speed().

See also setGsmSpeed().

QStringList QDialOptions::ipArgs () const

Returns the list of command-line options to be passed to pppd.

See also setIpArgs().

QString QDialOptions::ipConnectScript () const

Returns the filename for the connect script.

See also setIpConnectScript().

bool QDialOptions::ipDemandDialing () const

Returns true if the demand-dialing flag is set; otherwise returns false. If the demand-dialing flag is set to true, then it indicates that pppd should be started, but the dial process should not happen yet. The dial will happen only when pppd detects TCP/IP network activity.

If the demand-dialing flag is set to false, then it indicates that pppd should be started and the dial process should be initiated immediately.

See also setIpDemandDialing().

QString QDialOptions::ipDisconnectScript () const

Returns the filename for the disconnect script.

See also setIpDisconnectScript().

QString QDialOptions::ipProgramName () const

Returns the full pathname of the pppd binary to be executed. The default value is /usr/sbin/pppd.

See also setIpProgramName().

QString QDialOptions::number () const

Returns the phone number to be dialed. The default is the empty string.

See also setNumber().

QString QDialOptions::pdpType () const

Returns the PDP type for GPRS sessions.

See also setPdpType().

void QDialOptions::setApn ( const QString & value )

Sets the access point for GPRS sessions to value. The contextId() must be non-zero for the APN to be used when setting up a GPRS session.

See also apn().

void QDialOptions::setBearer ( QDialOptions::Bearer value )

Sets the bearer type to use for data traffic to value.

See also bearer().

void QDialOptions::setCallerId ( QDialOptions::CallerId value )

Sets the caller-ID mode to use for this call to value.

See also callerId().

void QDialOptions::setClosedUserGroup ( bool value )

Sets the closed user group mode to value.

See also closedUserGroup().

void QDialOptions::setContact ( const QUniqueId & value )

Sets the unique contact id associated with the call to value.

See also contact().

void QDialOptions::setContextId ( int value )

Sets the context identifier for GPRS sessions to value.

See also contextId().

void QDialOptions::setExtensionOption ( const QString & name, const QVariant & value )

Sets the extension option name to value. Extension options are used to set dial features beyond those defined by the GSM standards. Non-GSM telephony implementations might need such extension options.

The options are passed to the telephony implementation, which will obey the options it understands and ignore the rest. If the telephony implementation expects an option to be present, and it isn't, then the implementation should choose a reasonable default based on the type of call being made.

See also extensionOption().

void QDialOptions::setGsmSpeed ( int value )

Sets the explicit 3GPP TS 27.007 bearer speed to value. The argument should be one of values from 3GPP TS 27.007's documentation of the AT+CBST command. If the value is set to -1, then the system will use a bearer speed value compatible with the explicit bit rate specified by speed().

This function should only be used when the caller is absolutely certain which bearer speed value they want, and they are certain that the underlying modem supports that value. The setSpeed() function is a better interface because it can determine the appropriate low-level bearer speed value from the capabilities of the modem.

See also gsmSpeed().

void QDialOptions::setIpArgs ( const QStringList & value )

Sets the list of command-line options to be passed to pppd to value.

The list should not include the tty device name or port speed that normally appear at the start of the pppd command-line. These options will be added automatically by the system.

The list should also not include the connect or disconnect options, as they will be set based on the information in connectScript() and disconnectScript().

See also ipArgs().

void QDialOptions::setIpConnectScript ( const QString & filename )

Sets the filename for the connect script. The contents of the file must be formatted according to the chat(1) manual page.

See also ipConnectScript().

void QDialOptions::setIpDemandDialing ( bool value )

Sets the demand-dialing flag to value.

See also ipDemandDialing().

void QDialOptions::setIpDisconnectScript ( const QString & filename )

Sets the filename for the disconnect script. The contents of the file must be formatted according to the chat(1) manual page.

See also ipDisconnectScript().

void QDialOptions::setIpProgramName ( const QString & value )

Sets the full pathname of the pppd binary to value.

See also ipProgramName().

void QDialOptions::setNumber ( const QString & value )

Sets the phone number to be dialed to value.

See also number().

void QDialOptions::setPdpType ( const QString & value )

Sets the PDP type for GPRS sessions to value. The contextId() must be non-zero for the type to be used when setting up a GPRS session.

See also pdpType().

void QDialOptions::setSpeed ( int value )

Sets the explicit bit rate speed to value. For example, setting this to 9600 will select a bearer capable of 9600 bps.

See also speed().

void QDialOptions::setTransparentMode ( QDialOptions::TransparentMode value )

Sets the data traffic transparency mode to value.

See also transparentMode().

void QDialOptions::setUseIpModule ( bool value )

Sets the IP module flag to value. If value is true, then the ipProgramName(), ipArgs(), ipConnectScript(), ipDisconnectScript(), and ipDemandDialing() functions should be used to determine how to launch the IP module.

See also useIpModule().

int QDialOptions::speed () const

Returns the explicit bit rate speed. The default value of -1 indicates that the system should choose the best speed for the requested service.

See also setSpeed().

QDialOptions::TransparentMode QDialOptions::transparentMode () const

Returns the data traffic transparency mode. The default value is NonTransparent.

See also setTransparentMode().

bool QDialOptions::useIpModule () const

Returns true if the call will use a IP module such as pppd to manage the data within the call; otherwise returns false.

See also setUseIpModule().

QDialOptions & QDialOptions::operator= ( const QDialOptions & other )

Makes a copy of other.