/*===========================================================================
FILE: 
   PlaceHolder.h

DESCRIPTION:
   API place holders

Copyright (C) 2015 Sierra Wireless Incorporated. All rights reserved.
                   Sierra Wireless Proprietary/GTDR
==========================================================================*/

#ifndef __Place_Holder_H__
#define __Place_Holder_H__

#ifdef __cplusplus
	extern "C" {
#endif

#ifdef __cplusplus
	};
#endif

/*=========================================================================*/
// Prototypes
/*=========================================================================*/

/*===========================================================================
METHOD:
   OriginateUSSD

DESCRIPTION:
   This function initiates a USSD operation
   placeholder function only

PARAMETERS:
   pInfo          [ I ] - USSD information

RETURN VALUE:
   ULONG - Return code
===========================================================================*/
IMPORTGOBI ULONG GOBICMAPI OriginateUSSD( BYTE * pInfo );


/*===========================================================================
METHOD:
   AnswerUSSD

DESCRIPTION:
   This function responds to a USSD request from the network
   placeholder function only

PARAMETERS:
   pInfo          [ I ] - USSD information

RETURN VALUE:
   ULONG - Return code
===========================================================================*/
IMPORTGOBI ULONG GOBICMAPI AnswerUSSD( BYTE * pInfo );

/*===========================================================================
METHOD:
   CancelUSSD

DESCRIPTION:
   This function cancels an in-progress USSD operation
   placeholder function only

RETURN VALUE:
   ULONG - Return code
===========================================================================*/
IMPORTGOBI ULONG GOBICMAPI CancelUSSD();

/*===========================================================================
METHOD:
   SetWirelessDisableCallback

DESCRIPTION:
   Enables/disables wireless disable state callback function
  
PARAMETERS:
   pCallback   [ I ] - Callback function

RETURN VALUE:
   ULONG
===========================================================================*/
IMPORTGOBI ULONG GOBICMAPI SetWirelessDisableCallback( 
   tFNWirelessDisable         pCallback );

   
/*===========================================================================
METHOD:
   DMSUIMGetControlKeyBlockingStatus

DESCRIPTION:
   This function returns the blocking status of the specified facility 
   control key
   Depreciated, function place holder only.

PARAMETERS:
   id                   [ I ] - Facility ID
   pStatus              [ O ] - Control key status
   pVerifyRetriesLeft   [ O ] - The number of retries left, after which the 
                                control key will be blocked 
   pUnblockRetriesLeft  [ O ] - The number of unblock retries left, after 
                                which the control key  will be permanently 
                                blocked 
   pbBlocking           [ O ] - (Optional) Is the facility blocking? 
 
RETURN VALUE:
   ULONG - Return code
===========================================================================*/
IMPORTGOBI ULONG GOBICMAPI DMSUIMGetControlKeyBlockingStatus( 
   ULONG                      id, 
   ULONG *                    pStatus,
   ULONG *                    pVerifyRetriesLeft,
   ULONG *                    pUnblockRetriesLeft,
   ULONG *                    pbBlocking );
   
/*===========================================================================
METHOD:
   SetLock

DESCRIPTION:
   This function sets the user lock state maintained by the device
   Depreciated. Place holder only.

PARAMETERS:
   state       [ I ] - Desired lock state
   pCurrentPIN [ I ] - Current four digit PIN string
  
RETURN VALUE:
   ULONG - Return code
===========================================================================*/
IMPORTGOBI ULONG GOBICMAPI SetLock( 
   ULONG                      state, 
   CHAR *                     pCurrentPIN );

/*===========================================================================
METHOD:
   QueryLock

DESCRIPTION:
   This function sets the user lock state maintained by the device
   Depreciated. Place holder only.

PARAMETERS:
   pState      [ O ] - Current lock state
  
RETURN VALUE:
   ULONG - Return code
===========================================================================*/
IMPORTGOBI ULONG GOBICMAPI QueryLock( ULONG * pState );

/*===========================================================================
METHOD:
   ChangeLockPIN

DESCRIPTION:
   This command sets the user lock code maintained by the device
   Depreciated. Place holder only.

PARAMETERS:
   pCurrentPIN [ O ] - Current four digit PIN string
   pDesiredPIN [ O ] - New four digit PIN string
  
RETURN VALUE:
   ULONG - Return code
===========================================================================*/
IMPORTGOBI ULONG GOBICMAPI ChangeLockPIN( 
   CHAR *                     pCurrentPIN, 
   CHAR *                     pDesiredPIN );

/*===========================================================================
METHOD:
   GetSignalStrength

DESCRIPTION:
   This function gets the current signal strength (in dBm) as measured by 
   the device, the signal strength returned will be one of the currently 
   available technologies with preference CDMA 1xEV-DO, CDMA, AMPS, LTE,
   WCDMA, GSM
   Depreciated. Place Holder only

PARAMETERS:
   pSignalStrength   [ O ] - Received signal strength (dBm)
   pRadioInterface   [ O ] - Radio interface technology 

RETURN VALUE:
   ULONG - Return code
===========================================================================*/
IMPORTGOBI ULONG GOBICMAPI GetSignalStrength( 
   INT8 *                     pSignalStrength, 
   ULONG *                    pRadioInterface );

#endif