Ektron.Cms.Framework.User.UserManager
Framework API class for managing Users withing the CMS.
Properties
| UserService |
returns an instance of the business objects user service.
|
| Method |
Description |
| UserManager |
constructor
|
| UserManager(ApiAccessMode) |
constructor
|
| Add(UserData) |
Adds a new user, with details from the supplied UserData object.
|
| Update(UserData) |
Updates a user, with details from the supplied UserData object.
|
| Delete(Int64) |
Deletes an existing user.
|
| AssignTaxonomy(Int64,Int64) |
Assign User Taxonomy to a Category
|
| RemoveTaxonomy(Int64,Int64) |
Remove User Taxonomy to a Category
|
| GetItem(Int64) |
Returns details of a user.
|
| GetItem(Int64,Boolean) |
Returns details of a user.
|
| GetItem(Int64,String) |
Returns details of a user based upon an authentication type and authentication user id. Authentication Types represent third party integrations for authenticating users.
For example, Authentication Type Id = 1 is Facebook integration and the authenticationUserId in this case would be the users facebook ID.
so GetItem(1, '1111111111') would return the cms user who logs in Via facebook and has the facebook ID '1111111111'.
|
| GetList(UserCriteria) |
Returns a list of users that fit the supplied criteria.
|
| GetList(UserCustomPropertyCriteria) |
Returns a list of users that fit the supplied criteria.
|
| CanViewUsersProfile(Int64,Int64) |
Returns true if the viewer (viewerId) can view the other users profile (userid).
|
| GetCustomPropertyList |
Gets the list of all user custom properties.
|
| Login(String,String,String) |
Logs in a user.
|
| Login(Int64,String) |
Logs in a user based upon an authentication type and authentication user id. This will logthe user in automatically, and assumes the user has already been authenticated.
|
| Logout |
Log out the current user
|
| Authenticate(String,String) |
Returns an authentication token that can be used to authenticate the user.
|
| Authenticate(String,String,String) |
Returns an authentication token that can be used to authenticate the user.
|