com.telapi.api.inboundxml.parameters
Class ConferenceParameters

java.lang.Object
  com.telapi.api.inboundxml.parameters.ConferenceParameters

public class ConferenceParameters
extends Object

Constructor Summary

ConferenceParameters()

Method Summary

Boolean	getBeep()
HttpMethod	getCallbackMethod()
String	getCallbackUrl()
String	getConferenceName()
String	getDigitsMatch()
Boolean	getEndConferenceOnExit()
Boolean	getHangupOnStar()
Long	getMaxParticipants()
Boolean	getMuted()
Boolean	getStartConferenceOnEnter()
Boolean	getStayAlone()
HttpMethod	getWaitMethod()
String	getWaitSound()
HttpMethod	getWaitSoundMethod()
String	getWaitUrl()
void	setBeep(Boolean beep)
void	setCallbackMethod(HttpMethod callbackMethod)
void	setCallbackUrl(String callbackUrl)
void	setConferenceName(String conferenceName)
void	setDigitsMatch(String digitsMatch)
void	setEndConferenceOnExit(Boolean endConferenceOnExit)
void	setHangupOnStar(Boolean hangupOnStar)
void	setMaxParticipants(Long maxParticipants)
void	setMuted(Boolean muted)
void	setStartConferenceOnEnter(Boolean startConferenceOnEnter)
void	setStayAlone(Boolean stayAlone)
void	setWaitMethod(HttpMethod waitMethod)
void	setWaitSound(String waitSound)
void	setWaitSoundMethod(HttpMethod waitSoundMethod)
void	setWaitUrl(String waitUrl)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConferenceParameters

public ConferenceParameters()

Method Detail

getConferenceName

public String getConferenceName()

setConferenceName

public void setConferenceName(String conferenceName)

Parameters:

conferenceName - The conference name (required).

getMuted

public Boolean getMuted()

setMuted

public void setMuted(Boolean muted)

Parameters:

muted - Boolean value specifying if the conference should be muted. Defaults to false.

getBeep

public Boolean getBeep()

setBeep

public void setBeep(Boolean beep)

Parameters:

beep - Boolean value specifying if a beep should play upon entrance to conference. Defaults to false.

getStartConferenceOnEnter

public Boolean getStartConferenceOnEnter()

setStartConferenceOnEnter

public void setStartConferenceOnEnter(Boolean startConferenceOnEnter)

Parameters:

startConferenceOnEnter - Boolean value specifying if conference should begin upon entrance. Defaults to true.

getEndConferenceOnExit

public Boolean getEndConferenceOnExit()

setEndConferenceOnExit

public void setEndConferenceOnExit(Boolean endConferenceOnExit)

Parameters:

endConferenceOnExit - Boolean value specifying if conference should begin upon exit. Defaults to true.

getMaxParticipants

public Long getMaxParticipants()

setMaxParticipants

public void setMaxParticipants(Long maxParticipants)

Parameters:

maxParticipants - The maximum number of participants allowed in the conference call. Defaults to 40.

getWaitUrl

public String getWaitUrl()

setWaitUrl

public void setWaitUrl(String waitUrl)

Parameters:

waitUrl - URL conference participants can be sent to while they wait for entrance into the conference.

getWaitMethod

public HttpMethod getWaitMethod()

setWaitMethod

public void setWaitMethod(HttpMethod waitMethod)

Parameters:

waitMethod - Method used to request waitUrl. Defaults to POST.

getHangupOnStar

public Boolean getHangupOnStar()

setHangupOnStar

public void setHangupOnStar(Boolean hangupOnStar)

Parameters:

hangupOnStar - Boolean value specifying if pressing * should end the conference. Defaults to false.

getCallbackUrl

public String getCallbackUrl()

setCallbackUrl

public void setCallbackUrl(String callbackUrl)

Parameters:

callbackUrl - URL where some parameters specific to Conference will be sent once it is completed.

getCallbackMethod

public HttpMethod getCallbackMethod()

setCallbackMethod

public void setCallbackMethod(HttpMethod callbackMethod)

Parameters:

callbackMethod - Method used to request the callback URL. Defaults to POST.

getWaitSound

public String getWaitSound()

setWaitSound

public void setWaitSound(String waitSound)

Parameters:

waitSound - URL to sound that can be played while waiting to enter the conference.

getWaitSoundMethod

public HttpMethod getWaitSoundMethod()

setWaitSoundMethod

public void setWaitSoundMethod(HttpMethod waitSoundMethod)

Parameters:

waitSoundMethod - Method used to request the waitsound URL. Defaults to POST.

getDigitsMatch

public String getDigitsMatch()

setDigitsMatch

public void setDigitsMatch(String digitsMatch)

Parameters:

digitsMatch - Specifies digits that TelAPI should listen for and send to the callbackUrl if a caller inputs them. Seperate additional digits or digit patterns with a comma. Can be a digit, # or *.

getStayAlone

public Boolean getStayAlone()

setStayAlone

public void setStayAlone(Boolean stayAlone)

Parameters:

stayAlone - Boolean value specifying if the caller should stay alone in the conference call. Defaults to true.