Liblinphone  5.5.0
Public Member Functions | Properties | List of all members
Linphone.AuthInfo Class Reference
Inheritance diagram for Linphone.AuthInfo:
Linphone.LinphoneObject

Public Member Functions

void AddAvailableAlgorithm (string algorithm)
 
void ClearAvailableAlgorithms ()
 
Linphone.AuthInfo Clone ()
 
bool IsEqualButAlgorithms (Linphone.AuthInfo authInfo2)
 

Properties

Linphone.BearerToken AccessToken [get, set]
 
string Algorithm [get, set]
 
string AuthorizationServer [get, set]
 
IEnumerable< string > AvailableAlgorithms [get, set]
 
string ClientId [get, set]
 
string ClientSecret [get, set]
 
string Domain [get, set]
 
long Expires [get, set]
 
string Ha1 [get, set]
 
string Password [get, set]
 
string Realm [get, set]
 
Linphone.BearerToken RefreshToken [get, set]
 
string TlsCert [get, set]
 
string TlsCertPath [get, set]
 
string TlsKey [get, set]
 
string TlsKeyPath [get, set]
 
string TokenEndpointUri [get, set]
 
string Userid [get, set]
 
string Username [get, set]
 

Additional Inherited Members

- Protected Member Functions inherited from Linphone.LinphoneObject
static String linphone_pointer_to_string (IntPtr ptr)
 
static IntPtr linphone_string_to_pointer ([MarshalAs(LinphoneWrapper.ByteStringMarshalling)] String str)
 
IntPtr StringArrayToBctbxList (IEnumerable< string > stringlist)
 
void CleanStringArrayPtrs (IntPtr l)
 

Detailed Description

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.

Member Function Documentation

void Linphone.AuthInfo.AddAvailableAlgorithm ( string  algorithm)
inline

Add an unique algorithm in the the available algorithms list : Algorithms that already exist will not be added.

Parameters
algorithmThe algorithm to add.
void Linphone.AuthInfo.ClearAvailableAlgorithms ( )
inline

Remove all algorithms from the available algorithms list.

Linphone.AuthInfo Linphone.AuthInfo.Clone ( )
inline

Instantiates a new auth info with values from source.

Returns
The newly created Linphone.AuthInfo object.
bool Linphone.AuthInfo.IsEqualButAlgorithms ( Linphone.AuthInfo  authInfo2)
inline

Check if Authinfos are the same without taking account algorithms.

Parameters
authInfo2The second Linphone.AuthInfo object.
Returns
true if all fields (Username, UserId, Realm, Domain) are the same.

Property Documentation

Linphone.BearerToken Linphone.AuthInfo.AccessToken
getset

Return a previously set access token.

Returns
the access token, as a Linphone.BearerToken object
string Linphone.AuthInfo.Algorithm
getset

Gets the algorithm.

Returns
The algorithm.
string Linphone.AuthInfo.AuthorizationServer
getset

Get the previously set authorization server uri.

Returns
the authorization server uri.
IEnumerable<string> Linphone.AuthInfo.AvailableAlgorithms
getset

Gets all available algorithms.

Returns
A list of available algorithms. A list of const char * objects.
string Linphone.AuthInfo.ClientId
getset

Get the previously set OAUTH2 client_id.

Returns
the client_id.
string Linphone.AuthInfo.ClientSecret
getset

Get the previously set OAUTH2 client_secret.

Returns
the client_secret.
string Linphone.AuthInfo.Domain
getset

Gets the domain.

Returns
The domain.
long Linphone.AuthInfo.Expires
getset

Get the expiration time for the current authentication information.

Returns
The expiration time as a number of seconds since the Epoch, 1970-01-01 00:00:00 +0000 (UTC)
string Linphone.AuthInfo.Ha1
getset

Gets the ha1.

Returns
The ha1.
string Linphone.AuthInfo.Password
getset

Gets the password.

Returns
The password.
string Linphone.AuthInfo.Realm
getset

Gets the realm.

Returns
The realm.
Linphone.BearerToken Linphone.AuthInfo.RefreshToken
getset

Return a previously set refresh token.

Returns
the refresh token, as a Linphone.BearerToken object.
string Linphone.AuthInfo.TlsCert
getset

Gets the TLS certificate.

Returns
The TLS certificate.
string Linphone.AuthInfo.TlsCertPath
getset

Gets the TLS certificate path.

Returns
The TLS certificate path.
string Linphone.AuthInfo.TlsKey
getset

Gets the TLS key.

Returns
The TLS key.
string Linphone.AuthInfo.TlsKeyPath
getset

Gets the TLS key path.

Returns
The TLS key path.
string Linphone.AuthInfo.TokenEndpointUri
getset

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

Returns
the token endpoint uri.
string Linphone.AuthInfo.Userid
getset

Gets the user id.

Returns
The user id.
string Linphone.AuthInfo.Username
getset

Gets the username.

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