DHIS2 Android SDK/org.hisp.dhis.android.core.sms.domain.repository/SmsRepository

SmsRepository

interface SmsRepository

Types

ReceivedErrorException

class ReceivedErrorException(val errorCode: Int) : Exception

Returned when sms sending error is returned from OS.

ResultResponseException

class ResultResponseException(val reason: SmsRepository.ResultResponseIssue) : Exception

Returned when not received successful response message

ResultResponseIssue

enum ResultResponseIssue : Enum<SmsRepository.ResultResponseIssue>

SmsSendingState

class SmsSendingState(val sent: Int, val total: Int)

Shows the current status of sending task.

Functions

generateSmsParts

abstract fun generateSmsParts(value: String): Single<List<String>>

isAwaitedSuccessMessage

abstract fun isAwaitedSuccessMessage(sender: String, message: String, requiredSender: String, submissionId: Int, submissionType: SubmissionType): Single<Boolean>

Check if a message is the expected one or not

listenToConfirmationSms

abstract fun listenToConfirmationSms(fromDate: Date, waitingTimeoutSeconds: Int, requiredSender: String, submissionId: Int, submissionType: SubmissionType): Completable

Starts process of listening to result confirmation sms

abstract fun sendSms(number: String, smsParts: List<String>, sendingTimeoutSeconds: Int): Observable<SmsRepository.SmsSendingState>

Sends given text by sms