C# Class TrakHound.API.Users.UserManagement

ファイルを表示 Open project: TrakHound/TrakHound-Community

Public Methods

Method Description
BasicLogin ( string id, string password, string note = "" ) : UserConfiguration

Basic User login using (Username or Email Address) and Plain Text Password

CheckUsernameAvailability ( string username ) : bool
CreateTokenLogin ( string id, string password, string note = "" ) : UserConfiguration

User Login that Creates and Returns a Remember Token

CreateUser ( CreateUserInfo info, string note = "" ) : UserConfiguration

Used to Create a new User Account

EditUser ( EditUserInfo info, string note = "" ) : UserConfiguration

Used to Edit an existing user account

Logout ( string token = null ) : bool

Used to Logout a currently logged in user

TokenLogin ( string token, string note = "" ) : UserConfiguration

User Login using Remember Token

Method Details

BasicLogin() public static method

Basic User login using (Username or Email Address) and Plain Text Password
public static BasicLogin ( string id, string password, string note = "" ) : UserConfiguration
id string
password string
note string
return UserConfiguration

CheckUsernameAvailability() public static method

public static CheckUsernameAvailability ( string username ) : bool
username string
return bool

CreateTokenLogin() public static method

User Login that Creates and Returns a Remember Token
public static CreateTokenLogin ( string id, string password, string note = "" ) : UserConfiguration
id string
password string
note string
return UserConfiguration

CreateUser() public static method

Used to Create a new User Account
public static CreateUser ( CreateUserInfo info, string note = "" ) : UserConfiguration
info CreateUserInfo
note string
return UserConfiguration

EditUser() public static method

Used to Edit an existing user account
public static EditUser ( EditUserInfo info, string note = "" ) : UserConfiguration
info EditUserInfo
note string
return UserConfiguration

Logout() public static method

Used to Logout a currently logged in user
public static Logout ( string token = null ) : bool
token string
return bool

TokenLogin() public static method

User Login using Remember Token
public static TokenLogin ( string token, string note = "" ) : UserConfiguration
token string
note string
return UserConfiguration