SFBTelephone

Wrapper class for the ITelephone interface.

#include <SFBTelephone.h.hpp>

class SFBTelephone : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBTelephone)

Inheritance diagram

Version

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

Reference

BREW API ITelephone

Member

Public Functions
`SFCError`	GetCallInfo( `AEECallDesc` descriptor , `AEETCallInfo*` info , `UInt32` size ) Retrieves the requested call's (identified by call descriptor cd) information.
`SFCError`	GetCalls( `AEETCalls*` descriptor , `UInt32` size ) Write to the given memory location the list of current active Call Descriptors in the system.
`SFCError`	GetLineInfo( `AEETLineInfo*` lineInfo , `UInt32` size ) Get the line support information of the phone.
`SFCError`	GetMaxCallDescriptors( `UInt32Ptr` count ) Gets the maximum call descriptors available to the system. Indicates the maximum number of simultaneous calls the system is capable of holding.
`SFCError`	GetNetworks( `AEETNetworkType` type , `SFXCallbackPtr` callback , `VoidPtr` networks , `UInt32` size ) Get a list of networks depending on the type specified.
`SFCError`	GetNetworks( `AEETNetworkType` type , `SFXCallbackPtr` callback , `SFXBufferPtr` networks ) Get a list of networks depending on the type specified.
`SFCError`	GetPhoneInfo( `AEETPhInfo*` phInfo , `UInt32` size ) Gets the current phone information to the given buffer.
`SFCError`	GetServingSystemInfo( `AEETSSInfo*` ssInfo , `UInt32` size ) Retrieve the serving system information to given buffer.
static `SFBTelephoneSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBTelephone instance.
static `SFBTelephoneSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBTelephone instance.
`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.

SFBTelephone::GetCallInfo

Retrieves the requested call's (identified by call descriptor cd) information.

[ public ]
SFCError GetCallInfo(
    AEECallDesc descriptor   // call descriptor
    AEETCallInfo* info       // pointer to AEETCallInfo
    UInt32 size              // size in bytes of memory available at info
);

Return value

If succeeds: SFERR_NO_ERROR
Invalid argument: SFERR_INVALID_PARAM
Given descriptor is invalid descriptor or state : AEET_ERR_BADDESC

Reference

BREW API ITELEPHONE_GetCallInfo

SFBTelephone::GetCalls

Write to the given memory location the list of current active Call Descriptors in the system.

[ public ]
SFCError GetCalls(
    AEETCalls* descriptor   // buffer to write the active calls data
    UInt32 size             // amount of memory in bytes available at address descriptor
);

Return value

If succeeds: SFERR_NO_ERROR
Invalid argument: SFERR_INVALID_PARAM

Reference

BREW API ITELEPHONE_GetCalls

SFBTelephone::GetLineInfo

Get the line support information of the phone.

[ public ]
SFCError GetLineInfo(
    AEETLineInfo* lineInfo   // buffer where the line information is returned
    UInt32 size              // size of the buffer
);

Return value

If succeeds: SFERR_NO_ERROR
Invalid argument: SFERR_INVALID_PARAM

Reference

BREW API ITELEPHONE_GetLineInfo

SFBTelephone::GetMaxCallDescriptors

Gets the maximum call descriptors available to the system. Indicates the maximum number of simultaneous calls the system is capable of holding.

[ public ]
SFCError GetMaxCallDescriptors(
    UInt32Ptr count   // the maximum number of call descriptors system support
);

Return value

If succeeds: SFERR_NO_ERROR
count is null: SFERR_INVALID_PARAM

Reference

BREW API ITELEPHONE_GetMaxCallDescriptors

SFBTelephone::GetNetworks

Get a list of networks depending on the type specified.

[ public ]
SFCError GetNetworks(
    AEETNetworkType type      // network type
    SFXCallbackPtr callback   // callback to invoke when the operation is complete
    VoidPtr networks          // pointer of the network list
    UInt32 size               // sizeof memory at address
);

[ public ]
SFCError GetNetworks(
    AEETNetworkType type      // network type
    SFXCallbackPtr callback   // callback to invoke when the operation is complete
    SFXBufferPtr networks     // pointer of the network list
);

Return value

If succeeds: SFERR_NO_ERROR
Invalid argument: SFERR_INVALID_PARAM

Reference

BREW API ITELEPHONE_GetNetworks

SFBTelephone::GetPhoneInfo

Gets the current phone information to the given buffer.

[ public ]
SFCError GetPhoneInfo(
    AEETPhInfo* phInfo   // pointer to AEETPhInfo buffer
    UInt32 size          // sizeof buffer in bytes available at phInfo
);

Return value

If succeeds: SFERR_NO_ERROR
Invalid argument: SFERR_INVALID_PARAM

Reference

BREW API ITELEPHONE_GetPhoneInfo

SFBTelephone::GetServingSystemInfo

Retrieve the serving system information to given buffer.

[ public ]
SFCError GetServingSystemInfo(
    AEETSSInfo* ssInfo   // buffer to write the Serving System information
    UInt32 size          // size in bytes of memory available at ssInfo
);

Return value

If succeeds: SFERR_NO_ERROR
Invalid argument: SFERR_INVALID_PARAM

Reference

BREW API ITELEPHONE_GetServingSystemInfo

SFBTelephone::NewInstance

Create a new SFBTelephone instance.

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

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