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 Linphone.AuthInfo must be added to the Linphone.Core in order to become known and used automatically when needed. Use Linphone.Core.AddAuthInfo() for that purpose. The Linphone.Core object can take the initiative to request authentication information when needed to the application through the authentication_requested() callback of it's Linphone.CoreListener. The application can respond to this information request later using Linphone.Core.AddAuthInfo(). This will unblock all pending authentication transactions and retry them with authentication headers.

Inheritance

System.Object

LinphoneObject

AuthInfo

Inherited Members

LinphoneObject.linphone_pointer_to_string(IntPtr)

LinphoneObject.linphone_string_to_pointer(String)

LinphoneObject.StringArrayToBctbxList(IEnumerable<String>)

LinphoneObject.CleanStringArrayPtrs(IntPtr)

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Linphone

Assembly: cs.temp.dll.dll

Syntax

public class AuthInfo : LinphoneObject

Properties

AccessToken

Return a previously set access token.

Declaration

public BearerToken AccessToken { get; set; }

Property Value

Type	Description
BearerToken	the access token, as a Linphone.BearerToken object

Algorithm

Gets the algorithm.

Declaration

public string Algorithm { get; set; }

Property Value

Type	Description
System.String	The algorithm.

AuthorizationServer

Get the previously set authorization server uri.

Declaration

public string AuthorizationServer { get; set; }

Property Value

Type	Description
System.String	the authorization server uri.

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.

ClientId

Get the previously set OAUTH2 client_id.

Declaration

public string ClientId { get; set; }

Property Value

Type	Description
System.String	the client_id.

Domain

Gets the domain.

Declaration

public string Domain { get; set; }

Property Value

Type	Description
System.String	The domain.

Expires

Get the expiration time for the current authentication information.

Declaration

public long Expires { get; set; }

Property Value

Type	Description
System.Int64	The expiration time as a number of seconds since the Epoch, 1970-01-01 00:00:00 +0000 (UTC)

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.

RefreshToken

Return a previously set refresh token.

Declaration

public BearerToken RefreshToken { get; set; }

Property Value

Type	Description
BearerToken	the refresh token, as a Linphone.BearerToken object.

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.

TokenEndpointUri

Get the previously set token endpoint https uri (OAUTH2).

Declaration

public string TokenEndpointUri { get; set; }

Property Value

Type	Description
System.String	the token endpoint uri.

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 Linphone.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 Linphone.AuthInfo object.

Returns

Type	Description
System.Boolean	true if all fields (Username, UserId, Realm, Domain) are the same.