Class UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest
java.lang.Object
co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>
co.ecg.alpaca.toolkit.generated.services.UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest
- Enclosing class:
- UserBroadWorksMobility
@ChoiceGroup("accessDeviceEndpoint") @ChoiceGroup("outboundAlternateNumber")
public static class UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest
extends Request<DefaultResponse>
Add a mobile identity to the user's list of mobile identities. The response is either a SuccessResponse or an ErrorResponse. The request fails when the devicesToRing is set to Mobile and the mobileNumberAlerted list is empty.
- 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 @Valid AccessDeviceEndpointAndHotlineAdd
protected @NotNull Boolean
protected @NotNull Boolean
protected @NotNull Boolean
protected @NotNull Boolean
protected @NotNull Boolean
protected @NotNull Boolean
protected @Size(min=1,max=40) String
protected @NotNull BroadWorksMobilityPhoneToRing
protected @NotNull Boolean
protected @NotNull Boolean
protected @NotNull Boolean
protected @NotNull Boolean
protected @Valid ScheduleGlobalKey
protected @NotNull Boolean
protected @NotNull Boolean
protected @NotNull Boolean
protected @NotNull Boolean
protected @NotNull Boolean
protected @NotNull @Size(min=1,max=23) String
protected String[]
protected @Size(min=1,max=128) String
protected @Size(min=1,max=161) String
protected @NotNull Boolean
protected @Valid ScheduleGlobalKey
protected @NotNull Boolean
protected @NotNull Boolean
protected @NotNull @Valid BroadWorksUser
protected @NotNull BroadWorksMobilityUserSettingLevel
-
Constructor Summary
ConstructorsConstructorDescriptionUserBroadWorksMobilityMobileIdentityAddRequest
(AccessDeviceEndpointAndHotlineAdd accessDeviceEndpoint, BroadWorksUser user, String mobileNumber, Boolean isPrimary, Boolean enableAlerting, Boolean alertAgentCalls, Boolean alertClickToDialCalls, Boolean alertGroupPagingCalls, Boolean useMobilityCallingLineID, Boolean enableDiversionInhibitor, Boolean requireAnswerConfirmation, Boolean broadworksCallControl, BroadWorksMobilityUserSettingLevel useSettingLevel, Boolean denyCallOriginations, Boolean denyCallTerminations, BroadWorksMobilityPhoneToRing devicesToRing, Boolean includeSharedCallAppearance, Boolean includeBroadworksAnywhere, Boolean includeExecutiveAssistant, Boolean enableCallAnchoring, Boolean enableDirectRouting, Boolean markCDRAsEnterpriseGroupCalls, Boolean useMobilityConnectedIdentity) UserBroadWorksMobilityMobileIdentityAddRequest
(BroadWorksUser user, String mobileNumber, Boolean isPrimary, Boolean enableAlerting, Boolean alertAgentCalls, Boolean alertClickToDialCalls, Boolean alertGroupPagingCalls, Boolean useMobilityCallingLineID, Boolean enableDiversionInhibitor, Boolean requireAnswerConfirmation, Boolean broadworksCallControl, BroadWorksMobilityUserSettingLevel useSettingLevel, Boolean denyCallOriginations, Boolean denyCallTerminations, BroadWorksMobilityPhoneToRing devicesToRing, Boolean includeSharedCallAppearance, Boolean includeBroadworksAnywhere, Boolean includeExecutiveAssistant, Boolean enableCallAnchoring, Boolean enableDirectRouting, Boolean markCDRAsEnterpriseGroupCalls, Boolean useMobilityConnectedIdentity) UserBroadWorksMobilityMobileIdentityAddRequest
(String outboundAlternateNumber, BroadWorksUser user, String mobileNumber, Boolean isPrimary, Boolean enableAlerting, Boolean alertAgentCalls, Boolean alertClickToDialCalls, Boolean alertGroupPagingCalls, Boolean useMobilityCallingLineID, Boolean enableDiversionInhibitor, Boolean requireAnswerConfirmation, Boolean broadworksCallControl, BroadWorksMobilityUserSettingLevel useSettingLevel, Boolean denyCallOriginations, Boolean denyCallTerminations, BroadWorksMobilityPhoneToRing devicesToRing, Boolean includeSharedCallAppearance, Boolean includeBroadworksAnywhere, Boolean includeExecutiveAssistant, Boolean enableCallAnchoring, Boolean enableDirectRouting, Boolean markCDRAsEnterpriseGroupCalls, Boolean useMobilityConnectedIdentity) -
Method Summary
Modifier and TypeMethodDescriptionvoid
Forms the XML Document for this Request Object.getEmptyObject
(BroadWorksServer broadWorksServer) Retrieves this object with minimal setup.String[]
setAccessDeviceEndpoint
(AccessDeviceEndpointAndHotlineAdd accessDeviceEndpoint) setAlertAgentCalls
(Boolean alertAgentCalls) setAlertClickToDialCalls
(Boolean alertClickToDialCalls) setAlertGroupPagingCalls
(Boolean alertGroupPagingCalls) setBroadworksCallControl
(Boolean broadworksCallControl) setDenyCallOriginations
(Boolean denyCallOriginations) setDenyCallTerminations
(Boolean denyCallTerminations) setDescription
(String description) setDevicesToRing
(BroadWorksMobilityPhoneToRing devicesToRing) setEnableAlerting
(Boolean enableAlerting) setEnableCallAnchoring
(Boolean enableCallAnchoring) setEnableDirectRouting
(Boolean enableDirectRouting) setEnableDiversionInhibitor
(Boolean enableDiversionInhibitor) setHolidaySchedule
(ScheduleGlobalKey holidaySchedule) setIncludeBroadworksAnywhere
(Boolean includeBroadworksAnywhere) setIncludeExecutiveAssistant
(Boolean includeExecutiveAssistant) setIncludeSharedCallAppearance
(Boolean includeSharedCallAppearance) setIsPrimary
(Boolean isPrimary) setMarkCDRAsEnterpriseGroupCalls
(Boolean markCDRAsEnterpriseGroupCalls) setMobileNumber
(String mobileNumber) setMobileNumberAlerted
(String... mobileNumberAlerted) setNetworkTranslationIndex
(String networkTranslationIndex) setOutboundAlternateNumber
(String outboundAlternateNumber) setRequireAnswerConfirmation
(Boolean requireAnswerConfirmation) setTimeSchedule
(ScheduleGlobalKey timeSchedule) setUseMobilityCallingLineID
(Boolean useMobilityCallingLineID) setUseMobilityConnectedIdentity
(Boolean useMobilityConnectedIdentity) setUser
(BroadWorksUser user) setUseSettingLevel
(BroadWorksMobilityUserSettingLevel useSettingLevel) 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
-
user
-
mobileNumber
-
description
-
isPrimary
-
enableAlerting
-
alertAgentCalls
-
alertClickToDialCalls
-
alertGroupPagingCalls
-
useMobilityCallingLineID
-
enableDiversionInhibitor
-
requireAnswerConfirmation
-
broadworksCallControl
-
useSettingLevel
-
denyCallOriginations
-
denyCallTerminations
-
devicesToRing
-
includeBroadworksAnywhere
-
includeExecutiveAssistant
-
mobileNumberAlerted
-
enableCallAnchoring
-
timeSchedule
-
holidaySchedule
-
accessDeviceEndpoint
-
outboundAlternateNumber
-
enableDirectRouting
-
markCDRAsEnterpriseGroupCalls
-
useMobilityConnectedIdentity
-
networkTranslationIndex
-
-
Constructor Details
-
UserBroadWorksMobilityMobileIdentityAddRequest
public UserBroadWorksMobilityMobileIdentityAddRequest() -
UserBroadWorksMobilityMobileIdentityAddRequest
public UserBroadWorksMobilityMobileIdentityAddRequest(BroadWorksUser user, String mobileNumber, Boolean isPrimary, Boolean enableAlerting, Boolean alertAgentCalls, Boolean alertClickToDialCalls, Boolean alertGroupPagingCalls, Boolean useMobilityCallingLineID, Boolean enableDiversionInhibitor, Boolean requireAnswerConfirmation, Boolean broadworksCallControl, BroadWorksMobilityUserSettingLevel useSettingLevel, Boolean denyCallOriginations, Boolean denyCallTerminations, BroadWorksMobilityPhoneToRing devicesToRing, Boolean includeSharedCallAppearance, Boolean includeBroadworksAnywhere, Boolean includeExecutiveAssistant, Boolean enableCallAnchoring, Boolean enableDirectRouting, Boolean markCDRAsEnterpriseGroupCalls, Boolean useMobilityConnectedIdentity) -
UserBroadWorksMobilityMobileIdentityAddRequest
public UserBroadWorksMobilityMobileIdentityAddRequest(AccessDeviceEndpointAndHotlineAdd accessDeviceEndpoint, BroadWorksUser user, String mobileNumber, Boolean isPrimary, Boolean enableAlerting, Boolean alertAgentCalls, Boolean alertClickToDialCalls, Boolean alertGroupPagingCalls, Boolean useMobilityCallingLineID, Boolean enableDiversionInhibitor, Boolean requireAnswerConfirmation, Boolean broadworksCallControl, BroadWorksMobilityUserSettingLevel useSettingLevel, Boolean denyCallOriginations, Boolean denyCallTerminations, BroadWorksMobilityPhoneToRing devicesToRing, Boolean includeSharedCallAppearance, Boolean includeBroadworksAnywhere, Boolean includeExecutiveAssistant, Boolean enableCallAnchoring, Boolean enableDirectRouting, Boolean markCDRAsEnterpriseGroupCalls, Boolean useMobilityConnectedIdentity) -
UserBroadWorksMobilityMobileIdentityAddRequest
public UserBroadWorksMobilityMobileIdentityAddRequest(String outboundAlternateNumber, BroadWorksUser user, String mobileNumber, Boolean isPrimary, Boolean enableAlerting, Boolean alertAgentCalls, Boolean alertClickToDialCalls, Boolean alertGroupPagingCalls, Boolean useMobilityCallingLineID, Boolean enableDiversionInhibitor, Boolean requireAnswerConfirmation, Boolean broadworksCallControl, BroadWorksMobilityUserSettingLevel useSettingLevel, Boolean denyCallOriginations, Boolean denyCallTerminations, BroadWorksMobilityPhoneToRing devicesToRing, Boolean includeSharedCallAppearance, Boolean includeBroadworksAnywhere, Boolean includeExecutiveAssistant, Boolean enableCallAnchoring, Boolean enableDirectRouting, Boolean markCDRAsEnterpriseGroupCalls, Boolean useMobilityConnectedIdentity)
-
-
Method Details
-
setUser
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setUser(BroadWorksUser user) -
getBroadWorksUser
-
setMobileNumber
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setMobileNumber(String mobileNumber) -
getMobileNumber
-
setDescription
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setDescription(String description) -
getDescription
-
setIsPrimary
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setIsPrimary(Boolean isPrimary) -
getIsPrimary
-
setEnableAlerting
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setEnableAlerting(Boolean enableAlerting) -
getEnableAlerting
-
setAlertAgentCalls
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setAlertAgentCalls(Boolean alertAgentCalls) -
getAlertAgentCalls
-
setAlertClickToDialCalls
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setAlertClickToDialCalls(Boolean alertClickToDialCalls) -
getAlertClickToDialCalls
-
setAlertGroupPagingCalls
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setAlertGroupPagingCalls(Boolean alertGroupPagingCalls) -
getAlertGroupPagingCalls
-
setUseMobilityCallingLineID
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setUseMobilityCallingLineID(Boolean useMobilityCallingLineID) -
getUseMobilityCallingLineID
-
setEnableDiversionInhibitor
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setEnableDiversionInhibitor(Boolean enableDiversionInhibitor) -
getEnableDiversionInhibitor
-
setRequireAnswerConfirmation
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setRequireAnswerConfirmation(Boolean requireAnswerConfirmation) -
getRequireAnswerConfirmation
-
setBroadworksCallControl
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setBroadworksCallControl(Boolean broadworksCallControl) -
getBroadworksCallControl
-
setUseSettingLevel
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setUseSettingLevel(BroadWorksMobilityUserSettingLevel useSettingLevel) -
getUseSettingLevel
-
setDenyCallOriginations
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setDenyCallOriginations(Boolean denyCallOriginations) -
getDenyCallOriginations
-
setDenyCallTerminations
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setDenyCallTerminations(Boolean denyCallTerminations) -
getDenyCallTerminations
-
setDevicesToRing
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setDevicesToRing(BroadWorksMobilityPhoneToRing devicesToRing) -
getDevicesToRing
-
setIncludeBroadworksAnywhere
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setIncludeBroadworksAnywhere(Boolean includeBroadworksAnywhere) -
getIncludeBroadworksAnywhere
-
setIncludeExecutiveAssistant
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setIncludeExecutiveAssistant(Boolean includeExecutiveAssistant) -
getIncludeExecutiveAssistant
-
setMobileNumberAlerted
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setMobileNumberAlerted(String... mobileNumberAlerted) -
getMobileNumberAlerted
-
setEnableCallAnchoring
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setEnableCallAnchoring(Boolean enableCallAnchoring) -
getEnableCallAnchoring
-
setTimeSchedule
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setTimeSchedule(ScheduleGlobalKey timeSchedule) -
getTimeSchedule
-
setHolidaySchedule
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setHolidaySchedule(ScheduleGlobalKey holidaySchedule) -
getHolidaySchedule
-
setAccessDeviceEndpoint
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setAccessDeviceEndpoint(AccessDeviceEndpointAndHotlineAdd accessDeviceEndpoint) -
getAccessDeviceEndpoint
-
setOutboundAlternateNumber
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setOutboundAlternateNumber(String outboundAlternateNumber) -
getOutboundAlternateNumber
-
setEnableDirectRouting
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setEnableDirectRouting(Boolean enableDirectRouting) -
getEnableDirectRouting
-
setMarkCDRAsEnterpriseGroupCalls
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setMarkCDRAsEnterpriseGroupCalls(Boolean markCDRAsEnterpriseGroupCalls) -
getMarkCDRAsEnterpriseGroupCalls
-
setUseMobilityConnectedIdentity
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setUseMobilityConnectedIdentity(Boolean useMobilityConnectedIdentity) -
getUseMobilityConnectedIdentity
-
setNetworkTranslationIndex
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setNetworkTranslationIndex(String networkTranslationIndex) -
getNetworkTranslationIndex
-
getEmptyObject
public static UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest 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>
-