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 classRequest 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 classRequests the list of access devices associated to a user and their device activation information.static classResponse to UserAccessDeviceDeviceActivationGetListRequest.static classRequest to get the list of Device Management user modifiable files.static classResponse to UserAccessDeviceFileGetListRequest.static classRequest to get a user modifiable file.static classResponse to UserAccessDeviceFileGetRequest.static classRequest to modify a user modifiable access device file.static classReset a specific user SIP device that supports the reset operation.static classRequest to get all the device tag names and values for a specific device.static classResponse to UserAccessDeviceTagsGetRequest.static classRequest to add a user.static classRequest to add an alternate user Id to an user.static classRequest to delete an alternate user id of a user.static classRequest to get the user id and the list of alternate user ids of an user.static classResponse to UserAlternateUserIdGetListRequest.static classRequest to modify an alternate user id of a user.static classAdd 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 classDelete 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 classGet 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 classResponse to UserAnnouncementFileGetAvailableListRequest.static classGet 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 classResponse to UserAnnouncementFileGetListRequest.static classGet the list of announcement files for a user.static classResponse to UserAnnouncementFileGetPagedSortedListRequest.static classRequest to get the announcement repository file information.static classResponse to UserAnnouncementFileGetRequest22.static classThis 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 classReturn the disk space being used.static classResponse to UserAnnouncementRepositoryGetSettingsRequest.static classGet the list of assigned User and Group Services for the specified user.static classResponse to UserAssignedServicesGetListRequest.static classClear a user's call logs associated with Basic Call Logs and Enhanced Call Logs features.static classRequest the user level data associated with Call Policies.static classResponse to UserCallPoliciesGetRequest19sp1.static classModify the user level data associated with Call Policies.static classRequest the user level data associated with Call Processing Policy.static classResponse to UserCallProcessingGetPolicyRequest22V2.static classModify the user level data associated with Call Processing Policy.static classAdd a list of Communication Barring Authorization codes to a user.static classDelete a list of Communication Barring Authorization codes from a user.static classGet a list of Communication Barring Authorization Code for a user.static classResponse to UserCommunicationBarringAuthorizationCodeGetListRequest.static classGets the Communication Barring settings for a user.static classResponse to UserCommunicationBarringGetRequest.static classModify the Communication Barring settings for a user.static classThe response is either SuccessResponse or ErrorResponse.static classRequest to delete a user.static classRequest to modify a user.static classRequest to delete a user.static classRequest the Device Activation policies in effect for the user.static classResponse to UserDeviceActivationPolicyInEffectGetRequest.static classRequest the user level data associated with Device Policy.static classResponse to UserDevicePoliciesGetRequest21. enableDeviceFeatureSynchronization and enableCallDecline are ignored by the application server in Multiple User Shared mode.static classModify 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 classRequest to get a list of DNs associated with a user and their activation state.static classResponse to UserDnGetActivationListRequest.static classGet an enterprise's common phone list for a user.static classResponse to the UserEnterpriseCommonPhoneListGetPagedSortedListRequest.static classGet the list of feature access codes for a user.static classResponse to the UserFeatureAccessCodeGetListRequest21.static classEnable or disable a list of feature access codes for a user.static classRequest the list of users in a group.static classResponse to UserGetListInGroupPagedSortedListRequest.static classRequest the list of users in a group.static classResponse to UserGetListInGroupRequest.static classRequest the list of users in a service provider or enterprise.static classResponse to UserGetListInServiceProviderRequest.static classRequest the list of users in the system.static classResponse to UserGetListInSystemRequest.static classRequest to get a list of registrations for a user.static classResponse to UserGetRegistrationListRequest.static classRequest to get the user information.static classResponse to UserGetRequest22V8.static classRequest the list of Service Instances in a service provider or an enterprise.static classResponse to UserGetServiceInstanceListInServiceProviderRequest.static classRequest the list of Service Instances in the system.static classResponse to UserGetServiceInstanceListInSystemRequest.static classGet a user's group's common phone list.static classResponse to the UserGroupCommonPhoneListGetPagedSortedListRequest.static classGets a Custom Contact Directory in a group.static classResponse to the UserGroupCustomContactDirectoryGetPagedSortedListRequest.static classRequest to get all user's configured line ports.static classResponse to UserLinePortGetListRequest.static classMove the user from one group to another group within the same enterprise.static classResponse 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 classThe 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 classModify the user id of a real or virtual user.static classRequest the Network-Based Conferencing data for a specified user.static classResponse to UserNetworkConferencingGetRequest.static classGet the OCI call control application list that can be used by the user.static classResponse to UserOCICallControlApplicationGetListRequest.static classModify which OCI Call Control Applications are enabled on a user The response is either SuccessResponse or ErrorResponse.static classRequest the user's Web password information.static classResponse to UserPasswordInfoGetRequest.static classRequest the user level data associated with PBX Integration service.static classResponse to UserPBXIntegrationGetRequest.static classModify the user level data associated with PBX Integration service.static classAdd one or more entries to a user's personal phone list.static classDelete one or more entries from a user's personal phone list.static classGet a user's personal phone list.static classResponse to the UserPersonalPhoneListGetListRequest.static classGet a user's personal phone list.static classResponse to the UserPersonalPhoneListGetPagedSortedListRequest.static classModify an entry in a user's personal phone list.static classRequest a table containing the phone directory for a user's group.static classResponse to UserPhoneDirectoryGetListRequest.static classRequest a table containing the phone directory for a user.static classResponse to UserPhoneDirectoryGetPagedListRequest.static classRequest a table containing the phone directory for a user.static classResponse to UserPhoneDirectoryGetPagedSortedListRequest.static classRequest a table containing the phone directory for a user.static classResponse to UserPhoneDirectoryGetSearchedListRequest.static classRequest the user's portal passcode information.static classResponse to UserPortalPasscodeGetInfoRequest.static classModify the user's Portal passcode The response is either a SuccessResponse or an ErrorResponse.static classRequests the effective passcode rules setting for a user.static classResponse to UserPortalPasscodeRulesGetRequest.static classGet the Users Primary Endpoint setting.static classResponse to the UserPrimaryEndpointAdvancedSettingGetRequest.static classModify the Users Primary Endpoint line control settings.static classGet the push notification settings for a user.static classResponse to UserPushNotificationGetRequest24.static classModify the push notification settings for a user.static classRequest to remove a push notification registration.static classRequest a list of all of the push notification registrations for a user by either registration id or user id.static classResponse to UserPushNotificationRegistrationGetListRequest21sp1.static classAdd an event to user schedule.static classAdd a user schedule.static classDelete a list of events from a user schedule.static classDelete a list of user schedule.static classRequest the list of schedules viewable by a User.static classResponse to UserScheduleGetEventRequest.static classGet the list of events of a user schedule.static classResponse to UserScheduleGetEventListRequest.static classGet an event from a user schedule.static classResponse to UserScheduleGetEventRequest.static classGet the list of schedules viewable by a User.static classResponse to UserScheduleGetListRequest17sp1.static classGet the list of schedules viewable by a User.static classResponse to UserScheduleGetPagedSortedListRequest.static classModify an event of a user schedule.static classModify a user schedule.static classRequest to assign the user services and service packs for a user.static classRequests the user's service and service pack assignment list with status.static classResponse to UserServiceGetAssignmentListRequest.static classRequest to determine if a UserService or service pack is assigned to the user.static classReturns true if the UserService or service pack is assigned, otherwise false.static classRequests to unassign the user services and service packs for a user.static classReturns the Sh non-transparent data stored against a Public User Identity (a SIP URI or TEL URI).static classResponse to the UserShInterfaceGetPublicIdDataRequest21sp1.static classReturns the Sh non-transparent data stored against a userId.static classResponse to the UserShInterfaceGetUserIdDataRequest21sp1.static classModifies the Sh Interface non-transparent data associated with a Public User Identity.static classDispatches a Public Identity refresh task on the local Application Server node for the specified public identity.static classRequest the user level data associated with Terminating Alternate Trunk Identity.static classResponse to UserTerminatingAlternateTrunkIdentityGetRequest.static classModify the user level data associated with Terminating Alternate Trunk Identity.static classGet user Terminating CUG service settings.static classResponse to the UserTerminatingClosedUserGroupGetRequest.static classModify user Terminating CUG service settings.static classGet the user Xsi policy profile.static classResponse to UserXsiPolicyProfileGetRequest.static classModifies the default Xsi policy profile for a group. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected StreetAddressprotected Stringprotected String[]protected Booleanprotected AlternateUserIdEntry[]protected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected DepartmentKeyprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected NameDialingNameprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected TrunkAddressingMultipleContactRead22protected Stringprotected StringFields inherited from class co.ecg.alpaca.toolkit.model.BroadWorksUser
group, groupId, serviceProvider, serviceProviderId, userIdFields inherited from class co.ecg.alpaca.toolkit.model.BroadWorksObject
broadWorksServer, populated -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanString[]getAlias()getImpId()static UsergetPopulatedUser(BroadWorksServer broadWorksServer, String userId) Retrieves a populated UsergetTitle()inthashCode()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, setUserIdMethods 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:
populatein 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:
equalsin classBroadWorksUser
-
hashCode
public int hashCode()- Overrides:
hashCodein classBroadWorksUser
-
toString
-