PrevNextUpHome SophiaFramework UNIVERSE 5.3
SFBTAPI
Wrapper Class for the ITAPI interface.
#include <SFBTAPI.h.hpp>
class SFBTAPI : public SFBNotifier;
SFMTYPEDEFWRAPPER(SFBTAPI)

Inheritance diagram

 Inheritance diagram of SFBTAPIClass

Version

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

Reference

BREW API ITAPI

Member

Public Functions
AEESMSTextMsg* ExtractSMSText( AEESMSMsg* msg )
Extract the formatted text from a raw SMS message.
Bool GetCallerID( WCharPtr dest , SInt32 size )
Retrieve the ID, in digits, of an incoming or outgoing voice call.
Bool GetCallerID( SFXWideStringPtr dest )
Retrieve the ID, in digits, of an incoming or outgoing voice call.
SFCError GetStatus( TAPIStatus* status )
Obtain the current status of the telephony device, including service and call status.
Bool IsDataSupported( Void )
Determine whether the data services are available.
Bool IsVoiceCall( Void )
Determine whether the current call in the system is a voice call.
SFCError MakeVoiceCall( ACharConstPtr number , AEECLSID clsidReturn )
This method is called to place a voice call. The number dialed is specified in the digits string.
SFCError MakeVoiceCall( SFXAnsiStringConstRef number , AEECLSID clsidReturn )
This method is called to place a voice call. The number dialed is specified in the digits string.
static
SFBTAPISmp
NewInstance( SFCErrorPtr exception = null )
Create a new SFBTAPI instance.
static
SFBTAPISmp
NewInstance( AEECLSID id , SFCErrorPtr exception = null )
Create a new SFBTAPI instance.
SFCError OnCallEnd( PFNNOTIFY notify , VoidPtr data , UInt32 delay , UInt16 flags )
Register a Callback function that will be invoked by BREW when there is a change in the call-status. This method is identical to SFBTAPI::OnCallStatus().
SFCError OnCallStatus( PFNNOTIFY notify , VoidPtr data , UInt32 delay , UInt16 flags )
Register a Callback function that will be invoked by BREW when there is a change in the call-status.
SFCError SendSMS( ACharConstPtr dest , ACharConstPtr msg , AEECLSID clsidDest , PFNSMSSTATUS notify , VoidPtr data = null )
Send SMS messages from the handset.
SFCError SendSMS( SFXAnsiStringConstRef dest , ACharConstPtr msg , AEECLSID clsidDest , PFNSMSSTATUS notify , VoidPtr data = null )
Send SMS messages from the handset.
SFCError SendSMS( ACharConstPtr dest , SFXAnsiStringConstRef msg , AEECLSID clsidDest , PFNSMSSTATUS notify , VoidPtr data = null )
Send SMS messages from the handset.
SFCError SendSMS( SFXAnsiStringConstRef dest , SFXAnsiStringConstRef msg , AEECLSID clsidDest , PFNSMSSTATUS notify , VoidPtr data = null )
Send SMS messages from the handset.
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.

SFBTAPI::ExtractSMSText
Extract the formatted text from a raw SMS message.
[ public ]
AEESMSTextMsg* ExtractSMSText(
    AEESMSMsg* msg   // pointer to the input AEESMSMsg
);

Reference

BREW API ITAPI_ExtractSMSText | AEESMSMsg | AEESMSTextMsg


SFBTAPI::GetCallerID
Retrieve the ID, in digits, of an incoming or outgoing voice call.
[ public ]
Bool GetCallerID(
    WCharPtr dest   // destination pointer
    SInt32 size     // size in bytes of the destination buffer
);
[ public ]
Bool GetCallerID(
    SFXWideStringPtr dest   // destination pointer
);

Reference

BREW API ITAPI_GetCallerID


SFBTAPI::GetStatus
Obtain the current status of the telephony device, including service and call status.
[ public ]
SFCError GetStatus(
    TAPIStatus* status   // pointer to the status information to be filled
);

Reference

BREW API ITAPI_GetStatus | TAPIStatus | SFBShell::RegisterNotify


SFBTAPI::IsDataSupported
Determine whether the data services are available.
[ public ]
Bool IsDataSupported(Void);

Reference

BREW API ITAPI_IsDataSupported


SFBTAPI::IsVoiceCall
Determine whether the current call in the system is a voice call.
[ public ]
Bool IsVoiceCall(Void);

Reference

BREW API ITAPI_IsVoiceCall | SFBTAPI::MakeVoiceCall


SFBTAPI::MakeVoiceCall
This method is called to place a voice call. The number dialed is specified in the digits string.
[ public ]
SFCError MakeVoiceCall(
    ACharConstPtr number   // pointer to number to dial
    AEECLSID clsidReturn   // ClassID of the applet to be run when the call is completed
);
[ public ]
SFCError MakeVoiceCall(
    SFXAnsiStringConstRef number   // pointer to number to dial
    AEECLSID clsidReturn           // ClassID of the applet to be run when the call is completed
);

Reference

BREW API ITAPI_MakeVoiceCall


SFBTAPI::NewInstance
Create a new SFBTAPI instance.
[ public, static ]
SFBTAPISmp NewInstance(
    SFCErrorPtr exception = null   // Error
);
[ public, static ]
SFBTAPISmp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);

SFBTAPI::OnCallEnd
Register a Callback function that will be invoked by BREW when there is a change in the call-status. This method is identical to SFBTAPI::OnCallStatus().
[ public ]
SFCError OnCallEnd(
    PFNNOTIFY notify   
    VoidPtr data       
    UInt32 delay       
    UInt16 flags       
);

Reference

BREW API ITAPI_OnCallEnd | SFBTAPI::OnCallStatus


SFBTAPI::OnCallStatus
Register a Callback function that will be invoked by BREW when there is a change in the call-status.
[ public ]
SFCError OnCallStatus(
    PFNNOTIFY notify   // notification function to be called when any call-status changes 
    VoidPtr data       // user Data to be passed to the notification function when it is invoked
    UInt32 delay       // the time period in milliseconds BREW waits after the call-state has changed 
		// and before notifying the application 
        
    UInt16 flags       // the following flags are supported: 
                       // OCS_CANCEL       : cancel a previously registered Callback Function.
                       // OCS_UNIQUE_PFN   : when this flag is set, any previous registrations of the same
                       //                    callback function with different data pointers are cancelled. 
                       // OCS_ONE_SHOT     : informs BREW that this CB function is to be registered for just 
                       //                    one notification. Once a single call-status change occurs, this 
                       //                    notification is invoked and the CB function is removed from the 
                       //                    internal list. This CB will not longer be invoked. 
                       // OCS_INCOMING     : register for notifications when there is an incoming call.
                       // OCS_ORIG         : register for notifications when call-originations happen.
                       // OCS_CONVERSATION : register for notifications when call enters the conversation state (Two way state).
                       // OCS_IDLE         : register for notifications when the device enters into idle state.
                       // OCS_OFFLINE      : register for notifications when the device loses coverage.
                       // OCS_ALL          : register for all call-state transitions (incoming, orig, conversation, idle)
);

Reference

BREW API ITAPI_OnCallStatus


SFBTAPI::SendSMS
Send SMS messages from the handset.
[ public ]
SFCError SendSMS(
    ACharConstPtr dest    
    ACharConstPtr msg     
    AEECLSID clsidDest    
    PFNSMSSTATUS notify   
    VoidPtr data = null   
);
[ public ]
SFCError SendSMS(
    SFXAnsiStringConstRef dest   
    ACharConstPtr msg            
    AEECLSID clsidDest           
    PFNSMSSTATUS notify          
    VoidPtr data = null          
);
[ public ]
SFCError SendSMS(
    ACharConstPtr dest          
    SFXAnsiStringConstRef msg   
    AEECLSID clsidDest          
    PFNSMSSTATUS notify         
    VoidPtr data = null         
);
[ public ]
SFCError SendSMS(
    SFXAnsiStringConstRef dest   
    SFXAnsiStringConstRef msg    
    AEECLSID clsidDest           
    PFNSMSSTATUS notify          
    VoidPtr data = null          
);

Argument

dest

Number or email ID of the destination where message must be sent to. If this is set to null and if clsDst is non-zero, this function sends the EVT_APP_MESSAGE event to the application (clsDst) on the local handset and the dwParam of that event shall contain pszMsg. In this case, the return value of the function is the same as the return value of SFBSHELL::SendEvent(). The notification function will not be called since this is a local delivery of the message.

msg

Text message to be sent to the destination mobile. If it is set to null, SFERR_INVALID_PARAM will be returned.

clsidDest

If non-zero, it specifies the class ID of the BREW applet on the destination mobile to which this message must be sent.

notify

Notification function that is invoked to inform the status of the SMS message sent.

data

User data to be sent to the notification function.

Reference

BREW API ITAPI_SendSMS