• Home
• nz.net.osnz.common
• sms-api
• 3.1
• source code
• SmsService.groovy

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

nz.net.osnz.common.sms.api.SmsService.groovy Maven / Gradle / Ivy

package nz.net.osnz.common.sms.api

import nz.net.osnz.common.sms.utils.TransmissionResult

/**
 * @author Kefeng Deng
 *
 * The interface to send SMS messages
 */
public interface SmsService {

    /**
     * Send a single message to a single person
     * @param mobile    - the target mobile
     * @param message   - the sending message
     * @return          - whether send the message to target mobile successfully
     */
    public Map sendMessage(String mobile, String message)

    /**
     * Send multiple messages to multiple persons
     * @param messages - the sending messages (Map Key : target mobile number, Map value: the sending message)
     * @return         - whether send the messages successfully
     */
    public Map sendMessages(Map> messages)

    /**
    * Determines whether or not an area code for a phone number passed through is a mobile number
    *
    * @param areaCode
    * @return true if it is a recognized mobile prefix
    */
    public boolean isMobile(String areaCode);

}