My Project
Loading...
Searching...
No Matches
Public Member Functions | Properties | List of all members
WebSocketSharp.Net.NetworkCredential Class Reference

Provides the credentials for the password-based authentication. More...

Public Member Functions

 NetworkCredential (string username, string password)
 Initializes a new instance of the NetworkCredential class with the specified username and password .
 
 NetworkCredential (string username, string password, string domain, params string[] roles)
 Initializes a new instance of the NetworkCredential class with the specified username , password , domain and roles .
 

Properties

string Domain [get, set]
 Gets the domain associated with the credentials.
 
string Password [get, set]
 Gets the password for the username associated with the credentials.
 
string[] Roles [get, set]
 Gets the roles associated with the credentials.
 
string Username [get, set]
 Gets the username associated with the credentials.
 

Detailed Description

Provides the credentials for the password-based authentication.

Constructor & Destructor Documentation

◆ NetworkCredential() [1/2]

WebSocketSharp.Net.NetworkCredential.NetworkCredential ( string  username,
string  password 
)
inline

Initializes a new instance of the NetworkCredential class with the specified username and password .

Parameters
usernameA string that represents the username associated with the credentials.
passwordA string that represents the password for the username associated with the credentials.
Exceptions
ArgumentNullExceptionusername is null.
ArgumentExceptionusername is empty.

◆ NetworkCredential() [2/2]

WebSocketSharp.Net.NetworkCredential.NetworkCredential ( string  username,
string  password,
string  domain,
params string[]  roles 
)
inline

Initializes a new instance of the NetworkCredential class with the specified username , password , domain and roles .

Parameters
usernameA string that represents the username associated with the credentials.
passwordA string that represents the password for the username associated with the credentials.
domainA string that represents the domain associated with the credentials.
rolesAn array of string that represents the roles associated with the credentials if any.
Exceptions
ArgumentNullExceptionusername is null.
ArgumentExceptionusername is empty.

Property Documentation

◆ Domain

string WebSocketSharp.Net.NetworkCredential.Domain
getset

Gets the domain associated with the credentials.

This property returns an empty string if the domain was initialized with null.

A string that represents the domain name to which the username belongs.

◆ Password

string WebSocketSharp.Net.NetworkCredential.Password
getset

Gets the password for the username associated with the credentials.

This property returns an empty string if the password was initialized with null.

A string that represents the password.

◆ Roles

string [] WebSocketSharp.Net.NetworkCredential.Roles
getset

Gets the roles associated with the credentials.

This property returns an empty array if the roles were initialized with null.

An array of string that represents the role names to which the username belongs.

◆ Username

string WebSocketSharp.Net.NetworkCredential.Username
getset

Gets the username associated with the credentials.

A string that represents the username.


The documentation for this class was generated from the following file: