C# Class LoginRadiusSDK.Entity.LoginRadiusUserProfileEntity

Inheritance: LoginRadiusEntityBase

Mostrar archivo Open project: LoginRadius/dot-net-sdk Class Usage Examples

Public Methods

Method	Description
AuthenticateUser ( string emailId, string password ) : RaasUserprofile	Method to authenticate users and returns the profile data associated with the authenticated user.
ChangePassword ( string userid, string oldPassword, string newPassword ) : LoginRadiusPostResponse	Method to change a user password.
CheckUserEmail ( string emailId ) : LoginRadiusEmailResponse	Method checks for the existence of the specified email address in your Cloud Storage.
CreateUser ( LoginRadiusSDK.Models.Object.User user ) : RaasUserprofile	Method to create a new user profile data with required parameters.
DeleteUser ( string userid, string deleteuserlink, string template ) : LoginRadiusPostResponse	Method to delete a user profile with email confirmation.
GetHashPassword ( string userid ) : LoginRadiusSDK.Models.Object.HashPassword	Method which returns the encrypted hashed password for the specified User..
GetUser ( string userid ) : RaasUserprofile	Method for profile data and authentication of a user by userid.
GetUserbyEmail ( string emailId ) : RaasUserprofile	Represents a method that retrieves the profile data associated with the specific user using the passing in email address.
RegisterUser ( LoginRadiusSDK.Models.Object.User user ) : LoginRadiusPostResponse	Represents a method to register a new user profile with required parameters into your Cloud Storage and triggers the email verification process.
SetPassword ( string userid, string password ) : LoginRadiusPostResponse	Method to set the password of user for social profile and traditional profile .
UpdateUser ( string userid, LoginRadiusSDK.Models.Object.User user ) : LoginRadiusPostResponse	Represents a method to update a user profile

Method Details

AuthenticateUser() public method

Method to authenticate users and returns the profile data associated with the authenticated user.

public AuthenticateUser ( string emailId, string password ) : RaasUserprofile
emailId	string	A username is a name or email that uniquely identifies a user.
password	string	A password is a string of characters used for authenticating a user.
return	RaasUserprofile

ChangePassword() public method

Method to change a user password.

public ChangePassword ( string userid, string oldPassword, string newPassword ) : LoginRadiusPostResponse
userid	string	A userid is set of unique numerics and characters that uniquely identifies a user.
oldPassword	string	Old Password is the current passowrd of a user or password is to be changed.
newPassword	string	A new unique set of characters and numbers which is to be used as a passsword.
return	LoginRadiusSDK.Models.LoginRadiusPostResponse

CheckUserEmail() public method

Method checks for the existence of the specified email address in your Cloud Storage.

public CheckUserEmail ( string emailId ) : LoginRadiusEmailResponse
emailId	string	Email address.
return	LoginRadiusSDK.Models.LoginRadiusEmailResponse

CreateUser() public method

Method to create a new user profile data with required parameters.

public CreateUser ( LoginRadiusSDK.Models.Object.User user ) : RaasUserprofile
user	LoginRadiusSDK.Models.Object.User	User is a set of parameters used for creating a user.
return	RaasUserprofile

DeleteUser() public method

Method to delete a user profile with email confirmation.

public DeleteUser ( string userid, string deleteuserlink, string template ) : LoginRadiusPostResponse
userid	string	A userid is set of unique numerics and characters that uniquely identifies a user.
deleteuserlink	string	Delete user link is an URL which handles the logic of deleting a user and this URL is to be emailed to the user for confirmation.
template	string	Name of email template
return	LoginRadiusSDK.Models.LoginRadiusPostResponse

GetHashPassword() public method

Method which returns the encrypted hashed password for the specified User..

public GetHashPassword ( string userid ) : LoginRadiusSDK.Models.Object.HashPassword
userid	string	A userid is set of unique numerics and characters that uniquely identifies a user.
return	LoginRadiusSDK.Models.Object.HashPassword

GetUser() public method

Method for profile data and authentication of a user by userid.

public GetUser ( string userid ) : RaasUserprofile
userid	string	A userid is set of unique numerics and characters that uniquely identifies a user.
return	RaasUserprofile

GetUserbyEmail() public method

Represents a method that retrieves the profile data associated with the specific user using the passing in email address.

public GetUserbyEmail ( string emailId ) : RaasUserprofile
emailId	string	An email is an unique set of characters and numerics that uniquely identifies a user or email address.
return	RaasUserprofile

RegisterUser() public method

Represents a method to register a new user profile with required parameters into your Cloud Storage and triggers the email verification process.

public RegisterUser ( LoginRadiusSDK.Models.Object.User user ) : LoginRadiusPostResponse
user	LoginRadiusSDK.Models.Object.User	User is a set of parameters used for registering a user.
return	LoginRadiusSDK.Models.LoginRadiusPostResponse

SetPassword() public method

Method to set the password of user for social profile and traditional profile .

public SetPassword ( string userid, string password ) : LoginRadiusPostResponse
userid	string	A userid is set of unique numerics and characters that uniquely identifies a user.
password	string	A password is a string of characters used for authenticating a user.
return	LoginRadiusSDK.Models.LoginRadiusPostResponse

UpdateUser() public method

Represents a method to update a user profile

public UpdateUser ( string userid, LoginRadiusSDK.Models.Object.User user ) : LoginRadiusPostResponse
userid	string	A userid is set of unique numerics and characters that uniquely identifies a user.
user	LoginRadiusSDK.Models.Object.User	User is a set of parameters used for creating a user with required parameters.
return	LoginRadiusSDK.Models.LoginRadiusPostResponse