Class GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest
java.lang.Object
co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>
co.ecg.alpaca.toolkit.generated.services.GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest
- Enclosing class:
- GroupVoiceMessaging
public static class GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest
extends Request<DefaultResponse>
Request to modify the group's voice messaging settings and voice portal branding settings. If UnassignPhoneNumbersLevel is set to 'Group', the user's primary phone number, fax number and any alternate numbers, will be un-assigned from the group if the command is executed by a service provider administrator or above. When set to 'Service Provider', they will be un-assigned from the group and service provider if the command is executed by a provisioning administrator or above. When omitted, the number(s) will be left assigned to the group. An ErrorResponse will be returned if any number cannot be unassigned because of insufficient privilege. The response is either SuccessResponse or ErrorResponse.
- Author:
- AlpacaGenerator
-
Nested Class Summary
Nested classes/interfaces inherited from class co.ecg.alpaca.toolkit.messaging.request.Request
Request.Protocol
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected @AssertTrue Boolean
protected Boolean
protected Boolean
protected @NotNull @Valid Group
protected Boolean
protected @Size(min=1,max=40) String
protected @Valid ServiceInstanceModifyProfile
protected UnassignPhoneNumbersLevel
protected Boolean
protected Boolean
protected Optional<@Valid AnnouncementFileKey>
protected VoiceMessagingBrandingSelection
protected VoicePortalExternalRoutingScope
protected Optional<@Valid AnnouncementFileKey>
protected VoiceMessagingBrandingSelection
-
Constructor Summary
ConstructorsConstructorDescription -
Method Summary
Modifier and TypeMethodDescriptionboolean
void
Forms the XML Document for this Request Object.getEmptyObject
(BroadWorksServer broadWorksServer) Retrieves this object with minimal setup.getGroup()
Optional<@Valid AnnouncementFileKey>
Optional<@Valid AnnouncementFileKey>
setAllowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin
(Boolean allowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin) setEnableExtendedScope
(Boolean enableExtendedScope) setExternalRoutingAddress
(String externalRoutingAddress) setHomeZoneName
(String homeZoneName) setIsActive
(Boolean isActive) setNetworkClassOfService
(String networkClassOfService) setServiceInstanceProfile
(ServiceInstanceModifyProfile serviceInstanceProfile) setUnassignPhoneNumbers
(UnassignPhoneNumbersLevel unassignPhoneNumbers) setUseExternalRouting
(Boolean useExternalRouting) setUseVoicePortalWizard
(Boolean useVoicePortalWizard) setVoiceMessagingGreetingFile
(AnnouncementFileKey voiceMessagingGreetingFile) setVoiceMessagingGreetingSelection
(VoiceMessagingBrandingSelection voiceMessagingGreetingSelection) setVoicePortalExternalRoutingScope
(VoicePortalExternalRoutingScope voicePortalExternalRoutingScope) setVoicePortalGreetingFile
(AnnouncementFileKey voicePortalGreetingFile) setVoicePortalGreetingSelection
(VoiceMessagingBrandingSelection voicePortalGreetingSelection) 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
-
Field Details
-
group
-
unassignPhoneNumbers
-
addPhoneNumberToGroup
-
serviceInstanceProfile
-
isActive
-
enableExtendedScope
-
allowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin
-
useVoicePortalWizard
-
voicePortalExternalRoutingScope
-
useExternalRouting
-
externalRoutingAddress
-
homeZoneName
-
networkClassOfService
-
voicePortalGreetingSelection
-
voicePortalGreetingFile
-
voiceMessagingGreetingSelection
-
voiceMessagingGreetingFile
-
-
Constructor Details
-
GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest
public GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest() -
GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest
-
-
Method Details
-
setGroup
public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setGroup(Group group) -
getGroup
-
setUnassignPhoneNumbers
public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setUnassignPhoneNumbers(UnassignPhoneNumbersLevel unassignPhoneNumbers) -
getUnassignPhoneNumbers
-
setFlagAddPhoneNumberToGroup
public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setFlagAddPhoneNumberToGroup() -
addPhoneNumberToGroupFlagExist
public boolean addPhoneNumberToGroupFlagExist() -
getAddPhoneNumberToGroup
-
setServiceInstanceProfile
public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setServiceInstanceProfile(ServiceInstanceModifyProfile serviceInstanceProfile) -
getServiceInstanceProfile
-
setIsActive
public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setIsActive(Boolean isActive) -
getIsActive
-
setEnableExtendedScope
public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setEnableExtendedScope(Boolean enableExtendedScope) -
getEnableExtendedScope
-
setAllowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin
public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setAllowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin(Boolean allowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin) -
getAllowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin
-
setUseVoicePortalWizard
public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setUseVoicePortalWizard(Boolean useVoicePortalWizard) -
getUseVoicePortalWizard
-
setVoicePortalExternalRoutingScope
public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setVoicePortalExternalRoutingScope(VoicePortalExternalRoutingScope voicePortalExternalRoutingScope) -
getVoicePortalExternalRoutingScope
-
setUseExternalRouting
public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setUseExternalRouting(Boolean useExternalRouting) -
getUseExternalRouting
-
unsetExternalRoutingAddress
public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest unsetExternalRoutingAddress() -
setExternalRoutingAddress
public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setExternalRoutingAddress(String externalRoutingAddress) -
getExternalRoutingAddress
-
unsetHomeZoneName
public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest unsetHomeZoneName() -
setHomeZoneName
public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setHomeZoneName(String homeZoneName) -
getHomeZoneName
-
setNetworkClassOfService
public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setNetworkClassOfService(String networkClassOfService) -
getNetworkClassOfService
-
setVoicePortalGreetingSelection
public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setVoicePortalGreetingSelection(VoiceMessagingBrandingSelection voicePortalGreetingSelection) -
getVoicePortalGreetingSelection
-
unsetVoicePortalGreetingFile
public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest unsetVoicePortalGreetingFile() -
setVoicePortalGreetingFile
public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setVoicePortalGreetingFile(AnnouncementFileKey voicePortalGreetingFile) -
getVoicePortalGreetingFile
-
setVoiceMessagingGreetingSelection
public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setVoiceMessagingGreetingSelection(VoiceMessagingBrandingSelection voiceMessagingGreetingSelection) -
getVoiceMessagingGreetingSelection
-
unsetVoiceMessagingGreetingFile
public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest unsetVoiceMessagingGreetingFile() -
setVoiceMessagingGreetingFile
public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setVoiceMessagingGreetingFile(AnnouncementFileKey voiceMessagingGreetingFile) -
getVoiceMessagingGreetingFile
-
getEmptyObject
public static GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest 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 classRequest<DefaultResponse>
-