Users (Component)

The Users object lets you manage your sites users. In addition to adding and deleting users, methods let you set a user's preference including preferences for how an image gallery is displayed and identifying who a user's administrator is. Other methods return information on a user, a user's preferences, group membership, as well as other kinds of information.

Methods marked below with [L] may be logged at the customer level (if transaction logging is licensed and enabled by the administrator)

Customization is not supported for this component.

Methods:

addAdministrators [L]	Adds users and groups as administrators for a user.
changePassword [L]	Changes the password for the specified user.
createProfile [L]	Creates a new user profile.
delete [L]	Deletes a user. If the deleted user owns content, a different contributor must be specified to inherit ownership.
deleteAdministrator [L]	Deletes a user or group from being a user's administrator.
deleteAdministrators [L]	Deletes one or more of users or groups from being an administrator for a user.
deleteContactType [L]	Deletes a contact type record.
deleteMultiple	Deletes one or more users, optionally replacing these users with another user.
getAdministrators	Returns zero or more structures, each containing information about a user's administrators.
getContactTypes	Returns zero or more structures, each containing information about a user's contact type categories.
getContributeUIPrefs	Returns a structure containing information about a user's contribute UI preferences.
getContributionData	Returns zero or more structures, each containing information about a user's content changes, assignments, ownerships, and other similar information for a site.
getContributorTypes	Returns a structure containing information on available contributor types and other information for a user.
getCounts	Returns a structure containing information on various user counts such as expired, deleted, number of active, and total number of users.
getDeleteStatus	Returns a structure containing information indicating if a user can be deleted and if reassignments must occur if this user is deleted.
getGroupMembershipDifferences	Returns the differences in group memberships between two users, the differences can be for additional groups and/or missing groups.
getGroupMemberships	Returns zero or more structures, each containing information about the groups for which the specified user is a member.
getImageGalleryPrefs	Returns a structure containing image gallery preferences for the current or default user.
getList	Returns zero or more structures, each containing information about users who meet the criteria passed in this method's arguments.
getMultimediaGalleryPrefs	Returns a structure containing multimedia gallery preferences for the current or default user.
getNamesGivenIDs	Returns zero or more structures, each containing user name information; for example, the user's first name, full name, as well as the user ID.
getProfile	Returns a structure containing information about a user's profile. The Users.getUserInfo() method returns additional information.
getStdPropertiesSEOPanelPrefs	Returns a structure containing user's preferences for standard properties dialog SEO panel for current or default user.
getTemplateGalleryPrefs	Returns a structure containing template gallery preferences for the current or default user.
getTotalCount	Returns a structure containing the number of active and inactive users as well as the total number of users.
getUndeleteInfo	Returns a structure containing information about a user marked as deleted.
getUserAndGroupsList	Returns User and his/her groups.
getUserInfo	Returns a structure containing information about the current user. Most of this information is CommonSpot-related. The Users.getProfile() method returns additional information.
isGroupAdmin	Returns a boolean flag which if true indicates whether the current user is an administrator for the specified group. If GroupID is -1, true is returned if the current user is an administrator for any group.
isUserAdmin	Returns a boolean flag which if true indicates whether the current user is an administrator for the specified user. If UserID is -1, true is returned if the current user is an administrator for any user.
removeAsContributor [L]	Removes the specified user as being a contributor. Returns a pipe '|' delimited list of reasons why a user cannot be removed as a contributor or an empty string indicating that the user is no longer a contributor.
saveContactType [L]	Saves or creates user contact type information.
saveContactTypeState [L]	Sets the 'IsActive' and 'IsDefault' states for a contact type.
saveContributeUIPrefs [L]	Saves a user's contribute UI preferences. These preferences define how icons are displayed on a page.
saveImageGalleryPrefs [L]	Sets image gallery preferences for the current user or sets the defaults if no preferences are set.
saveMultimediaGalleryPrefs [L]	Sets multimedia gallery preferences for the current user or sets the defaults if no preferences are set.
saveProfile [L]	Updates an existing user profile.
saveStdPropertiesSEOPanelPrefs [L]	Sets the standard properties SEO panel preferences for the current user or sets the defaults if no preferences are set.
saveTemplateGalleryPrefs [L]	Sets the template gallery preferences for the current user or sets the default preferences.
setAccountExpiration [L]	Sets or removes the account expiration for a user.
setIPAddressAccess [L]	Sets or removes the IP address restriction for a user.
setPasswordRules [L]	Sets certain password rules for the specified user.
undelete [L]	Removes a user from being a 'deleted' user and optionally updates the user's login name.
updateProfile [L]	Updates the user profile for the current user.