SFBCallMgr

Wrapper Class for the ICallMgr interface.

#include <SFBCallMgr.h.hpp>

class SFBCallMgr : public SFBWebOpts;

SFMTYPEDEFWRAPPER(SFBCallMgr)

Inheritance diagram

Version

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

Reference

BREW API ICallMgr

Member

Public Functions
`SFCError`	AddOrigOpt( `AEETOriginateOpt*` options ) Load the vector of origination options.
`SFCError`	EndAllCalls( `Void` ) Terminates all calls that are in connected state.
`SFCError`	GetCall( `AEECallDesc` description , `SFBCallSmpPtr` call ) Returns a reference to SFBCall given a call descriptor.
`SFCError`	GetOrigOpt( `SInt32` optId , `SInt32` index , `AEETOriginateOpt*` options ) Retrieves the origination option identified by OptId at the index.
static `SFBCallMgrSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBCallMgr instance.
static `SFBCallMgrSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBCallMgr instance.
`SFCError`	Originate( `AEETCallType` type , `ACharConstPtr` number , `WCharConstPtr` alpha , `SFBCallSmpPtr` call , `CallListener*` listener ) Originates a telephone call of given type to the given destination address.
`SFCError`	Originate( `AEETCallType` type , `SFXAnsiStringConstRef` number , `SFXWideStringConstRef` alpha , `SFBCallSmpPtr` call , `CallListener*` listener ) Originates a telephone call of given type to the given destination address.
`SFCError`	OriginateEx( `AEETCallType` type , `SFBCallSmpPtr` call , `CallListener` listener , `AEETOriginateOpt` options ) An advanced method to originate a call.
`SFCError`	OriginateVoice( `ACharConstPtr` number , `SFBCallSmpPtr` call , `CallListener*` listener ) Originates a voice call to given destination address.
`SFCError`	OriginateVoice( `SFXAnsiStringConstRef` number , `SFBCallSmpPtr` call , `CallListener*` listener ) Originates a voice call to given destination address.
`SFCError`	RemoveOrigOpt( `SInt32` optId , `SInt32` index ) Removes the option identified by nOptId at the index.
`SFCError`	AddOpt( `WebOptPtr` opts ) (inherits from SFBWebOpts) Add the list of WebOpts to the current web option set.
`SFCError`	GetOpt( `SInt32` id , `SInt32` index , `WebOptPtr` opt ) (inherits from SFBWebOpts) Get a WebOpt in the list of WebOpts in SFBWebOpts instance matching OptId in.
`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.
`SFCError`	RemoveOpt( `SInt32` id , `SInt32` index ) (inherits from SFBWebOpts) Remove the nIndex'th WebOpt matching OptId.
`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.

SFBCallMgr::AddOrigOpt

Load the vector of origination options.

[ public ]
SFCError AddOrigOpt(
    AEETOriginateOpt* options   // array of call origination options terminated by AEET_ORIGOPT_END
);

Return value

If succeeds: SFERR_NO_ERROR
If insufficient memory: SFERR_NO_MEMORY

Reference

BREW API ICALLMGR_AddOrigOpt | SFBWebOpts::AddOpt

SFBCallMgr::EndAllCalls

Terminates all calls that are in connected state.

[ public ]
SFCError EndAllCalls(Void);

Return value

Return SFERR_NO_ERROR.

Description

This includes the calls on hold.

Reference

BREW API ICALLMGR_EndAllCalls

SFBCallMgr::GetCall

Returns a reference to SFBCall given a call descriptor.

[ public ]
SFCError GetCall(
    AEECallDesc description   // call descriptor
    SFBCallSmpPtr call        // returns the instance of SFBCall.
);

Return value

If succeeds: SFERR_NO_ERROR
If insufficient memory: SFERR_NO_MEMORY
call is null: SFERR_INVALID_PARAM
Given call descriptor is bad : AEET_ERR_BADDESC

Reference

BREW API ICALLMGR_GetCall

SFBCallMgr::GetOrigOpt

Retrieves the origination option identified by OptId at the index.

[ public ]
SFCError GetOrigOpt(
    SInt32 optId                // Origination option to retrieve
    SInt32 index                // index(zero-based)
    AEETOriginateOpt* options   // buffer to place the option information
);

Return value

If succeeds: SFERR_NO_ERROR
If failed: SFERR_FAILED

Reference

BREW API ICALLMGR_GetOrigOpt | SFBWebOpts::GetOpt

SFBCallMgr::NewInstance

Create a new SFBCallMgr instance.

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

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

SFBCallMgr::Originate

Originates a telephone call of given type to the given destination address.

[ public ]
SFCError Originate(
    AEETCallType type        // type of call to originate
    ACharConstPtr number     // number to process
    WCharConstPtr alpha      // alpha numeric text for MMI
    SFBCallSmpPtr call       // creates the SFBCall object on SUCCESS
    CallListener* listener   // a listener to be notified of call states
);

[ public ]
SFCError Originate(
    AEETCallType type              // type of call to originate
    SFXAnsiStringConstRef number   // number to process
    SFXWideStringConstRef alpha    // alpha numeric text for MMI
    SFBCallSmpPtr call             // creates the SFBCall object on SUCCESS
    CallListener* listener         // a listener to be notified of call states
);

Return value

If succeeds: SFERR_NO_ERROR
If insufficient memory: SFERR_NO_MEMORY
call is null: SFERR_INVALID_PARAM
If no privilege level : EPRIVLEVEL
Device is out of resources to originate a call : AEET_ERR_OUTOF_RESOURCES

Reference

BREW API ICALLMGR_Originate | SFBWebOpts::GetOpt

SFBCallMgr::OriginateEx

An advanced method to originate a call.

[ public ]
SFCError OriginateEx(
    AEETCallType type           // type of the telephone call
    SFBCallSmpPtr call          // returns a SFBCall Object on Success 
    CallListener* listener      // a listener to be notified of call states
    AEETOriginateOpt* options   // a vector of origination options
);

Return value

If succeeds: SFERR_NO_ERROR
If insufficient memory: SFERR_NO_MEMORY
call is null: SFERR_INVALID_PARAM
If no privilege level : EPRIVLEVEL
Device is out of resources to originate a call : AEET_ERR_OUTOF_RESOURCES

Description

Any of the options if present override the options of SFBCallMgr.

Reference

BREW API ICALLMGR_OriginateEx

SFBCallMgr::OriginateVoice

Originates a voice call to given destination address.

[ public ]
SFCError OriginateVoice(
    ACharConstPtr number     // number to dial
    SFBCallSmpPtr call       // returns a SFBCall Object on Success
    CallListener* listener   // a listener to be notified of call states
);

[ public ]
SFCError OriginateVoice(
    SFXAnsiStringConstRef number   // number to dial
    SFBCallSmpPtr call             // returns a SFBCall Object on Success
    CallListener* listener         // a listener to be notified of call states
);

Return value

If succeeds: SFERR_NO_ERROR
If insufficient memory: SFERR_NO_MEMORY
call is null: SFERR_INVALID_PARAM
If no privilege level : EPRIVLEVEL
device is out of resources to originate a call : AEET_ERR_OUTOF_RESOURCES

Reference

BREW API ICALLMGR_OriginateVoice | SFBCallMgr::Originate

SFBCallMgr::RemoveOrigOpt

Removes the option identified by nOptId at the index.

[ public ]
SFCError RemoveOrigOpt(
    SInt32 optId   // the option identifier
    SInt32 index   // index
);

Return value

If succeeds: SFERR_NO_ERROR
If failed: SFERR_FAILED

Reference

BREW API ICALLMGR_RemoveOrigOpt | SFBWebOpts::RemoveOpt