public interface UserData
In all the getter methods which take enterpriseId as the input parameter, enterpriseId could be the principal name attribute in Active Directory if there is an Active Directory integration with SMGR else it will mostly be the login name of the user.
Enterprise ID refers to user's login name or principal name attribute in Active Directory.
User's data and configuration is associated with a communication profile. A communication profile is used to represent a users subscription to a product specific communication subsystem and contains its specific configuration needs for the user. Communication profile is also used to associate policies and behaviors with exposed handles. A user can have multiple communication profile sets represent different policies.
EmailType, MobileType, AddressType
Modifier and Type | Method and Description |
---|---|
Map |
getAllCommunicationAddresses(String enterpriseId)
Returns an immutable map with 'name of communication profile' as a key and a map of all types of communication addresses as value
configured in SMGR for a given enterprise ID.
|
Map |
getEmails(String enterpriseId)
Returns an immutable map with 'name of communication profile' as a key and a map of email addresses as
value for a given enterprise ID.
|
String |
getLoginNameByParticipant(String participantHandle,
String participantDomain)
Returns user's login name for a given participant.
|
String |
getLoginNameByPhoneNumber(String phoneNumber)
Returns user's login name (enterprise ID) for a given phone number.
|
Map |
getMobileNumbers(String enterpriseId)
Returns a map of mobile numbers for a given enterprise ID.
|
Map |
getPhoneNumbers(String enterpriseId)
Returns an immutable map with 'name of communication profile' as a key and a list of associated
phone numbers as value for a given enterprise ID.
|
String |
getTenantID(String enterpriseId)
Returns tenant ID for a given enterprise ID.
|
Map getPhoneNumbers(String enterpriseId)
enterpriseId
- User's login name or principal name attribute in Active
Directory.IllegalArgumentException
- If enterprise ID is null or empty.Map getEmails(String enterpriseId)
enterpriseId
- User's login name or principal name attribute in Active
Directory.IllegalArgumentException
- If enterprise ID is null or empty.Map getMobileNumbers(String enterpriseId)
Map includes mobile number configured in SMGR User Management -> Identity tab ->Address -> Phone Details - Mobile Number and EC500 configured Mobile Number from the Off-PBX-Station Mapping entries in the Communication Manager.
MobileType could be either EC500 or MOBILE.
enterpriseId
- User's login name or principal name attribute in Active
Directory.IllegalArgumentException
- If enterprise ID is null or empty.String getTenantID(String enterpriseId)
A tenant identifies a business unit and allows for multiple business units to share an implementation but still have data segmented within that implementation.
enterpriseId
- User's login name or principal name attribute in Active
Directory.IllegalArgumentException
- If enterprise ID is null or empty.String getLoginNameByPhoneNumber(String phoneNumber) throws Exception
Phone number could be one of 'Avaya SIP', 'Avaya E164' and 'Other SIP' numbers. If the given phone number is of form handle@domain.com, a single login name will be returned. Otherwise, if a single match is found then matched login name will be returned else an exception will be thrown in case of multiple matches.
phoneNumber
- user's one of 'Avaya SIP', 'Avaya E164' and 'Other SIP'
numbers.Exception
- if multiple login names are found.String getLoginNameByParticipant(String participantHandle, String participantDomain)
participantHandle
- handle part of ParticipantparticipantDomain
- domain part of ParticipantMap getAllCommunicationAddresses(String enterpriseId)
enterpriseId
- User's login name or principal name attribute in Active
Directory.IllegalArgumentException
- If enterprise ID is null or empty.Copyright © 2014 Avaya. All Rights Reserved.