SFBCall

Wrapper Class for the ICall interface.

#include <SFBCall.h.hpp>

class SFBCall : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBCall)

Inheritance diagram

Version

BREW 2.0	BREW 2.1	BREW 3.1	BREW 4.0
X	X	O	O

Reference

BREW API ICall

Member

Public Functions
`SFCError`	Answer( `Void` ) Answers the call if it is in incoming(or waiting) state. Activates the call if it is in hold state.
`SFCError`	BurstDTMF( `AEETDTMFOnLength` duration , `AEETDTMFOffLength` pause , `ACharConstPtr` digits ) Sends a sequence of DTMFs.
`SFCError`	BurstDTMF( `AEETDTMFOnLength` duration , `AEETDTMFOffLength` pause , `SFXAnsiStringConstRef` digits ) Sends a sequence of DTMFs.
`SFCError`	End( `Void` ) Terminates the call in conversation state.
`SFCError`	GetCallDescriptor( `AEECallDesc*` call ) Returns the call descriptor associated with the object.
`SFCError`	GetInfo( `AEETCallInfo*` info , `UInt32` size ) Get the call information.
`AEETCallState`	GetState( `Void` ) Get the call status.
`AEETCallType`	GetType( `Void` ) Gets the call type.
`SFCError`	Hold( `Void` ) Puts the call on hold. There can be atmost one call onhold on the device.
static `SFBCallSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBCall instance.
static `SFBCallSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBCall instance.
`SFCError`	Redirect( `ACharConstPtr` number ) Redirects an incoming call to the given address.
`SFCError`	Redirect( `SFXAnsiStringConstRef` number ) Redirects an incoming call to the given address.
`SFCError`	StartDTMF( `AChar` digit ) Starts playing a DTMF tone to all active calls until a SFBCall::StopDTMF() is invoked.
`SFCError`	StopDTMF( `Void` ) Stops if any DTMF is being played on active call.
`SFCError`	SwitchTo( `Void` ) Activates this call if on hold or if this is active call and it supports switching (such as sending inband flash message).
`SFCError`	Transfer( `SFBCallSmpConstRef` otherCall ) Transfers this call to the given call destination.
`SFCError`	QueryInterface( `AEECLSID` clsid , `VoidHandle` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFCError`	QueryInterface( `AEECLSID` clsid , `SFBBaseSmpPtr` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFBBaseSmp`	QueryInterface( `AEECLSID` clsid ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`Void`	Self( `AEECLSID` clsidReq , `SFBQuerySmpPtr` clone , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.
`SFBQuerySmp`	Self( `AEECLSID` clsidReq , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.

Protected Functions
static `SFBBaseSmp`	FactoryByCreate( `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface.
static `SFBBaseSmp`	FactoryByQuery( `SFBQuerySmpConstRef` query , `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface using the SFBQuery instance.

SFBCall::Answer

Answers the call if it is in incoming(or waiting) state. Activates the call if it is in hold state.

[ public ]
SFCError Answer(Void);

Return value

If succeeds: SFERR_NO_ERROR
If no privilege level : EPRIVLEVEL
An answer request was already in progress or the call is in conversation state : EALREADY
Current device state or operating mode does not allow this operation : AEET_ERR_OP_NOT_ALLOWED

Reference

BREW API ICALL_Answer

SFBCall::BurstDTMF

Sends a sequence of DTMFs.

[ public ]
SFCError BurstDTMF(
    AEETDTMFOnLength duration   // duration of DTMF tone on each digit
    AEETDTMFOffLength pause     // pause interval between digits
    ACharConstPtr digits        // digit buffer
);

[ public ]
SFCError BurstDTMF(
    AEETDTMFOnLength duration      // duration of DTMF tone on each digit
    AEETDTMFOffLength pause        // pause interval between digits
    SFXAnsiStringConstRef digits   // digit buffer
);

Return value

If succeeds: SFERR_NO_ERROR
Current device state does not allow this operation : AEET_ERR_OP_NOT_ALLOWED

Reference

BREW API ICALL_BurstDTMF

SFBCall::End

Terminates the call in conversation state.

[ public ]
SFCError End(Void);

Return value

If succeeds: SFERR_NO_ERROR
If no privilege level : EPRIVLEVEL
An end request was already in progress or the call is in idle state : EALREADY

Description

Performs one of the following operations depending on the state of Call :

Terminates the call in conversation state.
Cancels the call if it is in origination.
Rejects if it is incoming.

Reference

BREW API ICALL_End

SFBCall::GetCallDescriptor

Returns the call descriptor associated with the object.

[ public ]
SFCError GetCallDescriptor(
    AEECallDesc* call   // call descriptor associated with the object
);

Return value

If succeeds: SFERR_NO_ERROR
call is null: SFERR_INVALID_PARAM
The descriptor associated with SFBCall object is invalid : AEET_ERR_BADDESC

Reference

BREW API ICALL_GetCallDescriptor

SFBCall::GetInfo

Get the call information.

[ public ]
SFCError GetInfo(
    AEETCallInfo* info   // address to which AEETCallInfo data will be written
    UInt32 size          // size of memory in bytes at pInfo
);

Return value

If succeeds: SFERR_NO_ERROR
Invalid argument: SFERR_INVALID_PARAM
If no privilege level : EPRIVLEVEL

Reference

BREW API ICALL_GetInfo

SFBCall::GetState

Get the call status.

[ public ]
AEETCallState GetState(Void);

Reference

BREW API ICALL_GetState

SFBCall::GetType

Gets the call type.

[ public ]
AEETCallType GetType(Void);

Reference

BREW API ICALL_GetType

SFBCall::Hold

Puts the call on hold. There can be atmost one call onhold on the device.

[ public ]
SFCError Hold(Void);

Return value

If succeeds: SFERR_NO_ERROR
If no privilege level : EPRIVLEVEL
The forward request is already in progress or the call is already in IDLE state : EALREADY
Current device state or operating mode does not allow this operation : AEET_ERR_OP_NOT_ALLOWED

Description

At most 1 call can be held.

Reference

BREW API ICALL_Hold

SFBCall::NewInstance

Create a new SFBCall instance.

[ public, static ]
SFBCallSmp NewInstance(
    SFCErrorPtr exception = null   // Error
);

[ public, static ]
SFBCallSmp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);

SFBCall::Redirect

Redirects an incoming call to the given address.

[ public ]
SFCError Redirect(
    ACharConstPtr number   // digit buffer
);

[ public ]
SFCError Redirect(
    SFXAnsiStringConstRef number   // digit buffer
);

Return value

If succeeds: SFERR_NO_ERROR
If no privilege level : EPRIVLEVEL
The forward request is already in progress or the call is already in IDLE state : EALREADY
Current device state or operating mode does not allow this operation : AEET_ERR_OP_NOT_ALLOWED

Reference

BREW API ICALL_Redirect

SFBCall::StartDTMF

Starts playing a DTMF tone to all active calls until a SFBCall::StopDTMF() is invoked.

[ public ]
SFCError StartDTMF(
    AChar digit   // digit
);

Return value

Return SFERR_NO_ERROR.

Description

If a prior DTMF is already in play it will be stopped.

Reference

BREW API ICALL_StartDTMF

SFBCall::StopDTMF

Stops if any DTMF is being played on active call.

[ public ]
SFCError StopDTMF(Void);

Return value

Return SFERR_NO_ERROR.

Description

This affects the DTMFs played with SFBCall::StartDTMF or SFBCall::BurstDTMF.

Reference

BREW API ICALL_StopDTMF | SFBCall::StartDTMF | SFBCall::BurstDTMF

SFBCall::SwitchTo

Activates this call if on hold or if this is active call and it supports switching (such as sending inband flash message).

[ public ]
SFCError SwitchTo(Void);

Return value

If succeeds: SFERR_NO_ERROR
If no privilege level : EPRIVLEVEL
The forward request is already in progress or the call is already in IDLE state : EALREADY
Current device state or operating mode does not allow this operation : AEET_ERR_OP_NOT_ALLOWED

Reference

BREW API ICALL_SwitchTo

SFBCall::Transfer

Transfers this call to the given call destination.

[ public ]
SFCError Transfer(
    SFBCallSmpConstRef otherCall   // the party to transfer
);

Return value

If succeeds: SFERR_NO_ERROR
If no privilege level : EPRIVLEVEL
The forward request is already in progress or the call is already in IDLE state : EALREADY
Current device state or operating mode does not allow this operation : AEET_ERR_OP_NOT_ALLOWED

Reference

BREW API ICALL_Transfer