Package co.ecg.alpaca.toolkit.generated.services

Class UserVoiceMessaging.UserVoiceMessagingUserModifyVoicePortalRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>

co.ecg.alpaca.toolkit.generated.services.UserVoiceMessaging.UserVoiceMessagingUserModifyVoicePortalRequest

Enclosing class:

UserVoiceMessaging

public static class UserVoiceMessaging.UserVoiceMessagingUserModifyVoicePortalRequest
extends Request<DefaultResponse>

Modify the user's voice messaging voice portal settings. The response is either a SuccessResponse or an ErrorResponse. Engineering Note: This command is used internally by Call Processing.

Author:

AlpacaGenerator

Nested Class Summary

Nested classes/interfaces inherited from class co.ecg.alpaca.toolkit.messaging.request.Request

Request.Protocol

Field Summary

Fields

Modifier and Type	Field	Description
protected Optional<@Valid AnnouncementFileLevelKey>	personalizedNameAudioFile
protected Boolean	usePersonalizedName
protected @NotNull @Valid BroadWorksUser	user
protected Boolean	voicePortalAutoLogin

Fields inherited from class co.ecg.alpaca.toolkit.messaging.request.Request

log

Constructor Summary

Constructors

Constructor	Description
UserVoiceMessagingUserModifyVoicePortalRequest()
UserVoiceMessagingUserModifyVoicePortalRequest(BroadWorksUser user)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
static UserVoiceMessaging.UserVoiceMessagingUserModifyVoicePortalRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Optional<@Valid AnnouncementFileLevelKey>	getPersonalizedNameAudioFile()
Boolean	getUsePersonalizedName()
Boolean	getVoicePortalAutoLogin()
UserVoiceMessaging.UserVoiceMessagingUserModifyVoicePortalRequest	setPersonalizedNameAudioFile(AnnouncementFileLevelKey personalizedNameAudioFile)
UserVoiceMessaging.UserVoiceMessagingUserModifyVoicePortalRequest	setUsePersonalizedName(Boolean usePersonalizedName)
UserVoiceMessaging.UserVoiceMessagingUserModifyVoicePortalRequest	setUser(BroadWorksUser user)
UserVoiceMessaging.UserVoiceMessagingUserModifyVoicePortalRequest	setVoicePortalAutoLogin(Boolean voicePortalAutoLogin)
UserVoiceMessaging.UserVoiceMessagingUserModifyVoicePortalRequest	unsetPersonalizedNameAudioFile()

Methods inherited from class co.ecg.alpaca.toolkit.messaging.request.Request

appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createNilElement, createTextElement, equals, fire, fire, getBroadWorksServer, getCacheString, getCommandElement, getCommandType, getDomDocument, getId, getOCSProtocol, getRequestTimeoutMillis, getResponseClass, getRetries, getRetryCodes, getRootElement, getValidationErrorsAsString, hashCode, isIgnoreCache, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, setIgnoreCache, setMemberOfBundle, setRequestId, setRequestTimeoutMillis, setResponseClass, setRetries, setRetryCodes, setRootElement, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

user

@NotNull
@Valid
protected transient @NotNull @Valid BroadWorksUser user

usePersonalizedName

protected Boolean usePersonalizedName

voicePortalAutoLogin

protected Boolean voicePortalAutoLogin

personalizedNameAudioFile

protected Optional<@Valid AnnouncementFileLevelKey> personalizedNameAudioFile

Constructor Details

UserVoiceMessagingUserModifyVoicePortalRequest

public UserVoiceMessagingUserModifyVoicePortalRequest()

UserVoiceMessagingUserModifyVoicePortalRequest

public UserVoiceMessagingUserModifyVoicePortalRequest(BroadWorksUser user)

Method Details

setUser

public UserVoiceMessaging.UserVoiceMessagingUserModifyVoicePortalRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setUsePersonalizedName

public UserVoiceMessaging.UserVoiceMessagingUserModifyVoicePortalRequest setUsePersonalizedName(Boolean usePersonalizedName)

getUsePersonalizedName

public Boolean getUsePersonalizedName()

setVoicePortalAutoLogin

public UserVoiceMessaging.UserVoiceMessagingUserModifyVoicePortalRequest setVoicePortalAutoLogin(Boolean voicePortalAutoLogin)

getVoicePortalAutoLogin

public Boolean getVoicePortalAutoLogin()

unsetPersonalizedNameAudioFile

public UserVoiceMessaging.UserVoiceMessagingUserModifyVoicePortalRequest unsetPersonalizedNameAudioFile()

setPersonalizedNameAudioFile

public UserVoiceMessaging.UserVoiceMessagingUserModifyVoicePortalRequest setPersonalizedNameAudioFile(AnnouncementFileLevelKey personalizedNameAudioFile)

getPersonalizedNameAudioFile

public Optional<@Valid AnnouncementFileLevelKey> getPersonalizedNameAudioFile()

getEmptyObject

public static UserVoiceMessaging.UserVoiceMessagingUserModifyVoicePortalRequest getEmptyObject(BroadWorksServer broadWorksServer)

Retrieves this object with minimal setup.

Parameters:

broadWorksServer - The BroadWorksServer

formRequest

public void formRequest()

Forms the XML Document for this Request Object. Called by the Request upon fire().

Overrides:

formRequest in class Request<DefaultResponse>