Class AuthInfo
Object holding authentication information.
In most case, authentication information consists of a username and password.
If realm isn't set, it will be deduced automatically from the first
authentication challenge as for the hash algorithm. Sometimes, a userid is
required by the proxy and then domain can be useful to discriminate different
credentials. You can also use this object if you need to use a client
certificate.
Once created and filled, a AuthInfo must be added to the Core in order to become known and used automatically when
needed. Use
Inherited Members
Namespace: Linphone
Assembly: cs.temp.dll.dll
Syntax
public class AuthInfo : LinphoneObject
Properties
Algorithm
Gets the algorithm.
Declaration
public string Algorithm { get; set; }
Property Value
Type | Description |
---|---|
System.String | The algorithm. |
AvailableAlgorithms
Gets all available algorithms.
Declaration
public IEnumerable<string> AvailableAlgorithms { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<System.String> | A list of available algorithms. |
Domain
Gets the domain.
Declaration
public string Domain { get; set; }
Property Value
Type | Description |
---|---|
System.String | The domain. |
Ha1
Gets the ha1.
Declaration
public string Ha1 { get; set; }
Property Value
Type | Description |
---|---|
System.String | The ha1. |
Password
Gets the password.
Declaration
public string Password { get; set; }
Property Value
Type | Description |
---|---|
System.String | The password. |
Realm
Gets the realm.
Declaration
public string Realm { get; set; }
Property Value
Type | Description |
---|---|
System.String | The realm. |
TlsCert
Gets the TLS certificate.
Declaration
public string TlsCert { get; set; }
Property Value
Type | Description |
---|---|
System.String | The TLS certificate. |
TlsCertPath
Gets the TLS certificate path.
Declaration
public string TlsCertPath { get; set; }
Property Value
Type | Description |
---|---|
System.String | The TLS certificate path. |
TlsKey
Gets the TLS key.
Declaration
public string TlsKey { get; set; }
Property Value
Type | Description |
---|---|
System.String | The TLS key. |
TlsKeyPath
Gets the TLS key path.
Declaration
public string TlsKeyPath { get; set; }
Property Value
Type | Description |
---|---|
System.String | The TLS key path. |
Userid
Gets the user id.
Declaration
public string Userid { get; set; }
Property Value
Type | Description |
---|---|
System.String | The user id. |
Username
Gets the username.
Declaration
public string Username { get; set; }
Property Value
Type | Description |
---|---|
System.String | The username. |
Methods
AddAvailableAlgorithm(String)
Add an unique algorithm in the the available algorithms list : Algorithms that already exist will not be added.
Declaration
public void AddAvailableAlgorithm(string algorithm)
Parameters
Type | Name | Description |
---|---|---|
System.String | algorithm | The algorithm to add. |
ClearAvailableAlgorithms()
Remove all algorithms from the available algorithms list.
Declaration
public void ClearAvailableAlgorithms()
Clone()
Instantiates a new auth info with values from source.
Declaration
public AuthInfo Clone()
Returns
Type | Description |
---|---|
AuthInfo | The newly created AuthInfo object. |
IsEqualButAlgorithms(AuthInfo)
Check if Authinfos are the same without taking account algorithms.
Declaration
public bool IsEqualButAlgorithms(AuthInfo authInfo2)
Parameters
Type | Name | Description |
---|---|---|
AuthInfo | authInfo2 | The second AuthInfo object. |
Returns
Type | Description |
---|---|
System.Boolean | true if all fields (Username, UserId, Realm, Domain) are the same. |