Liblinphone  5.5.0
Linphone.Account Class Reference
Inheritance diagram for Linphone.Account:
Linphone.LinphoneObject

Public Member Functions

void AddCustomParam (string key, string val)
 
void ClearCallLogs ()
 
Linphone.Account Clone ()
 
IEnumerable< Linphone.ChatRoomFilterChatRooms (string filter)
 
Linphone.AuthInfo FindAuthInfo ()
 
IEnumerable< Linphone.CallLogGetCallLogsForAddress (Linphone.Address remoteAddress)
 
string GetCustomHeader (string headerName)
 
string GetCustomParam (string key)
 
bool IsPhoneNumber (string username)
 
string NormalizePhoneNumber (string username)
 
Linphone.Address NormalizeSipUri (string username)
 
void PauseRegister ()
 
void RefreshRegister ()
 
void ResetMissedCallsCount ()
 
void SetCustomHeader (string headerName, string headerValue)
 

Static Public Member Functions

static Linphone.Account NewWithConfig (Linphone.Core lc, Linphone.AccountParams parameters, Linphone.ProxyConfig config)
 

Properties

AccountListener Listener [get, set]
 
bool AvpfEnabled [get]
 
IEnumerable< Linphone.CallLogCallLogs [get]
 
IEnumerable< Linphone.ChatRoomChatRooms [get]
 
IEnumerable< Linphone.ConferenceInfoConferenceInformationList [get]
 
Linphone.ConsolidatedPresence ConsolidatedPresence [get, set]
 
Linphone.Address ContactAddress [get, set]
 
Linphone.Core Core [get]
 
Linphone.Account Dependency [get, set]
 
Linphone.Reason Error [get]
 
Linphone.ErrorInfo ErrorInfo [get]
 
bool IsAvpfEnabled [get]
 
Linphone.MessageWaitingIndication LatestReceivedMessageWaitingIndication [get]
 
int MissedCallsCount [get]
 
Linphone.AccountParams Params [get, set]
 
Linphone.PresenceModel PresenceModel [get, set]
 
Linphone.RegistrationState State [get]
 
Linphone.TransportType Transport [get]
 
int UnreadChatMessageCount [get]
 

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 that represents a Linphone Account.

This object replaces the deprecated Linphone.ProxyConfig. Use a Linphone.AccountParams object to configure it.

Member Function Documentation

void Linphone.Account.AddCustomParam ( string  key,
string  val 
)
inline

Set one custom parameter to this Linphone.Account.

Parameters
keykey of the searched parameter.
valvalue of the searched parameter.
void Linphone.Account.ClearCallLogs ( )
inline

Deletes all the call logs related to this account from the database.

Linphone.Account Linphone.Account.Clone ( )
inline

Instantiate a new account with values from source.

Returns
The newly created Linphone.Account object.
IEnumerable<Linphone.ChatRoom> Linphone.Account.FilterChatRooms ( string  filter)
inline

Returns a filtered list of chat rooms for a given account.

Parameters
filterthe criteria a chat room must meet somehow (subject, participant address, friend's name).
Returns
The list of chat rooms A list of Linphone.ChatRoom objects. .
Linphone.AuthInfo Linphone.Account.FindAuthInfo ( )
inline

Find authentication info matching account, if any, similarly to linphone_core_find_auth_info.

Returns
a Linphone.AuthInfo matching account criteria if possible, null if nothing can be found.
IEnumerable<Linphone.CallLog> Linphone.Account.GetCallLogsForAddress ( Linphone.Address  remoteAddress)
inline

Returns the list of call logs for a given account.

This list must be freed after use.

Parameters
remoteAddressthe Linphone.Address object to filter call logs.
Returns
The list of filtered call logs A list of Linphone.CallLog objects. .
string Linphone.Account.GetCustomHeader ( string  headerName)
inline

Obtain the value of a header sent by the server in last answer to REGISTER.

Parameters
headerNameThe header name for which to fetch corresponding value.
Returns
The value of the queried header.
string Linphone.Account.GetCustomParam ( string  key)
inline

Get the custom parameter with key to this Linphone.Account.

Parameters
keykey of the searched parameter.
Returns
The value of the parameter with key if found or an empty string otherwise.
bool Linphone.Account.IsPhoneNumber ( string  username)
inline

Detect if the given input is a phone number or not.

Parameters
usernameThe string to parse.
Returns
true if input is a phone number, false otherwise.
static Linphone.Account Linphone.Account.NewWithConfig ( Linphone.Core  lc,
Linphone.AccountParams  parameters,
Linphone.ProxyConfig  config 
)
inlinestatic

Create a new Linphone.Account with a Proxy config backpointer.

This is only intended to be used while keeping a backward compatibility with proxy config.

Parameters
lcThe Linphone.Core object.
parametersThe Linphone.AccountParams object.
configThe Linphone.ProxyConfig object.
Returns
The newly created Linphone.Account object.
string Linphone.Account.NormalizePhoneNumber ( string  username)
inline

Normalize a human readable phone number into a basic string.

888-444-222 becomes 888444222 or +33888444222 depending on the Linphone.Account object. This function will always generate a normalized username if input is a phone number.

Parameters
usernameThe string to parse.
Returns
null if input is an invalid phone number, normalized phone number from username input otherwise.
Linphone.Address Linphone.Account.NormalizeSipUri ( string  username)
inline

Normalize a human readable sip uri into a fully qualified LinphoneAddress.

A sip address should look like DisplayName <sip:username:port> . Basically this function performs the following tasks -if a phone number is entered, prepend country prefix and eventually escape the '+' by 00 of the proxy config. -if no domain part is supplied, append the domain name of the proxy config. Returns null if no proxy is provided at this point. -if no sip: is present, prepend it. The result is a syntactically correct SIP address.

Parameters
usernameThe string to parse.
Returns
null if invalid input, normalized sip address otherwise.
void Linphone.Account.PauseRegister ( )
inline

Prevent an account from refreshing its registration.

This is useful to let registrations to expire naturally (or) when the application wants to keep control on when refreshes are sent. However, linphone_core_set_network_reachable(lc,true) will always request the accounts to refresh their registrations. The refreshing operations can be resumed with Linphone.Account.RefreshRegister().

void Linphone.Account.RefreshRegister ( )
inline

Refresh a proxy registration.

This is useful if for example you resuming from suspend, thus IP address may have changed.

void Linphone.Account.ResetMissedCallsCount ( )
inline

Re-sets the number of missed calls for this account to 0.

void Linphone.Account.SetCustomHeader ( string  headerName,
string  headerValue 
)
inline

Set the value of a custom header sent to the server in REGISTERs request.

Parameters
headerNameThe header name.
headerValueThe header value.

Property Documentation

bool Linphone.Account.AvpfEnabled
get

Indicates whether AVPF/SAVPF is being used for calls using this account.

Returns
true if AVPF/SAVPF is enabled, false otherwise.
IEnumerable<Linphone.CallLog> Linphone.Account.CallLogs
get

Returns the list of call logs for a given account.

This list must be freed after use.

Returns
The list of call logs A list of Linphone.CallLog objects. .
IEnumerable<Linphone.ChatRoom> Linphone.Account.ChatRooms
get

Returns the list of chat rooms for a given account.

Returns
The list of chat rooms A list of Linphone.ChatRoom objects. .
IEnumerable<Linphone.ConferenceInfo> Linphone.Account.ConferenceInformationList
get

Returns the list of conference information stored locally for a given account.

This list must be freed after use.

Returns
The list of call logs A list of Linphone.ConferenceInfo objects. .

Warning : This method also start the synchronization with the CCMP server, should it be defined in the Linphone.AccountParams. The application may want to wait for the callback conference_information_updated to get an up-to-date list of conferences

Linphone.ConsolidatedPresence Linphone.Account.ConsolidatedPresence
getset

Gets consolidated presence for a Linphone.Account.

Returns
A Linphone.ConsolidatedPresence presence
Linphone.Address Linphone.Account.ContactAddress
getset

Return the contact address of the account.

Returns
a Linphone.Address correspong to the contact address of the account.
Linphone.Core Linphone.Account.Core
get

Get the Linphone.Core object to which is associated the Linphone.Account.

Returns
The Linphone.Core object to which is associated the Linphone.Account.
Linphone.Account Linphone.Account.Dependency
getset

Get the dependency of a Linphone.Account.

Returns
The account this one is dependent upon, or null if not marked dependent.
Linphone.Reason Linphone.Account.Error
get

Get the reason why registration failed when the account state is LinphoneRegistrationFailed.

Returns
The Linphone.Reason why registration failed for this account.
Linphone.ErrorInfo Linphone.Account.ErrorInfo
get

Get detailed information why registration failed when the account state is LinphoneRegistrationFailed.

Returns
The Linphone.ErrorInfo explaining why registration failed for this account.
bool Linphone.Account.IsAvpfEnabled
get

Indicates whether AVPF/SAVPF is being used for calls using this account.

Returns
true if AVPF/SAVPF is enabled, false otherwise.

Deprecated : 16/12/2021 Use Linphone.Account.AvpfEnabled() instead.

Linphone.MessageWaitingIndication Linphone.Account.LatestReceivedMessageWaitingIndication
get

Returns the latest Message Waiting Indication (MWI) received payload, if any.

Returns
The latest Linphone.MessageWaitingIndication or null.
int Linphone.Account.MissedCallsCount
get

Returns the missed calls count for a given account.

Returns
The missed calls count.
Linphone.AccountParams Linphone.Account.Params
getset

Get the Linphone.AccountParams as read-only object.

To make changes, clone the returned object using Linphone.AccountParams.Clone() method, make your changes on it and apply them using with Linphone.Account.Params.

Returns
The Linphone.AccountParams attached to this account.
Linphone.PresenceModel Linphone.Account.PresenceModel
getset

Get the presence model linked to a given account.

Returns
the presence model, if assigned, null otherwise.
Linphone.RegistrationState Linphone.Account.State
get

Get the registration state of the given account.

Returns
The Linphone.RegistrationState of the account.
Linphone.TransportType Linphone.Account.Transport
get

Get the transport from either service route, route or addr.

Returns
The transport as a string (I.E udp, tcp, tls, dtls).

Deprecated : 01/03/2021 Use Linphone_account_params_get_transport() instead.

int Linphone.Account.UnreadChatMessageCount
get

Returns the unread chat message count for a given account.

Returns
The unread chat message count.

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