Package co.ecg.alpaca.toolkit.generated
Class User
java.lang.Object
co.ecg.alpaca.toolkit.model.BroadWorksObject
co.ecg.alpaca.toolkit.model.BroadWorksUser
co.ecg.alpaca.toolkit.generated.User
- All Implemented Interfaces:
Serializable
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Request to configure a WebEx room/place to have the primary endpoint of WebEx Teams device. placeUserId refers to a WebEx room/place. webExSIPAddress specifies the WebEx SIP address of the place.static class
Requests the list of access devices associated to a user and their device activation information.static class
Response to UserAccessDeviceDeviceActivationGetListRequest.static class
Request to get the list of Device Management user modifiable files.static class
Response to UserAccessDeviceFileGetListRequest.static class
Request to get a user modifiable file.static class
Response to UserAccessDeviceFileGetRequest.static class
Request to modify a user modifiable access device file.static class
Reset a specific user SIP device that supports the reset operation.static class
Request to get all the device tag names and values for a specific device.static class
Response to UserAccessDeviceTagsGetRequest.static class
Request to add a user.static class
Request to add an alternate user Id to an user.static class
Request to delete an alternate user id of a user.static class
Request to get the user id and the list of alternate user ids of an user.static class
Response to UserAlternateUserIdGetListRequest.static class
Request to modify an alternate user id of a user.static class
Add an announcement to the user announcement repository The following elements are only used in AS data mode and ignored in XS data mode: announcementFileExternalId The response is either a SuccessResponse or an ErrorResponse.static class
Delete one or more announcements from the user announcement repository The following elements are only used in AS data mode and ignored in XS data mode: announcementFileExternalId The response is either a SuccessResponse or an ErrorResponse.static class
Get the list of available announcement files for a User from the Announcement Repository, for Virtual subscribers the list will also include the announcements for it's group.static class
Response to UserAnnouncementFileGetAvailableListRequest.static class
Get the list of announcement names with associated media type and filesize for a User and given Announcement Repository Type The response is either a UserAnnouncementFileGetListResponse or an ErrorResponse.static class
Response to UserAnnouncementFileGetListRequest.static class
Get the list of announcement files for a user.static class
Response to UserAnnouncementFileGetPagedSortedListRequest.static class
Request to get the announcement repository file information.static class
Response to UserAnnouncementFileGetRequest22.static class
This command is used to change the name of the file or upload a new announcement file for an existing announcement in the user repository.static class
Return the disk space being used.static class
Response to UserAnnouncementRepositoryGetSettingsRequest.static class
Get the list of assigned User and Group Services for the specified user.static class
Response to UserAssignedServicesGetListRequest.static class
Clear a user's call logs associated with Basic Call Logs and Enhanced Call Logs features.static class
Request the user level data associated with Call Policies.static class
Response to UserCallPoliciesGetRequest19sp1.static class
Modify the user level data associated with Call Policies.static class
Request the user level data associated with Call Processing Policy.static class
Response to UserCallProcessingGetPolicyRequest22V2.static class
Modify the user level data associated with Call Processing Policy.static class
Add a list of Communication Barring Authorization codes to a user.static class
Delete a list of Communication Barring Authorization codes from a user.static class
Get a list of Communication Barring Authorization Code for a user.static class
Response to UserCommunicationBarringAuthorizationCodeGetListRequest.static class
Gets the Communication Barring settings for a user.static class
Response to UserCommunicationBarringGetRequest.static class
Modify the Communication Barring settings for a user.static class
The response is either SuccessResponse or ErrorResponse.static class
Request to delete a user.static class
Request to modify a user.static class
Request to delete a user.static class
Request the Device Activation policies in effect for the user.static class
Response to UserDeviceActivationPolicyInEffectGetRequest.static class
Request the user level data associated with Device Policy.static class
Response to UserDevicePoliciesGetRequest21. enableDeviceFeatureSynchronization and enableCallDecline are ignored by the application server in Multiple User Shared mode.static class
Modify the user level data associated with Device Policy. enableDeviceFeatureSynchronization and enableCallDecline can be configured by the admin regardless of lineMode, but is ignored by the application server in Multiple User Shared mode. enableCallDecline can be modified by the user when the admin has set the mode to ‘Single User Private and Shared Lines mode’.static class
Request to get a list of DNs associated with a user and their activation state.static class
Response to UserDnGetActivationListRequest.static class
Get an enterprise's common phone list for a user.static class
Response to the UserEnterpriseCommonPhoneListGetPagedSortedListRequest.static class
Get the list of feature access codes for a user.static class
Response to the UserFeatureAccessCodeGetListRequest21.static class
Enable or disable a list of feature access codes for a user.static class
Request the list of users in a group.static class
Response to UserGetListInGroupPagedSortedListRequest.static class
Request the list of users in a group.static class
Response to UserGetListInGroupRequest.static class
Request the list of users in a service provider or enterprise.static class
Response to UserGetListInServiceProviderRequest.static class
Request the list of users in the system.static class
Response to UserGetListInSystemRequest.static class
Request to get a list of registrations for a user.static class
Response to UserGetRegistrationListRequest.static class
Request to get the user information.static class
Response to UserGetRequest22V8.static class
Request the list of Service Instances in a service provider or an enterprise.static class
Response to UserGetServiceInstanceListInServiceProviderRequest.static class
Request the list of Service Instances in the system.static class
Response to UserGetServiceInstanceListInSystemRequest.static class
Get a user's group's common phone list.static class
Response to the UserGroupCommonPhoneListGetPagedSortedListRequest.static class
Gets a Custom Contact Directory in a group.static class
Response to the UserGroupCustomContactDirectoryGetPagedSortedListRequest.static class
Request to get all user's configured line ports.static class
Response to UserLinePortGetListRequest.static class
Move the user from one group to another group within the same enterprise.static class
Response to UserModifyGroupIdRequest. error indicates the failing conditions preventing the user move. impact indicates any change to user and group as the result of a user move.static class
The following data elements are only used in AS data mode: contact[2]-contact[5] The following elements are only used in AS data mode and will fail in XS data mode: trunkAddressing newUserExternalId The following elements are only used in AS data mode and ignored in XS data mode: nameDialingName alternateUserIdList newUserExternalId The following elements are only used in XS data mode and ignored in AS data mode: allowVideo The allowVideo element can only be used by a system administrator.static class
Modify the user id of a real or virtual user.static class
Request the Network-Based Conferencing data for a specified user.static class
Response to UserNetworkConferencingGetRequest.static class
Get the OCI call control application list that can be used by the user.static class
Response to UserOCICallControlApplicationGetListRequest.static class
Modify which OCI Call Control Applications are enabled on a user The response is either SuccessResponse or ErrorResponse.static class
Request the user's Web password information.static class
Response to UserPasswordInfoGetRequest.static class
Request the user level data associated with PBX Integration service.static class
Response to UserPBXIntegrationGetRequest.static class
Modify the user level data associated with PBX Integration service.static class
Add one or more entries to a user's personal phone list.static class
Delete one or more entries from a user's personal phone list.static class
Get a user's personal phone list.static class
Response to the UserPersonalPhoneListGetListRequest.static class
Get a user's personal phone list.static class
Response to the UserPersonalPhoneListGetPagedSortedListRequest.static class
Modify an entry in a user's personal phone list.static class
Request a table containing the phone directory for a user's group.static class
Response to UserPhoneDirectoryGetListRequest.static class
Request a table containing the phone directory for a user.static class
Response to UserPhoneDirectoryGetPagedListRequest.static class
Request a table containing the phone directory for a user.static class
Response to UserPhoneDirectoryGetPagedSortedListRequest.static class
Request a table containing the phone directory for a user.static class
Response to UserPhoneDirectoryGetSearchedListRequest.static class
Request the user's portal passcode information.static class
Response to UserPortalPasscodeGetInfoRequest.static class
Modify the user's Portal passcode The response is either a SuccessResponse or an ErrorResponse.static class
Requests the effective passcode rules setting for a user.static class
Response to UserPortalPasscodeRulesGetRequest.static class
Get the Users Primary Endpoint setting.static class
Response to the UserPrimaryEndpointAdvancedSettingGetRequest.static class
Modify the Users Primary Endpoint line control settings.static class
Get the push notification settings for a user.static class
Response to UserPushNotificationGetRequest.static class
Modify the push notification settings for a user.static class
Request to remove a push notification registration.static class
Request a table containing all of the push notification registrations for a user by either registration id or user id.static class
Response to UserPushNotificationRegistrationGetListRequest.static class
Add an event to user schedule.static class
Add a user schedule.static class
Delete a list of events from a user schedule.static class
Delete a list of user schedule.static class
Request the list of schedules viewable by a User.static class
Response to UserScheduleGetEventRequest.static class
Get the list of events of a user schedule.static class
Response to UserScheduleGetEventListRequest.static class
Get an event from a user schedule.static class
Response to UserScheduleGetEventRequest.static class
Get the list of schedules viewable by a User.static class
Response to UserScheduleGetListRequest17sp1.static class
Modify an event of a user schedule.static class
Modify a user schedule.static class
Request to assign the user services and service packs for a user.static class
Requests the user's service and service pack assignment list with status.static class
Response to UserServiceGetAssignmentListRequest.static class
Request to determine if a UserService or service pack is assigned to the user.static class
Returns true if the UserService or service pack is assigned, otherwise false.static class
Requests to unassign the user services and service packs for a user.static class
Returns the Sh non-transparent data stored against a Public User Identity (a SIP URI or TEL URI).static class
Response to the UserShInterfaceGetPublicIdDataRequest21sp1.static class
Returns the Sh non-transparent data stored against a userId.static class
Response to the UserShInterfaceGetUserIdDataRequest21sp1.static class
Modifies the Sh Interface non-transparent data associated with a Public User Identity.static class
Dispatches a Public Identity refresh task on the local Application Server node for the specified public identity.static class
Request the user level data associated with Terminating Alternate Trunk Identity.static class
Response to UserTerminatingAlternateTrunkIdentityGetRequest.static class
Modify the user level data associated with Terminating Alternate Trunk Identity.static class
Get user Terminating Closed User Group service settings.static class
Response to the UserTerminatingClosedUserGroupGetRequest.static class
Modify user Terminating CUG service settings.static class
Get the user Xsi policy profile.static class
Response to UserXsiPolicyProfileGetRequest.static class
Modifies the default Xsi policy profile for a group. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected StreetAddress
protected String
protected String[]
protected Boolean
protected AlternateUserIdEntry[]
protected String
protected String
protected String
protected String
protected String
protected DepartmentKey
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected NameDialingName
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected TrunkAddressingMultipleContactRead22
protected String
protected String
Fields inherited from class co.ecg.alpaca.toolkit.model.BroadWorksUser
group, groupId, serviceProvider, serviceProviderId, userId
Fields inherited from class co.ecg.alpaca.toolkit.model.BroadWorksObject
broadWorksServer, populated
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
String[]
getAlias()
getImpId()
static User
getPopulatedUser
(BroadWorksServer broadWorksServer, String userId) Retrieves a populated UsergetTitle()
int
hashCode()
populate()
Method to populate the Fields of the Object via the Associated BroadWorks requestpopulate
(User.UserGetResponse resp) Method to populate the Fields of the Object via the Associated BroadWorks requestsetAccessDeviceEndpoint
(AccessDeviceMultipleIdentityAndContactEndpointRead22V2 accessDeviceEndpoint) setAddress
(StreetAddress address) setAddressLocation
(String addressLocation) setAllowVideo
(Boolean allowVideo) setAlternateUserId
(AlternateUserIdEntry... alternateUserId) setCallingLineIdFirstName
(String callingLineIdFirstName) setCallingLineIdLastName
(String callingLineIdLastName) setCallingLineIdPhoneNumber
(String callingLineIdPhoneNumber) setCountryCode
(String countryCode) setDefaultAlias
(String defaultAlias) setDepartment
(DepartmentKey department) setDepartmentFullPath
(String departmentFullPath) setEmailAddress
(String emailAddress) setExtension
(String extension) setFirstName
(String firstName) setGroupExternalId
(String groupExternalId) setHiraganaFirstName
(String hiraganaFirstName) setHiraganaLastName
(String hiraganaLastName) setLanguage
(String language) setLastName
(String lastName) setMobilePhoneNumber
(String mobilePhoneNumber) setNameDialingName
(NameDialingName nameDialingName) setNationalPrefix
(String nationalPrefix) setNetworkClassOfService
(String networkClassOfService) setOfficeZoneName
(String officeZoneName) setPagerPhoneNumber
(String pagerPhoneNumber) setPhoneNumber
(String phoneNumber) setPrimaryZoneName
(String primaryZoneName) setResellerId
(String resellerId) setServiceProviderExternalId
(String serviceProviderExternalId) setTimeZone
(String timeZone) setTimeZoneDisplayName
(String timeZoneDisplayName) setTrunkAddressing
(TrunkAddressingMultipleContactRead22 trunkAddressing) setUserExternalId
(String userExternalId) setYahooId
(String yahooId) toString()
Methods inherited from class co.ecg.alpaca.toolkit.model.BroadWorksUser
getGroup, getGroupId, getServiceProvider, getServiceProviderId, getUserId, getUserId, setGroupId, setServiceProviderId, setUserId
Methods inherited from class co.ecg.alpaca.toolkit.model.BroadWorksObject
getBroadWorksServer, hasPopulated, isPopulated, setBroadWorksServer, setPopulated
-
Field Details
-
lastName
-
firstName
-
callingLineIdLastName
-
callingLineIdFirstName
-
nameDialingName
-
hiraganaLastName
-
hiraganaFirstName
-
phoneNumber
-
extension
-
callingLineIdPhoneNumber
-
department
-
departmentFullPath
-
language
-
timeZone
-
timeZoneDisplayName
-
defaultAlias
-
alias
-
accessDeviceEndpoint
-
trunkAddressing
-
title
-
pagerPhoneNumber
-
mobilePhoneNumber
-
emailAddress
-
yahooId
-
addressLocation
-
address
-
countryCode
-
nationalPrefix
-
networkClassOfService
-
officeZoneName
-
-
impId
-
alternateUserId
-
allowVideo
-
resellerId
-
serviceProviderExternalId
-
groupExternalId
-
userExternalId
-
-
Constructor Details
-
User
public User()Serializable Constructor -
User
- Parameters:
broadWorksServer
-userId
-
-
User
- Parameters:
group
-userId
-
-
-
Method Details
-
getPopulatedUser
public static User getPopulatedUser(BroadWorksServer broadWorksServer, String userId) throws BroadWorksObjectException Retrieves a populated User- Parameters:
broadWorksServer
-userId
-- Throws:
BroadWorksObjectException
-
getClassName
-
setLastName
-
getLastName
-
setFirstName
-
getFirstName
-
setCallingLineIdLastName
-
getCallingLineIdLastName
-
setCallingLineIdFirstName
-
getCallingLineIdFirstName
-
setNameDialingName
-
getNameDialingName
-
setHiraganaLastName
-
getHiraganaLastName
-
setHiraganaFirstName
-
getHiraganaFirstName
-
setPhoneNumber
-
getPhoneNumber
-
setExtension
-
getExtension
-
setCallingLineIdPhoneNumber
-
getCallingLineIdPhoneNumber
-
setDepartment
-
getDepartment
-
setDepartmentFullPath
-
getDepartmentFullPath
-
setLanguage
-
getLanguage
-
setTimeZone
-
getTimeZone
-
setTimeZoneDisplayName
-
getTimeZoneDisplayName
-
setDefaultAlias
-
getDefaultAlias
-
setAlias
-
getAlias
-
setAccessDeviceEndpoint
public User setAccessDeviceEndpoint(AccessDeviceMultipleIdentityAndContactEndpointRead22V2 accessDeviceEndpoint) -
getAccessDeviceEndpoint
-
setTrunkAddressing
-
getTrunkAddressing
-
setTitle
-
getTitle
-
setPagerPhoneNumber
-
getPagerPhoneNumber
-
setMobilePhoneNumber
-
getMobilePhoneNumber
-
setEmailAddress
-
getEmailAddress
-
setYahooId
-
getYahooId
-
setAddressLocation
-
getAddressLocation
-
setAddress
-
getAddress
-
setCountryCode
-
getCountryCode
-
setNationalPrefix
-
getNationalPrefix
-
setNetworkClassOfService
-
getNetworkClassOfService
-
setOfficeZoneName
-
getOfficeZoneName
-
setPrimaryZoneName
-
getPrimaryZoneName
-
setImpId
-
getImpId
-
setAlternateUserId
-
getAlternateUserId
-
setAllowVideo
-
getAllowVideo
-
setResellerId
-
getResellerId
-
setServiceProviderExternalId
-
getServiceProviderExternalId
-
setGroupExternalId
-
getGroupExternalId
-
setUserExternalId
-
getUserExternalId
-
populate
Method to populate the Fields of the Object via the Associated BroadWorks request- Specified by:
populate
in classBroadWorksObject
-
populate
Method to populate the Fields of the Object via the Associated BroadWorks request- Parameters:
resp
- The response object to perform population
-
equals
- Overrides:
equals
in classBroadWorksUser
-
hashCode
public int hashCode()- Overrides:
hashCode
in classBroadWorksUser
-
toString
-