RecipientType (java-sdk 9.0.1 API)

java.lang.Object
- java.lang.Enum<RecipientType>
- - com.geotab.model.entity.recipient.RecipientType

All Implemented Interfaces:: HasName, Serializable, Comparable<RecipientType>

public enum RecipientType
extends Enum<RecipientType>
implements HasName

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ALARM` Recipient will be notified with an alarm sound in the MyGeotab application.
`ASSIGN_TO_GROUP` The vehicle associate with the ExceptionEvent will be assigned to the designated group (removed from sibling groups).
`BEEP_TEN_TIMES_RAPIDLY` Beep ten times rapidly using the GO device buzzer.
`BEEP_TEN_TIMES_RAPIDLY_ALLOW_DELAY` Beep ten times rapidly using the GO device buzzer.
`BEEP_THREE_TIMES` Beep three times using the GO device buzzer.
`BEEP_THREE_TIMES_ALLOW_DELAY` Beep three times using the GO device buzzer.
`BEEP_THREE_TIMES_RAPIDLY` Beep three times rapidly using the GO device buzzer.
`BEEP_THREE_TIMES_RAPIDLY_ALLOW_DELAY` Beep three times rapidly using the GO device buzzer.
`CHANGE_STATUS` Recipient must be prompted via a text message in the vehicle (for example, Garmin) to select their status.
`DEVICE_DATA_PRIVACY` DeviceDataPrivacy change will be added.
`EMAIL` Recipient will be notified via either a simple email.
`EMAIL_TO_GROUP` Recipients within a group will be notified via simple email.
`EXPIRE_SHAREABLE_LINK` ShareableLink change will be expired.
`HOS_DISABLED` Hos will be disabled.
`HOS_ENABLED` Hos will be enabled.
`LOG_NEWS_POPUP` Recipient will be notified with a popup notification in the MyGeotab application that will also appear in their Notifications.
`LOG_ONLY` Recipient will be notified via a normal priority log that will appear in their Notifications.
`LOG_POPUP` Recipient will be notified with a popup notification in the MyGeotab application that will also appear in their Notifications.
`LOG_POPUP_INFO` Recipient will be notified with a popup notification in the MyGeotab application that will also appear in their Notifications.
`LOG_URGENT_POPUP` Recipient will be notified with an urgent popup in the MyGeotab application that will also appear in their Notifications.
`TEXT_MESSAGE` Recipient will be notified via a text message in the vehicle (for example, Garmin).
`TEXT_TO_SPEECH` Recipient will be notified via audio from a text to speech application connected to the `GoDevice`.
`TEXT_TO_SPEECH_ALLOW_DELAY` Recipient will be notified via audio from a GoTalk IOX.
`TRIP_TYPE_CHANGE` TripType change will be added.
`UNKNOWN` Fallback when enumeration value is unknown.
`WEB_REQUEST` Recipient will be notified via the related WebRequestTemplate (NotificationBinaryFile).
`WEB_SERVICE` Recipient will be notified via the related Address.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getCode()`
`String`	`getName()`
`static RecipientType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static RecipientType[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - UNKNOWN
```
public static final RecipientType UNKNOWN
```
    Fallback when enumeration value is unknown.
  - LOG_ONLY
```
public static final RecipientType LOG_ONLY
```
    Recipient will be notified via a normal priority log that will appear in their Notifications. A User is required.
  - EMAIL
```
public static final RecipientType EMAIL
```
    Recipient will be notified via either a simple email. A User or valid Address is required. Optionally includes an EmailTemplate (NotificationBinaryFile).
  - LOG_POPUP
```
public static final RecipientType LOG_POPUP
```
    Recipient will be notified with a popup notification in the MyGeotab application that will also appear in their Notifications. A User is required.
  - LOG_URGENT_POPUP
```
public static final RecipientType LOG_URGENT_POPUP
```
    Recipient will be notified with an urgent popup in the MyGeotab application that will also appear in their Notifications. A User is required.
  - ALARM
```
public static final RecipientType ALARM
```
    Recipient will be notified with an alarm sound in the MyGeotab application. A User and NotificationBinaryFile are required.
  - WEB_SERVICE
```
public static final RecipientType WEB_SERVICE
```
    Recipient will be notified via the related Address.
  - TEXT_MESSAGE
```
public static final RecipientType TEXT_MESSAGE
```
    Recipient will be notified via a text message in the vehicle (for example, Garmin).
  - CHANGE_STATUS
```
public static final RecipientType CHANGE_STATUS
```
    Recipient must be prompted via a text message in the vehicle (for example, Garmin) to select their status.
  - BEEP_THREE_TIMES_RAPIDLY
```
public static final RecipientType BEEP_THREE_TIMES_RAPIDLY
```
    Beep three times rapidly using the GO device buzzer.
  - BEEP_THREE_TIMES
```
public static final RecipientType BEEP_THREE_TIMES
```
    Beep three times using the GO device buzzer.
  - BEEP_TEN_TIMES_RAPIDLY
```
public static final RecipientType BEEP_TEN_TIMES_RAPIDLY
```
    Beep ten times rapidly using the GO device buzzer.
  - LOG_POPUP_INFO
```
public static final RecipientType LOG_POPUP_INFO
```
    Recipient will be notified with a popup notification in the MyGeotab application that will also appear in their Notifications.
  - WEB_REQUEST
```
public static final RecipientType WEB_REQUEST
```
    Recipient will be notified via the related WebRequestTemplate (NotificationBinaryFile). A WebRequestTemplate is required.
  - ASSIGN_TO_GROUP
```
public static final RecipientType ASSIGN_TO_GROUP
```
    The vehicle associate with the ExceptionEvent will be assigned to the designated group (removed from sibling groups). A Group is required.
  - TEXT_TO_SPEECH
```
public static final RecipientType TEXT_TO_SPEECH
```
    Recipient will be notified via audio from a text to speech application connected to the GoDevice.
  - LOG_NEWS_POPUP
```
public static final RecipientType LOG_NEWS_POPUP
```
    Recipient will be notified with a popup notification in the MyGeotab application that will also appear in their Notifications. A User is required.
  - BEEP_THREE_TIMES_RAPIDLY_ALLOW_DELAY
```
public static final RecipientType BEEP_THREE_TIMES_RAPIDLY_ALLOW_DELAY
```
    Beep three times rapidly using the GO device buzzer. The device will beep even if there is a delay in the data and may beep after the event causing the exception has ended.
  - BEEP_THREE_TIMES_ALLOW_DELAY
```
public static final RecipientType BEEP_THREE_TIMES_ALLOW_DELAY
```
    Beep three times using the GO device buzzer. The device will beep even if there is a delay in the data and may beep after the event causing the exception has ended.
  - BEEP_TEN_TIMES_RAPIDLY_ALLOW_DELAY
```
public static final RecipientType BEEP_TEN_TIMES_RAPIDLY_ALLOW_DELAY
```
    Beep ten times rapidly using the GO device buzzer. The device will beep even if there is a delay in the data and may beep after the event causing the exception has ended.
  - TEXT_TO_SPEECH_ALLOW_DELAY
```
public static final RecipientType TEXT_TO_SPEECH_ALLOW_DELAY
```
    Recipient will be notified via audio from a GoTalk IOX. The GoTalk will speak even if there is a delay in the data and may beep after the event causing the exception has ended.
  - TRIP_TYPE_CHANGE
```
public static final RecipientType TRIP_TYPE_CHANGE
```
    TripType change will be added.
  - EMAIL_TO_GROUP
```
public static final RecipientType EMAIL_TO_GROUP
```
    Recipients within a group will be notified via simple email. A valid group name is required. Optionally includes an EmailTemplate (NotificationBinaryFile).
  - HOS_ENABLED
```
public static final RecipientType HOS_ENABLED
```
    Hos will be enabled.
  - HOS_DISABLED
```
public static final RecipientType HOS_DISABLED
```
    Hos will be disabled.
  - DEVICE_DATA_PRIVACY
```
public static final RecipientType DEVICE_DATA_PRIVACY
```
    DeviceDataPrivacy change will be added.
  - EXPIRE_SHAREABLE_LINK
```
public static final RecipientType EXPIRE_SHAREABLE_LINK
```
    ShareableLink change will be expired.
- Method Detail
  - values
```
public static RecipientType[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (RecipientType c : RecipientType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static RecipientType valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getCode
```
public int getCode()
```
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface HasName

Enum RecipientType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

UNKNOWN

LOG_ONLY

EMAIL

LOG_POPUP

LOG_URGENT_POPUP

ALARM

WEB_SERVICE

TEXT_MESSAGE

CHANGE_STATUS

BEEP_THREE_TIMES_RAPIDLY

BEEP_THREE_TIMES

BEEP_TEN_TIMES_RAPIDLY

LOG_POPUP_INFO

WEB_REQUEST

ASSIGN_TO_GROUP

TEXT_TO_SPEECH

LOG_NEWS_POPUP

BEEP_THREE_TIMES_RAPIDLY_ALLOW_DELAY

BEEP_THREE_TIMES_ALLOW_DELAY

BEEP_TEN_TIMES_RAPIDLY_ALLOW_DELAY

TEXT_TO_SPEECH_ALLOW_DELAY

TRIP_TYPE_CHANGE

EMAIL_TO_GROUP

HOS_ENABLED

HOS_DISABLED

DEVICE_DATA_PRIVACY

EXPIRE_SHAREABLE_LINK

Method Detail

values

valueOf

getCode

getName