GatewayInfo (Esmska Javadoc)

All Known Implementing Classes:

Gateway
```
public interface GatewayInfo
```
Interface pro gateway scripts. All gateway scripts must implement this interface in order to be used in the program.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`getDelayBetweenMessages()` The delay in seconds that must be kept between sending messages.
`java.lang.String`	`getDescription()` Short description of the website (purpose, restrictions, etc).
`java.lang.String[]`	`getFeatures()` The list of all supported features by this gateway.
`java.lang.String`	`getMaintainer()` Maintainer of the script.
`int`	`getMaxChars()` Maximum message length the gateway allows to send.
`java.lang.String`	`getMinProgramVersion()` Minimal program version required to run this script.
`java.lang.String`	`getName()` Gateway name.
`java.lang.String[]`	`getPreferredPrefixes()` List of telephone prefixes that are preferred by this gateway.
`int`	`getSMSLength()` Length of one SMS.
`java.lang.String[]`	`getSupportedLanguages()` Indicates for which website languages the script is working.
`java.lang.String[]`	`getSupportedPrefixes()` List of telephone prefixes that are supported by this gateway.
`java.lang.String`	`getVersion()` Version of the script.
`java.lang.String`	`getWebsite()` The URL of the webpage of this gateway.

- Method Detail
  - getName
```
java.lang.String getName()
```
    Gateway name. This name will be visible in the list od available gateways. The name must be in the form "[CC]Gateway", where CC is country code as defined in ISO 3166-1 alpha-2 and Gateway is the very name of the gateway.
    Country code should denote which country is the main interest of the gateway, for example:
    - The gateway is only available in the language of that country.
    - The gateway sends messages only to customers of that country's operator.
    - The gateway requires a SIM card bought from that country's operator.
    For international gateways, allowing to send SMS to multiple countries, use [INT]Gateway.
    This name must be unique amongst other gateway names.
  - getVersion
```
java.lang.String getVersion()
```
    Version of the script. This is the the datum of last script modification in the YYYY-MM-DD format.
  - getMaintainer
```
java.lang.String getMaintainer()
```
    Maintainer of the script. This is the name and email of the maintainer (often the author) of the script. The maintainer must be in format "NAME <EMAIL>". Name and email are mandatory.
  - getMinProgramVersion
```
java.lang.String getMinProgramVersion()
```
    Minimal program version required to run this script. This string is in a format "x.y.z", where x,y,z are numbers.
  - getWebsite
```
java.lang.String getWebsite()
```
    The URL of the webpage of this gateway. On this URL users can get more information about this gateway, register an account, check if it is working, etc. Can be an empty string, but that is strongly discouraged. The website address should be provided if possible.
  - getDescription
```
java.lang.String getDescription()
```
    Short description of the website (purpose, restrictions, etc). Just one or two sentences. Write it in a language corresponding to the gateway (i.e. english for [INT] websites, local language for local gateways). Can be empty.
  - getSupportedPrefixes
```
java.lang.String[] getSupportedPrefixes()
```
    List of telephone prefixes that are supported by this gateway. All prefixes that are not mentioned here are *not supported* by this gateway. For example for a gateway that can send messages only to numbers originating from Czech Republic (country prefix: +420), and nowhere else, the value is ["+420"]. (The gateway doesn't have to support all numbers starting with +420, but it certainly doesn't support any other prefix.)
    The supported prefixes will usually map to country codes. The prefix always starts with "+" sign and is 1-3 digits long. List of country calling codes is on Wikipedia.
    If the gateway works internationally, allowing to send SMS to multiple countries, this will be an empty array.
    
    Returns:
    
    list of supported prefixes; empty array if gateway sends anywhere in the world
  - getPreferredPrefixes
```
java.lang.String[] getPreferredPrefixes()
```
    List of telephone prefixes that are preferred by this gateway. Preferred prefixes means that there is really high probability that this gateway will be able to send message to a phone number with that prefix. Sometimes a gateway support just a certain set of customers (of a single cell operator for example) and this is a way how to mark them. It usually concerns just free gateway, paid ones usually send everywhere.
    If the gateway sends messages to any phone number within the supported prefixes (see getSupportedPrefixes()) then this will be an empty array.
    
    Example: When the supported prefix is ["+420"] and this gateway allows sending messages to an operator who owns prefixes "606" and "777", then the resulting array of preferred prefixes is ["+420606", "+420777"].
    
    Returns:
    
    list of preferred prefixes; empty array if gateway sends to any phone number in supported prefixes
  - getSMSLength
```
int getSMSLength()
```
    Length of one SMS. Usually, this number wil be around 160. Many gateways add some characters when sending from their website, therefore this number can be often smaller. It can happen that length of the sms can't be determined (it is different for different numbers). In this case provide a negative number.
  - getMaxChars
```
int getMaxChars()
```
    Maximum message length the gateway allows to send. This is the maximum number of characters the user is allowed to type in into the textarea on the gateway website.
  - getDelayBetweenMessages
```
int getDelayBetweenMessages()
```
    The delay in seconds that must be kept between sending messages. The program will wait for at least this number of seconds before attempting to send another message. If there are no gateway restrictions, use '0'.
  - getSupportedLanguages
```
java.lang.String[] getSupportedLanguages()
```
    Indicates for which website languages the script is working. This method is included because gateways may have their website translated into many languages and therefore the response may come somehow localized.
    If the script works independently of website language (no matching on sentences is done), specify just an empty array. In this case default user language will be used for retrieving the website.
    If the script works only with one or more specific languages, provide their two-letter codes (as specified by the ISO 639-1 Code) in an array. In this case default user language will be used if it exists in the array, otherwise first language in the array will be used (therefore it is reasonable to specify the most widely used - like english - as first).
    
    Returns:
    
    list of two-letter language codes for which this script works, or empty array if the script works independently of language
  - getFeatures
```
java.lang.String[] getFeatures()
```
    The list of all supported features by this gateway. It is a list of strings matching the Gateway.Feature attributes.

Interface GatewayInfo

Method Summary

Method Detail

getName

getVersion

getMaintainer

getMinProgramVersion

getWebsite

getDescription

getSupportedPrefixes

getPreferredPrefixes

getSMSLength

getMaxChars

getDelayBetweenMessages

getSupportedLanguages

getFeatures