@ProviderType
public interface CommunityMemberUserProfileOperations
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
OPT_PROP_USER_ADDRESS
The opt prop user streetAddress.
|
static java.lang.String |
OPT_PROP_USER_BIO
The opt prop user aboutMe.
|
static java.lang.String |
OPT_PROP_USER_CITY
The opt prop user city.
|
static java.lang.String |
OPT_PROP_USER_GENDER
The opt prop user gender.
|
static java.lang.String |
OPT_PROP_USER_GROUP_ID
The opt prop user groups.
|
static java.lang.String |
OPT_PROP_USER_LANGUAGE
The opt prop user language.
|
static java.lang.String |
OPT_PROP_USER_OCCUPATION
The opt prop user jobTitle.
|
static java.lang.String |
OPT_PROP_USER_PHONE_NUMBER
The opt prop user phoneNumber.
|
static java.lang.String |
OPT_PROP_USER_SITE_ID
The opt prop user groups.
|
static java.lang.String |
OPT_PROP_USER_STATE
The opt prop user region.
|
static java.lang.String |
OPT_PROP_USER_URL
The opt prop user url.
|
static java.lang.String |
PERMS_PATH
The path for the tunnel to use when verifying permission
|
static java.lang.String |
REQ_PROP_CONFIRM_PASSWORD
The req prop confirm password.
|
static java.lang.String |
REQ_PROP_EMAIL
The req prop email.
|
static java.lang.String |
REQ_PROP_PASSWORD
The req prop password.
|
static java.lang.String |
REQ_PROP_USER_DISPLAY_NAME
The req prop user displayName.
|
static java.lang.String |
REQ_PROP_USER_FIRST_NAME
The req prop user first name.
|
static java.lang.String |
REQ_PROP_USER_ID
The req prop user id.
|
static java.lang.String |
REQ_PROP_USER_LAST_NAME
The req prop user last name.
|
static java.lang.String |
USER_ADMIN_SERVICE_ID
The reference id for the user admin service user
|
Modifier and Type | Method and Description |
---|---|
Resource |
addUserToGroups(Resource profileResource,
java.util.Map<java.lang.String,java.lang.Object> props,
Session session)
Add user to Groups with the specified
Map of properties. |
Resource |
addUserToGroups(SlingHttpServletRequest request)
Add user to Groups based on the specified
SlingHttpServletRequest . |
Resource |
addUserToSites(SlingHttpServletRequest request)
Add user to sites, based on the specified
SlingHttpServletRequest . |
Resource |
changeAvatar(Resource profileResource,
java.util.Map<java.lang.String,java.lang.Object> props,
Session session)
Update the specified user profile with the specified
Map of properties. |
Resource |
changeAvatar(SlingHttpServletRequest request)
Update a user profile on the specified
SlingHttpServletRequest . |
Resource |
changePassword(Resource profileResource,
java.util.Map<java.lang.String,java.lang.Object> props,
Session session)
Update the user password with the specified
Map . |
Resource |
changePassword(SlingHttpServletRequest request)
Update the user password with the specified
SlingHttpServletRequest . |
Resource |
create(SlingHttpServletRequest request)
Create a new
CommunityMemberUser base on the specified SlingHttpServletRequest . |
Resource |
createUser(Resource resource,
java.util.Map<java.lang.String,java.lang.Object> requestParams,
ClientUtilities clientUtils)
Add user for a tenant representing by the specified resource.
|
Resource |
disable(Resource profileResource,
java.util.Map<java.lang.String,java.lang.Object> props,
Session session)
Disable a user with the specified
Map of properties. |
Resource |
disable(SlingHttpServletRequest request)
Disable a user based on the specified
SlingHttpServletRequest . |
Resource |
enable(Resource profileResource,
java.util.Map<java.lang.String,java.lang.Object> props,
Session session)
Re-enable a disabled user with the specified
Map of properties. |
Resource |
enable(SlingHttpServletRequest request)
Enable a user based on the specified
SlingHttpServletRequest . |
SocialComponent |
getSocialComponentForUserProfile(Resource userProfile,
SlingHttpServletRequest request)
|
SocialComponent |
getSocialComponentForUserProfile(Resource userProfile,
SlingHttpServletRequest request,
java.lang.String resourceType)
Get the
SocialComponent for the specified Resource and SlingHttpServletRequest and
for the specified resourceType. |
Resource |
limitUserUGC(SlingHttpServletRequest request)
Limit UGC contributions of the user and subject him to UGC Contribution Limit rules if the feature is enabled
|
Resource |
removeUserFromGroups(Resource profileResource,
java.util.Map<java.lang.String,java.lang.Object> props,
Session session)
Remove user from Groups with the specified
Map of properties. |
Resource |
removeUserFromGroups(SlingHttpServletRequest request)
Remove user from Groups based on the specified
SlingHttpServletRequest . |
Resource |
removeUserFromSites(SlingHttpServletRequest request)
Remove user from sites, based on the specified
SlingHttpServletRequest . |
Resource |
update(Resource profileResource,
java.util.Map<java.lang.String,java.lang.Object> props,
Session session)
Update the specified user profile with the specified
Map of properties. |
Resource |
update(SlingHttpServletRequest request)
Update a user profile on the specified
SlingHttpServletRequest . |
static final java.lang.String REQ_PROP_EMAIL
static final java.lang.String REQ_PROP_PASSWORD
static final java.lang.String REQ_PROP_CONFIRM_PASSWORD
static final java.lang.String REQ_PROP_USER_ID
static final java.lang.String REQ_PROP_USER_FIRST_NAME
static final java.lang.String REQ_PROP_USER_LAST_NAME
static final java.lang.String REQ_PROP_USER_DISPLAY_NAME
static final java.lang.String OPT_PROP_USER_GENDER
static final java.lang.String OPT_PROP_USER_ADDRESS
static final java.lang.String OPT_PROP_USER_CITY
static final java.lang.String OPT_PROP_USER_STATE
static final java.lang.String OPT_PROP_USER_BIO
static final java.lang.String OPT_PROP_USER_LANGUAGE
static final java.lang.String OPT_PROP_USER_OCCUPATION
static final java.lang.String OPT_PROP_USER_PHONE_NUMBER
static final java.lang.String OPT_PROP_USER_URL
static final java.lang.String OPT_PROP_USER_GROUP_ID
static final java.lang.String OPT_PROP_USER_SITE_ID
static final java.lang.String PERMS_PATH
static final java.lang.String USER_ADMIN_SERVICE_ID
SocialComponent getSocialComponentForUserProfile(Resource userProfile, SlingHttpServletRequest request)
userProfile
- the target user profilerequest
- the client requestSocialComponent
SocialComponent getSocialComponentForUserProfile(Resource userProfile, SlingHttpServletRequest request, java.lang.String resourceType)
SocialComponent
for the specified Resource
and SlingHttpServletRequest
and
for the specified resourceType.userProfile
- the target user profilerequest
- the client requestresourceType
- resourceTypeSocialComponent
Resource update(SlingHttpServletRequest request) throws OperationException
SlingHttpServletRequest
.request
- the client requestCommunityMemberUserProfile
resourceOperationException
- if there is an error occursResource update(Resource profileResource, java.util.Map<java.lang.String,java.lang.Object> props, Session session) throws OperationException
Map
of properties.profileResource
- the target user profileprops
- a map of the properties to be updatedsession
- the user session to be used to perform the operationCommunityMemberUserProfile
resourceOperationException
- if there is an error occursResource changeAvatar(SlingHttpServletRequest request) throws OperationException
SlingHttpServletRequest
.request
- the client requestCommunityMemberUserProfile
resourceOperationException
- if there is an error occursResource changeAvatar(Resource profileResource, java.util.Map<java.lang.String,java.lang.Object> props, Session session) throws OperationException
Map
of properties.profileResource
- the target user profileprops
- a map of the data source for avatarsession
- the user session to be used to perform the operationCommunityMemberUserProfile
resourceOperationException
- if there is an error occursResource changePassword(SlingHttpServletRequest request) throws OperationException
SlingHttpServletRequest
.request
- the client requestCommunityMemberUserProfile
resourceOperationException
- the operation exceptionResource changePassword(Resource profileResource, java.util.Map<java.lang.String,java.lang.Object> props, Session session) throws OperationException
Map
.profileResource
- the target user profileprops
- the map, that contains new passwordsession
- the user sessionCommunityMemberUserProfile
resourceOperationException
- the operation exceptionResource disable(SlingHttpServletRequest request) throws OperationException
SlingHttpServletRequest
.request
- the client requestCommunityMemberUserProfile
resourceOperationException
- if there is an error occursResource enable(SlingHttpServletRequest request) throws OperationException
SlingHttpServletRequest
.request
- the client requestCommunityMemberUserProfile
resourceOperationException
- if there is an error occursResource disable(Resource profileResource, java.util.Map<java.lang.String,java.lang.Object> props, Session session) throws OperationException
Map
of properties.profileResource
- the target user's profileprops
- a map of data with the disable reasonsession
- the user session to be used to perform the operationCommunityMemberUserProfile
resourceOperationException
- if there is an error occursResource enable(Resource profileResource, java.util.Map<java.lang.String,java.lang.Object> props, Session session) throws OperationException
Map
of properties.profileResource
- the target user's profileprops
- a map that should probably be emptysession
- the user session to be used to perform the operationCommunityMemberUserProfile
resourceOperationException
- if there is an error occursResource removeUserFromGroups(SlingHttpServletRequest request) throws OperationException
SlingHttpServletRequest
.request
- the client requestCommunityMemberUserProfile
resourceOperationException
- if there is an error occursResource removeUserFromGroups(Resource profileResource, java.util.Map<java.lang.String,java.lang.Object> props, Session session) throws OperationException
Map
of properties.profileResource
- the target user's profileprops
- a map that should contains array of groupIdsession
- the user session to be used to perform the operationCommunityMemberUserProfile
resourceOperationException
- if there is an error occursResource addUserToGroups(SlingHttpServletRequest request) throws OperationException
SlingHttpServletRequest
.request
- the client requestCommunityMemberUserProfile
resourceOperationException
- if there is an error occursResource addUserToGroups(Resource profileResource, java.util.Map<java.lang.String,java.lang.Object> props, Session session) throws OperationException
Map
of properties.profileResource
- the target user's profileprops
- a map that should contains array of groupIdsession
- the user session to be used to perform the operationCommunityMemberUserProfile
resourceOperationException
- if there is an error occursResource addUserToSites(SlingHttpServletRequest request) throws OperationException
SlingHttpServletRequest
.request
- the client requestCommunityMemberUserProfile
resourceOperationException
- if there is an error occursResource removeUserFromSites(SlingHttpServletRequest request) throws OperationException
SlingHttpServletRequest
.request
- the client requestCommunityMemberUserProfile
resourceOperationException
- if there is an error occursResource create(SlingHttpServletRequest request) throws OperationException
CommunityMemberUser
base on the specified SlingHttpServletRequest
.request
- the client requestCommunityMemberUser
OperationException
- if there is an error occursResource createUser(Resource resource, java.util.Map<java.lang.String,java.lang.Object> requestParams, ClientUtilities clientUtils) throws OperationException
resource
- the resource belonging to a tenant.requestParams
- a map that contains the user id and user password.clientUtils
- clientUtilsCommunityMemberUser
OperationException
- if there is an error occursResource limitUserUGC(SlingHttpServletRequest request) throws OperationException
request
- requestOperationException
- the operation exceptionCopyright © 2010 - 2020 Adobe. All Rights Reserved