C# Class LoginRadiusSDK.Entity.LoginRadiusAccountEntity

Inheritance: LoginRadiusEntityBase

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

Public Methods

Method	Description
ChangeAccountPassword ( string accountId, string oldPassword, string newPassword ) : LoginRadiusPostResponse	Method is used to change the password field of an account, user need to know the old password before you change it.
ChangeAccountUsername ( string accountId, string currentusername, string newusername ) : LoginRadiusPostResponse	Method is used for changing user name by account Id.
CheckAccountUsername ( string username ) : LoginRadiusEmailResponse	Represents a method is used to check username exists or not on your site.
DeleteAccount ( string accountId ) : LoginRadiusPostResponse	Method which is used to deletes the Users account and allows them to re-register for a new account.
DeleteAccountWithEmailConfirmation ( string accountId, string deleteUserLink, string template ) : LoginRadiusPostResponse	Method which deletes the User account with email confirmation and allows them to re-register for a new account.
GetAccountPassword ( string accountId ) : LoginRadiusSDK.Models.Object.HashPassword	Method is used to retrieve the accounts encrypted hashed password based on account ID(UID).
GetAccountProfiles ( string accountId ) : List	Method which is used to retrieve all of the profile data from each of the linked social provider accounts associated with the account.
GetPasswordForgotToken ( string emailId ) : LoginRadiusForgotPasswordTokenResponse	Method generates a forgot password token so you can manually pass into the reset password page and reset someone's password.
LinkAccount ( string accountId, string provider, string providerId ) : LoginRadiusPostResponse	Method which is used to link a social account with a specified provider user account.
ResendUserVerificationEmail ( string emailId, string link, string template ) : LoginRadiusEmailVerificationToken	This method is used to generate an email-token that can be sent out to a user in a link in order to verify their email.
SetAccountPassword ( string accountId, string password ) : LoginRadiusPostResponse	Method is used to set a new password for the specified account. It is meant to be used as an admin feature or post authentication.
SetAccountStatus ( string accountId, bool isBlock ) : LoginRadiusPostResponse	Method which is used to block or unblock a Users account. It prevents them from logging in our registering for a new account.
SetAccountUsername ( string accountId, string newusername ) : LoginRadiusPostResponse	Represents a method is is used for set user name by account Id.
UnlinkAccount ( string accountId, string provider, string providerId ) : LoginRadiusPostResponse	Method which is used to remove the link between a users account and the specified provider’s user account.
UserCreateRegistrationProfile ( string accountid, string emailid, string password ) : LoginRadiusPostResponse	Method for profile data and authentication of a user.
UserEmailAddOrRemove ( string accountid, string action, string emailId, string emailType ) : LoginRadiusPostResponse	Method is used to add or remove additional emails to a user's account.

Method Details

ChangeAccountPassword() public method

Method is used to change the password field of an account, user need to know the old password before you change it.

public ChangeAccountPassword ( string accountId, string oldPassword, string newPassword ) : LoginRadiusPostResponse
accountId	string	An account id is set of unique numerics and characters that uniquely identifies a user's account or the identifier for each user account.
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 new passsword.
return	LoginRadiusSDK.Models.LoginRadiusPostResponse

ChangeAccountUsername() public method

Method is used for changing user name by account Id.

public ChangeAccountUsername ( string accountId, string currentusername, string newusername ) : LoginRadiusPostResponse
accountId	string	the identifier for each user account.
currentusername	string	Current Username or username to be changed.
newusername	string	New username
return	LoginRadiusSDK.Models.LoginRadiusPostResponse

CheckAccountUsername() public method

Represents a method is used to check username exists or not on your site.

public CheckAccountUsername ( string username ) : LoginRadiusEmailResponse
username	string	Username to be check
return	LoginRadiusSDK.Models.LoginRadiusEmailResponse

DeleteAccount() public method

Method which is used to deletes the Users account and allows them to re-register for a new account.

public DeleteAccount ( string accountId ) : LoginRadiusPostResponse
accountId	string	An account id is set of unique numerics and characters that uniquely identifies a user's account or the identifier for each user account, it may have multiple IDs.
return	LoginRadiusSDK.Models.LoginRadiusPostResponse

DeleteAccountWithEmailConfirmation() public method

Method which deletes the User account with email confirmation and allows them to re-register for a new account.

public DeleteAccountWithEmailConfirmation ( string accountId, string deleteUserLink, string template ) : LoginRadiusPostResponse
accountId	string	An account id is set of unique numerics and characters that uniquely identifies a user's account or the identifier for each user account.
deleteUserLink	string	Link that handles the delete logic
template	string	Name of the email template to be send for the delete confirmation
return	LoginRadiusSDK.Models.LoginRadiusPostResponse

GetAccountPassword() public method

Method is used to retrieve the accounts encrypted hashed password based on account ID(UID).

public GetAccountPassword ( string accountId ) : LoginRadiusSDK.Models.Object.HashPassword
accountId	string	the identifier for each user account.
return	LoginRadiusSDK.Models.Object.HashPassword

GetAccountProfiles() public method

Method which is used to retrieve all of the profile data from each of the linked social provider accounts associated with the account.

public GetAccountProfiles ( string accountId ) : List
accountId	string	An account id is set of unique numerics and characters that uniquely identifies a user's account or the identifier for each user account, it may have multiple IDs.
return	List

GetPasswordForgotToken() public method

Method generates a forgot password token so you can manually pass into the reset password page and reset someone's password.

public GetPasswordForgotToken ( string emailId ) : LoginRadiusForgotPasswordTokenResponse
emailId	string	Email address.
return	LoginRadiusSDK.Models.LoginRadiusForgotPasswordTokenResponse

LinkAccount() public method

Method which is used to link a social account with a specified provider user account.

public LinkAccount ( string accountId, string provider, string providerId ) : LoginRadiusPostResponse
accountId	string	An account id is set of unique numerics and characters that uniquely identifies a user's account.
provider	string	A supported Social provider name in lower case which is to be linked
providerId	string	The ID of the social provider.
return	LoginRadiusSDK.Models.LoginRadiusPostResponse

ResendUserVerificationEmail() public method

This method is used to generate an email-token that can be sent out to a user in a link in order to verify their email.

public ResendUserVerificationEmail ( string emailId, string link, string template ) : LoginRadiusEmailVerificationToken
emailId	string	User's email address
link	string	Verification Url link address
template	string	Verification Email Template,Optional
return	LoginRadiusSDK.Models.LoginRadiusEmailVerificationToken

SetAccountPassword() public method

Method is used to set a new password for the specified account. It is meant to be used as an admin feature or post authentication.

public SetAccountPassword ( string accountId, string password ) : LoginRadiusPostResponse
accountId	string	the identifier for each user account.
password	string	A password is a string of characters used for authenticating a user or account password to be set.
return	LoginRadiusSDK.Models.LoginRadiusPostResponse

SetAccountStatus() public method

Method which is used to block or unblock a Users account. It prevents them from logging in our registering for a new account.

public SetAccountStatus ( string accountId, bool isBlock ) : LoginRadiusPostResponse
accountId	string	An account id is set of unique numerics and characters that uniquely identifies a user's account or the identifier for each user account.
isBlock	bool	True or False , defines the status to be set.
return	LoginRadiusSDK.Models.LoginRadiusPostResponse

SetAccountUsername() public method

Represents a method is is used for set user name by account Id.

public SetAccountUsername ( string accountId, string newusername ) : LoginRadiusPostResponse
accountId	string	the identifier for each user account.
newusername	string	New Username to be set
return	LoginRadiusSDK.Models.LoginRadiusPostResponse

UnlinkAccount() public method

Method which is used to remove the link between a users account and the specified provider’s user account.

public UnlinkAccount ( string accountId, string provider, string providerId ) : LoginRadiusPostResponse
accountId	string	An account id is set of unique numerics and characters that uniquely identifies a user's account.
provider	string	A supported social provider in lower case which is to be unlinked.
providerId	string	The ID of the social provider.
return	LoginRadiusSDK.Models.LoginRadiusPostResponse

UserCreateRegistrationProfile() public method

Method for profile data and authentication of a user.

public UserCreateRegistrationProfile ( string accountid, string emailid, string password ) : LoginRadiusPostResponse
accountid	string	Account Id is a uniquely generated string used for determination of a user account.
emailid	string	An email is an unique set of characters and numerics that uniquely identifies a user.
password	string	A password is a string of characters used for authenticating a user.
return	LoginRadiusSDK.Models.LoginRadiusPostResponse

UserEmailAddOrRemove() public method

Method is used to add or remove additional emails to a user's account.

public UserEmailAddOrRemove ( string accountid, string action, string emailId, string emailType ) : LoginRadiusPostResponse
accountid	string	Account Id is a uniquely generated string used for determination of a user account.
action	string	Add or remove.
emailId	string	Email address.
emailType	string	Email Type like "Business" or Personal.
return	LoginRadiusSDK.Models.LoginRadiusPostResponse