SMSEventMessenger (NetPhantom® 8.0 Java API Specification)

java.lang.Object
- se.entra.phantom.server.extra.SMSEventMessenger

All Implemented Interfaces:
EventHistoryListener, EventMessengerInterface
```
public class SMSEventMessenger
extends Object
implements EventMessengerInterface, EventHistoryListener
```
This class handles event messaging via SMS. Incoming events are filtered and then sent via a Bluebird SMS-server. It therefore requires an ip-connection to such a server. This class is tightly connected with the SMSSender class.

Field Summary
- Fields inherited from interface se.entra.phantom.server.EventMessengerInterface
  DISABLED, EVENT_FILTER

Constructor Summary
Constructors
Constructor and Description
SMSEventMessenger()

Constructors
Constructor and Description
`SMSEventMessenger()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`dispose()` The EventMessenger should do cleaning up it needs before it dies.
`String[]`	`getItems()` Used by the admin interface to get the items of this section.
`String`	`getLastError(boolean reset)` Method to access the latest error.
`String`	`getName()` Returns the name of this class in the ini-file ('SMS').
`int`	`getSendState()` Return our send state.
`void`	`loadIniParams(IniFile ini)` Reads the SMSEventMessengers section in the server.ini.
`void`	`log(int EventId, String msg)` Used by SMSSender when logging events.
`void`	`processEvent(ServerEvent event)` A new server event has been processed by the event exit.
`boolean`	`setSendState(int flag)` Set the send state from outside.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SMSEventMessenger
```
public SMSEventMessenger()
```
- Method Detail
  - processEvent
```
public void processEvent(ServerEvent event)
```
    A new server event has been processed by the event exit.
    Specified by:
    processEvent in interface EventHistoryListener
  - loadIniParams
```
public void loadIniParams(IniFile ini)
```
    Reads the SMSEventMessengers section in the server.ini.
    Specified by:
    loadIniParams in interface EventMessengerInterface
    Parameters:
    ini - The ini file.
  - log
```
public void log(int EventId,
                String msg)
```
    Used by SMSSender when logging events. If the eventId class is of typ error, our status flags are set to false to prevent loops.
  - dispose
```
public void dispose()
```
    The EventMessenger should do cleaning up it needs before it dies. This should be done in it's dispose method.
    Specified by:
    dispose in interface EventMessengerInterface
  - getItems
```
public String[] getItems()
```
    Used by the admin interface to get the items of this section.
    Specified by:
    getItems in interface EventMessengerInterface
  - getName
```
public String getName()
```
    Returns the name of this class in the ini-file ('SMS').
    Specified by:
    getName in interface EventMessengerInterface
  - getSendState
```
public int getSendState()
```
    Return our send state. 0=started, 1=stopped, 2=disabled, 3=error
    Specified by:
    getSendState in interface EventMessengerInterface
    Returns:
    -1 the messenger name is not found.
    0 the messenger is started.
    1 the messenger is stopped.
    2 the messenger is disabled
    3 the messenger is in an error state
  - setSendState
```
public boolean setSendState(int flag)
```
    Set the send state from outside. 0 = start, 1 = stopp, 2 = disable. General: If our internal state equals the flag, do nothing.
    Specified by:
    setSendState in interface EventMessengerInterface
  - getLastError
```
public String getLastError(boolean reset)
```
    Description copied from interface: EventMessengerInterface
    Method to access the latest error. If reset is true the latest error is set to empty string.
    Specified by:
    getLastError in interface EventMessengerInterface
    Returns:
    Last error or null for no error.

Class SMSEventMessenger

Field Summary

Fields inherited from interface se.entra.phantom.server.EventMessengerInterface

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SMSEventMessenger

Method Detail

processEvent

loadIniParams

log

dispose

getItems

getName

getSendState

setSendState

getLastError