User Class

public class User : Ektron.Cms.API.Common;

Visual Basic

Public Class User
Inherits Ektron.Cms.API.Common

File

User.vb

Description

This is class Ektron.Cms.API.User.User.

Group

Classes

Topics

Name	Description
User Methods	The methods of the User class are listed here.
User Properties	The properties of the User class are listed here.

User Methods

	Name	Description
	ActivateUserAccount	This is the overview for the ActivateUserAccount method overload.
	AddMembershipUser	Adds a new membership user to CMS.
	AddNewUser	This method is obsolete. Please use the AddMembershipUser method. Adds a new membership user to CMS.
	AddRolePermission	Adds permission for the given role.
	AddUser	This is the overview for the AddUser method overload.
	AddUserGroup	Creates new user group.
	AddUserToGroup	Adds an existing user to an existing group.
	AutoLogInUser	Login the given user credentials.
	CreateBlankUserObject	This is the overview for the CreateBlankUserObject method overload.
	DeleteUserByID	Removes the user from the system. This will not purge the data, but it disables the user from further accessing the system.
	DeleteUserByIds	Removes the user from the system. This will not purge the data, but it disables the user from further accessing the system.
	DeleteUserFromGroup	Removes a user from the designated group.
	DeleteUserGroup	Removes the group from the system permanently.
	EditUserCustomProperties	This method creates the editable fields(UI) for user's custom properties.
	GetActiveUser	Returns all of the user properties with or without preference.
	GetADMapping	Loads the CMS and Active Directory name.
	GetAllCmsUsers	Loads all the CMS users.
	GetAllCustomProperties	Returns array of all the custom properties defined in the system.
	GetAllUserByCustomProperty	Returns all the users based on the given properties.
	GetAllUserGroups	This is the overview for the GetAllUserGroups method overload.
	GetAllUsers	This is the overview for the GetAllUsers method overload.
	GetGroupsUserIsIn	Loads all the groups by user.
	GetMembershipUser	Returns user data based on the user's login name (username).
	GetNonVerifyUser	This is the overview for the GetNonVerifyUser method overload.
	GetUser	Loads the user details for the given user.
	GetUserByUsername	Loads the user details for the given user.
	GetUserCustomProperties	Returns an array of custom properties for a given user's ID.
	GetUserEmailInfo	Returns user data for a given user's ID.
	GetUserForFolderAdmin
	GetUserGroup	Loads a given group's details.
	GetUserGroupByName	Loads a given group's details.
	GetUserGroupForFolderAdmin	Returns all the group's data for the administrator.
	GetUserPermissions	Loads the user permissions as a array of UserPermissionData.
	GetUserPreference	Loads the preferences for the given user.
	GetUsers	This is the overview for the GetUsers method overload.
	GetUsersForTask	Loads the users that have permissions to the given content.
	GetUsersNotInGroup	Loads all the users that are not in the given group.
	IsAdmin	Determines the if the current user is an Administrator.
	IsAGroupMember	For a given userId, returns whether that user is a member of the group.
	IsARoleMember	This is the overview for the IsARoleMember method overload.
	IsARoleMemberForContent	Determines whether a Role Member is allowed to work with a given piece of content as an administrator or not. Administrations privileges are for the given piece of content only. Roles provide the ability to offload/delegate some of the administrator's tasks onto other users, without giving full administration privileges to a user.
	IsARoleMemberForContent_FolderUserAdmin	Determines whether a Role Member is allowed to work with a given conatent as an administrator or not. Roles provide the ability to offload/delegate some of the administrator's tasks onto other users, without giving full administration privileges to a user.
	IsARoleMemberForFolder	Determines whether a Role Member is allowed to work with a given folder as an administrator or not. Administrations privileges are for the given folder only. Roles provide the ability to offload/delegate some of the administrator's tasks onto other users, without giving full administration privileges to a user.
	IsARoleMemberForFolder_FolderUserAdmin	Determines whether a Role Member is allowed to work with a given folder as an administrator or not. Administrations privileges are for the given folder only. Roles provide the ability to offload/delegate some of the administrator's tasks onto other users, without giving full administration privileges to a user.
	IsARoleMemberForFolder_MetadataAdmin	Determines whether a Role Member is allowed to work with a given folder as an meta data administrator or not.
	LockUserAccount	This function locks a user account.
	LogInUser	This is the overview for the LogInUser method overload.
	ReadCustomProperties	Returns the custom properties as a Visual Basic collection. Importing the Microsoft.VisualBasic name space might be required.
	ResetMembershipUserPassword	This is the overview for the ResetMembershipUserPassword method overload.
	SetAuthenticationCookie	This method sets the authentication cookie.
	UnsubscribeUser	Unsubscribes a user from the system.
	UpdateCustomPropertiesItemOrder	Updates the order of available custom properties.
	UpdateUser	This is the overview for the UpdateUser method overload.
	UpDateUserGroup	This is the overview for the UpDateUserGroup method overload.
	UpdateUserPreferences	Updates the given user’s preference data.
	UserObject	This is the overview for the UserObject method overload.

User Properties

	Name	Description
	UserIdAuthenticated	Returns the id of the currently logged in user.

Links

User Methods, User Properties, Classes, Legend, Members, Topics, User Methods, User Properties

Created with a commercial version of

Doc-O-Matic. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at

[email protected].

Contents | Index | Home

What do you think about this topic? Send feedback!