com.gupshup.registration.init

Interface SDK

public interface SDK

Method Summary

Modifier and Type	Method and Description
void	executeInitialRegistration() This will initiate the registration process.
void	executeMORegistration(int simSlot) To trigger auto registration for sim slot
void	executeMTRegistrationProcess(android.support.v4.app.FragmentActivity activity, java.lang.String countryCode, java.lang.String mobileNumber, int simSlot) To trigger manual registration you can use this method.
RegistrationInfo	getRegisteredSimInfoBasedOnSlot(int simSlot) returns the registration info based on sim slot, where slot is the sim slot in telephony.
java.lang.String	getVersion() Get the version of current SDK library.
SDK	init() Initializes the SDK library.
void	injectSmsToSystemDb(java.lang.String phoneNumber, java.lang.String messageContent, int simSlot) This method will insert the SMS into the system SMS DB, make sure to call provideInjectSmsPermission() before inserting the first ever message
int	processFcm(java.util.Map<java.lang.String,java.lang.String> pnData) This method is to process the received notification.
void	provideInjectSmsPermission() This method is required to check the writing permission to the System DB and enables it if the permission is not granted
void	receiveDataMessages(int simSlot, retrofit2.Callback<java.util.List<com.gupshup.registration.model.MessageResponse>> callback) This method is used to receive SOIP messages
void	sendAcknowledgementForReceivedMessage(com.gupshup.registration.model.DataMessageStatusParam param, retrofit2.Callback<com.gupshup.registration.model.SendMessageStatusResponse> callback) This method is to send message ACK to server.

Method Detail

getVersion

java.lang.String getVersion()

Get the version of current SDK library.

Returns:

Version of SDK library

init

SDK init()
  throws InitializationException

Initializes the SDK library.
SDK library must be initialized prior to entity extraction/classification

Parameters:

{@link - InitializationListener} object to get events of initialization e.g onFinish, onFailed

Returns:

Instance of SDK

Throws:

InitializationException - if any error occurred while initialization e.g : No DB write permission

executeInitialRegistration

void executeInitialRegistration()

This will initiate the registration process.

executeMTRegistrationProcess

void executeMTRegistrationProcess(android.support.v4.app.FragmentActivity activity,
                                  java.lang.String countryCode,
                                  java.lang.String mobileNumber,
                                  int simSlot)

To trigger manual registration you can use this method.

Parameters:

countryCode - Country code of you belongs to.

mobileNumber - The number you want to register.

simSlot - Which sim you want to register.

executeMORegistration

void executeMORegistration(int simSlot)

To trigger auto registration for sim slot

Parameters:

simSlot - Triggering MO for desired sim slot

injectSmsToSystemDb

void injectSmsToSystemDb(java.lang.String phoneNumber,
                         java.lang.String messageContent,
                         int simSlot)

This method will insert the SMS into the system SMS DB, make sure to call provideInjectSmsPermission() before inserting the first ever message

Parameters:

phoneNumber - String: the phone number of the sender

messageContent - GupshupTextMessage: which will contain the message text

simSlot - int: sim slot on which the message received.

provideInjectSmsPermission

void provideInjectSmsPermission()

This method is required to check the writing permission to the System DB and enables it if the permission is not granted

receiveDataMessages

void receiveDataMessages(int simSlot,
                         retrofit2.Callback<java.util.List<com.gupshup.registration.model.MessageResponse>> callback)

This method is used to receive SOIP messages

Parameters:

simSlot - Sim slot on which message got received.

callback - Callback to get message list.

processFcm

int processFcm(java.util.Map<java.lang.String,java.lang.String> pnData)

This method is to process the received notification.

Parameters:

pnData - Received notification.

Returns:

simSlot of which notification belongs to, Ex. 0 or 1 and If notification is not related to user message then it returns 111 Ex. mo_reg,mt_reg etc registration commands..

sendAcknowledgementForReceivedMessage

void sendAcknowledgementForReceivedMessage(com.gupshup.registration.model.DataMessageStatusParam param,
                                           retrofit2.Callback<com.gupshup.registration.model.SendMessageStatusResponse> callback)

This method is to send message ACK to server.

Parameters:

param - This contains various message detail like messageId,status,sourcePhoneNumber etc..

callback -

getRegisteredSimInfoBasedOnSlot

RegistrationInfo getRegisteredSimInfoBasedOnSlot(int simSlot)

returns the registration info based on sim slot, where slot is the sim slot in telephony.

Parameters:

simSlot -

Returns:

Registration details of the sim in the simslot.