VoiceMessage (com.messagebird:messagebird-api 6.2.1 API)

java.lang.Object
- com.messagebird.objects.VoiceMessage

All Implemented Interfaces:

MessageBase, Serializable
```
public class VoiceMessage
extends Object
implements MessageBase, Serializable
```
Class to hold's a Voice message that can be send
Created by rvt on 1/7/15.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

VoiceMessage(String body, List<BigInteger> recipients)

VoiceMessage(String body, String recipients)

Constructors
Constructor and Description
`VoiceMessage(String body, List<BigInteger> recipients)`
`VoiceMessage(String body, String recipients)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getBody()` The body of the SMS message.
`IfMachineType`	`getIfMachine()` What to do when a machine picks up the phone? Possible values are: - continue do not check, just play the message - delay if a machine answers, wait until the machine stops talking - hangup hangup when a machine answers
`String`	`getLanguage()` The language in which the message needs to be read to the recipient.
`int`	`getMachineTimeout()` The time (in milliseconds) to analyze if a machine has picked up the phone.
`String`	`getOriginator()` The originator (sender) of the message
`String`	`getRecipients()` The list of recipients msisdn's.
`String`	`getReference()`
`Integer`	`getRepeat()` How many times needs the message to be repeated?
`Date`	`getScheduledDatetime()` The scheduled date and time of the message
`VoiceType`	`getVoice()` The voice in which the messages needs to be read to the recipient.
`void`	`setIfMachine(IfMachineType ifMachine)` What to do when a machine picks up the phone? Possible values are: - continue do not check, just play the message - delay if a machine answers, wait until the machine stops talking - hangup hangup when a machine answers Default: continue (set by messagebird server if not send)
`void`	`setLanguage(String language)` The language in which the message needs to be read to the recipient.
`void`	`setMachineTimeout(int machineTimeout)` The time (in milliseconds) to analyze if a machine has picked up the phone.
`void`	`setOriginator(String originator)` Set the originator (sender) of the message
`void`	`setReference(String reference)`
`void`	`setRepeat(Integer repeat)` How many times needs the message to be repeated? Default: 1 (set by messagebird server if not send)
`void`	`setScheduledDatetime(Date scheduledDatetime)` The scheduled date and time of the message.
`void`	`setVoice(VoiceType voice)` The voice in which the messages needs to be read to the recipient.

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

- Constructor Detail
  - VoiceMessage
```
public VoiceMessage(String body,
                    List<BigInteger> recipients)
```
  - VoiceMessage
```
public VoiceMessage(String body,
                    String recipients)
```
- Method Detail
  - getBody
```
public String getBody()
```
    The body of the SMS message.
    
    Specified by:
    
    getBody in interface MessageBase
    
    Returns:
    
    Message body
  - getOriginator
```
public String getOriginator()
```
    The originator (sender) of the message
    
    Returns:
    
    String
  - setOriginator
```
public void setOriginator(String originator)
```
    Set the originator (sender) of the message
  - getRecipients
```
public String getRecipients()
```
    The list of recipients msisdn's.
    
    Specified by:
    
    getRecipients in interface MessageBase
    
    Returns:
    
    String of comma separated recipients
  - getReference
```
public String getReference()
```
    Specified by:
    
    getReference in interface MessageBase
    
    Returns:
    
    your own reference
  - setReference
```
public void setReference(String reference)
```
  - getLanguage
```
public String getLanguage()
```
    The language in which the message needs to be read to the recipient. Possible values are: nl-nl, de-de, en-gb, en-us, fr-fr.
    
    Returns:
    
    seleted language
  - setLanguage
```
public void setLanguage(String language)
```
    The language in which the message needs to be read to the recipient. Possible values are: nl-nl, de-de, en-gb, en-us, fr-fr. Default: en-gb (set by messagebird server if not send)
    
    Parameters:
    
    language - Possible values are: nl-nl, de-de, en-gb, en-us, fr-fr.
  - getVoice
```
public VoiceType getVoice()
```
    The voice in which the messages needs to be read to the recipient. Possible values are: male, female.
    
    Returns:
  - setVoice
```
public void setVoice(VoiceType voice)
```
    The voice in which the messages needs to be read to the recipient. Possible values are: male, female. Default: female (set by messagebird server if not send)
    
    Parameters:
    
    voice - Possible values are: male, female.
  - getRepeat
```
public Integer getRepeat()
```
    How many times needs the message to be repeated?
    
    Returns:
    
    Number of repetitions
  - setRepeat
```
public void setRepeat(Integer repeat)
```
    How many times needs the message to be repeated? Default: 1 (set by messagebird server if not send)
    
    Parameters:
    
    repeat - number of repetitions for the voice message
  - getIfMachine
```
public IfMachineType getIfMachine()
```
    What to do when a machine picks up the phone? Possible values are: - continue do not check, just play the message - delay if a machine answers, wait until the machine stops talking - hangup hangup when a machine answers
    
    Returns:
    
    what to do if a machine picks up
  - setIfMachine
```
public void setIfMachine(IfMachineType ifMachine)
```
    What to do when a machine picks up the phone? Possible values are: - continue do not check, just play the message - delay if a machine answers, wait until the machine stops talking - hangup hangup when a machine answers Default: continue (set by messagebird server if not send)
    
    Parameters:
    
    ifMachine -
  - getMachineTimeout
```
public int getMachineTimeout()
```
    The time (in milliseconds) to analyze if a machine has picked up the phone. Used in combination with the delay and hangup values of the ifMachine attribute. Minimum: 400, maximum: 10000. Default: 7000
    
    Returns:
    
    value of machine timeout
  - setMachineTimeout
```
public void setMachineTimeout(int machineTimeout)
```
    The time (in milliseconds) to analyze if a machine has picked up the phone. Used in combination with the delay and hangup values of the ifMachine attribute. Minimum: 400, maximum: 10000. Default: 7000
    
    Parameters:
    
    machineTimeout - value of machine timeout
  - getScheduledDatetime
```
public Date getScheduledDatetime()
```
    Description copied from interface: MessageBase
    
    The scheduled date and time of the message
    
    Specified by:
    
    getScheduledDatetime in interface MessageBase
    
    Returns:
    
    the configured date/time to send the mesage, this is handled on the message bird platform
  - setScheduledDatetime
```
public void setScheduledDatetime(Date scheduledDatetime)
```
    The scheduled date and time of the message. Allows to specify when MessageBird server send's the mesage.
    
    Parameters:
    
    scheduledDatetime - Date

Class VoiceMessage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VoiceMessage

VoiceMessage

Method Detail

getBody

getOriginator

setOriginator

getRecipients

getReference

setReference

getLanguage

setLanguage

getVoice

setVoice

getRepeat

setRepeat

getIfMachine

setIfMachine

getMachineTimeout

setMachineTimeout

getScheduledDatetime

setScheduledDatetime