com.smsjuice.api.wrapper.domain.model

Class RecipientLimitRule

java.lang.Object

com.smsjuice.api.wrapper.domain.model.RecipientLimitRule

public class RecipientLimitRule
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
RecipientLimitRule(java.lang.String key, java.lang.String secret, int messagesLimit, int timePeriodInMinutes) Rule to set how many messages can be sent to a specific recipient within a specified time.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getKey()
int	getMessagesLimit()
java.lang.String	getSecret()
int	getTimePeriodInMinutes()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RecipientLimitRule

public RecipientLimitRule(java.lang.String key,
                          java.lang.String secret,
                          int messagesLimit,
                          int timePeriodInMinutes)
                   throws LimitRuleException

Rule to set how many messages can be sent to a specific recipient within a specified time. There can only be one maximum rule per account. Setting a new one replaces the old one.

Parameters:

key - found from your account settings page

secret - found from your account settings page

messagesLimit - Maximum number of messages to send within the specified time period. Must be greater than 0

timePeriodInMinutes - The period in which the messages limit applies. Must be greater than 0

Throws:

LimitRuleException - Thrown usually when one of the parameters is missing or when the primitive parameters (messagesLimit & timePeriodInMinutes) are less than 1.

Method Detail

getKey

public java.lang.String getKey()

getSecret

public java.lang.String getSecret()

getMessagesLimit

public int getMessagesLimit()

getTimePeriodInMinutes

public int getTimePeriodInMinutes()