Linphone.ProxyConfig Class Reference

Inheritance diagram for Linphone.ProxyConfig:

Public Member Functions
void	Done ()
void	Edit ()
Linphone.AuthInfo	FindAuthInfo ()
string	GetCustomHeader (string headerName)
string	NormalizePhoneNumber (string username)
Linphone.Address	NormalizeSipUri (string username)
void	PauseRegister ()
void	RefreshRegister ()
void	SetCustomHeader (string headerName, string headerValue)

Properties
bool	AvpfEnabled [get]
Linphone.AVPFMode	AvpfMode [get, set]
uint	AvpfRrInterval [get, set]
string	ConferenceFactoryUri [get, set]
Linphone.Address	Contact [get]
string	ContactParameters [get, set]
string	ContactUriParameters [get, set]
Linphone.Core	Core [get]
Linphone.ProxyConfig	Dependency [get, set]
bool	DialEscapePlus [get, set]
string	DialPrefix [get, set]
string	Domain [get]
Linphone.Reason	Error [get]
Linphone.ErrorInfo	ErrorInfo [get]
int	Expires [get, set]
Linphone.Address	IdentityAddress [get, set]
string	Idkey [get, set]
bool	IsPushNotificationAllowed [get]
bool	IsPushNotificationAvailable [get]
bool	IsRemotePushNotificationAllowed [get]
Linphone.NatPolicy	NatPolicy [get, set]
uint	Privacy [get, set]
bool	PublishEnabled [get, set]
int	PublishExpires [get, set]
bool	PushNotificationAllowed [set]
Linphone.PushNotificationConfig	PushNotificationConfig [get, set]
string	QualityReportingCollector [get, set]
bool	QualityReportingEnabled [get, set]
int	QualityReportingInterval [get, set]
string	Realm [get, set]
string	RefKey [get, set]
bool	RegisterEnabled [get, set]
bool	RemotePushNotificationAllowed [set]
string	Route [set]
IEnumerable< string >	Routes [get, set]
string	ServerAddr [get, set]
Linphone.RegistrationState	State [get]
string	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

Represents an account configuration to be used by Linphone.Core.

In addition to the Linphone.AuthInfo that stores the credentials, you need to configure a Linphone.ProxyConfig as well to be able to connect to a proxy server. A minimal proxy config consists of an identity address (sip:usern.nosp@m.ame@.nosp@m.domai.nosp@m.n.tl.nosp@m.d) and the proxy server address,

See : Linphone.ProxyConfig.ServerAddr.

If any, it will be stored inside the default configuration file, so it will survive the destruction of the Linphone.Core and be available at the next start. The account set with Linphone.Core.DefaultProxyConfig will be used as default for outgoing calls & chat messages unless specified otherwise.

Deprecated : 06/04/2020 Use Linphone.Account object instead

Member Function Documentation

void Linphone.ProxyConfig.Done ( )

inline

Commits modification made to the proxy configuration.

Returns

0 if successful, -1 otherwise

Deprecated : 06/04/2020 Use Linphone.Account object instead

void Linphone.ProxyConfig.Edit ( )

inline

Starts editing a proxy configuration.

Because proxy configuration must be consistent, applications MUST call Linphone.ProxyConfig.Edit() before doing any attempts to modify proxy configuration (such as identity, proxy address and so on). Once the modifications are done, then the application must call Linphone.ProxyConfig.Done() to commit the changes.

Deprecated : 06/04/2020 Use Linphone.Account object instead

Linphone.AuthInfo Linphone.ProxyConfig.FindAuthInfo ( )

inline

Find authentication info matching proxy config, if any, similarly to linphone_core_find_auth_info.

Returns

a Linphone.AuthInfo matching proxy config criteria if possible, null if nothing can be found.

Deprecated : 06/04/2020 Use Linphone.Account object instead

string Linphone.ProxyConfig.GetCustomHeader ( string  headerName )

inline

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

Parameters

headerName

the header name for which to fetch corresponding value

Returns

the value of the queried header.

Deprecated : 06/04/2020 Use Linphone.Account object instead

string Linphone.ProxyConfig.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.ProxyConfig object. This function will always generate a normalized username if input is a phone number.

Parameters

username

the string to parse

Returns

null if input is an invalid phone number, normalized phone number from username input otherwise.

Deprecated : 06/04/2020 Use Linphone.Account object instead

Linphone.Address Linphone.ProxyConfig.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

username

the string to parse

Returns

null if invalid input, normalized sip address otherwise.

Deprecated : 06/04/2020 Use Linphone.Account object instead

void Linphone.ProxyConfig.PauseRegister ( )

inline

Prevent a proxy config 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 proxy configs to refresh their registrations. The refreshing operations can be resumed with Linphone.ProxyConfig.RefreshRegister().

Deprecated : 06/04/2020 Use Linphone.Account object instead

void Linphone.ProxyConfig.RefreshRegister ( )

inline

Refresh a proxy registration.

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

Deprecated : 06/04/2020 Use Linphone.Account object instead

void Linphone.ProxyConfig.SetCustomHeader ( string  headerName, string  headerValue  )

inline

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

Parameters

headerName	the header name
headerValue	the header's value

Deprecated : 06/04/2020 Use Linphone.Account object instead

Property Documentation

bool Linphone.ProxyConfig.AvpfEnabled

get

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

Returns

True if AVPF/SAVPF is enabled, false otherwise.

Deprecated : 06/04/2020 Use Linphone.Account object instead

Linphone.AVPFMode Linphone.ProxyConfig.AvpfMode

getset

Get enablement status of RTCP feedback (also known as AVPF profile).

Returns

the enablement mode, which can be Linphone.AVPFMode.Default (use LinphoneCore's mode), Linphone.AVPFMode.Enabled (avpf is enabled), or Linphone.AVPFMode.Disabled (disabled).

Deprecated : 06/04/2020 Use Linphone.Account object instead

uint Linphone.ProxyConfig.AvpfRrInterval

getset

Get the interval between regular RTCP reports when using AVPF/SAVPF.

Returns

The interval in seconds.

Deprecated : 06/04/2020 Use Linphone.Account object instead

string Linphone.ProxyConfig.ConferenceFactoryUri

getset

Get the conference factory uri.

Returns

The uri of the conference factory.

Deprecated : 06/04/2020 Use Linphone.Account object instead

Linphone.Address Linphone.ProxyConfig.Contact

get

Return the contact address of the proxy config.

Returns

a Linphone.Address correspong to the contact address of the proxy config.

Deprecated : 06/04/2020 Use Linphone.Account object instead

string Linphone.ProxyConfig.ContactParameters

getset

Returns the contact parameters.

Returns

previously set contact parameters.

Deprecated : 06/04/2020 Use Linphone.Account object instead

string Linphone.ProxyConfig.ContactUriParameters

getset

Returns the contact URI parameters.

Returns

previously set contact URI parameters.

Deprecated : 06/04/2020 Use Linphone.Account object instead

Linphone.Core Linphone.ProxyConfig.Core

get

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

Returns

The Linphone.Core object to which is associated the Linphone.ProxyConfig.

Deprecated : 06/04/2020 Use Linphone.Account object instead

Linphone.ProxyConfig Linphone.ProxyConfig.Dependency

getset

Get the dependency of a Linphone.ProxyConfig.

Returns

The proxy config this one is dependent upon, or null if not marked dependent.

Deprecated : 06/04/2020 Use Linphone.Account object instead

bool Linphone.ProxyConfig.DialEscapePlus

getset

Returns whether or not the + should be replaced by 00.

Returns

whether liblinphone should replace "+" by "00" in dialed numbers (passed to Linphone.Core.Invite()).

Deprecated : 06/04/2020 Use Linphone.Account object instead

string Linphone.ProxyConfig.DialPrefix

getset

Gets the prefix set for this proxy config.

Returns

dialing prefix.

Deprecated : 06/04/2020 Use Linphone.Account object instead

string Linphone.ProxyConfig.Domain

get

Get the domain name of the given proxy config.

Returns

The domain name of the proxy config.

Deprecated : 06/04/2020 Use Linphone.Account object instead

Linphone.Reason Linphone.ProxyConfig.Error

get

Get the reason why registration failed when the proxy config state is LinphoneRegistrationFailed.

Returns

The Linphone.Reason why registration failed for this proxy config.

Deprecated : 06/04/2020 Use Linphone.Account object instead

Linphone.ErrorInfo Linphone.ProxyConfig.ErrorInfo

get

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

Returns

The Linphone.ErrorInfo explaining why registration failed for this proxy config.

Deprecated : 06/04/2020 Use Linphone.Account object instead

int Linphone.ProxyConfig.Expires

getset

Gets the proxy config expires.

Returns

the duration of registration.

Deprecated : 06/04/2020 Use Linphone.Account object instead

Linphone.Address Linphone.ProxyConfig.IdentityAddress

getset

Gets the identity addres of the proxy config.

Returns

the SIP identity that belongs to this proxy configuration.

Deprecated : 06/04/2020 Use Linphone.Account object instead

string Linphone.ProxyConfig.Idkey

getset

Get the idkey property of a Linphone.ProxyConfig.

Returns

The idkey string, or null.

Deprecated : 06/04/2020 Use Linphone.Account object instead

bool Linphone.ProxyConfig.IsPushNotificationAllowed

get

Indicates whether to add to the contact parameters the push notification information.

For IOS, it indicates to VOIP push notification.

Returns

true if push notification informations should be added, false otherwise.

Deprecated : 06/04/2020 Use Linphone.Account object instead

bool Linphone.ProxyConfig.IsPushNotificationAvailable

get

Gets whether push notifications are available or not (Android & iOS only).

Returns

true if push notifications are available, false otherwise

Deprecated : 06/04/2020 Use Linphone.Account object instead

bool Linphone.ProxyConfig.IsRemotePushNotificationAllowed

get

Indicates whether to add to the contact parameters the remote push notification information (IOS only).

Default value is false.

Returns

true if remote push notification informations should be added, false otherwise.

Deprecated : 06/04/2020 Use Linphone.Account object instead

Linphone.NatPolicy Linphone.ProxyConfig.NatPolicy

getset

Get The policy that is used to pass through NATs/firewalls when using this proxy config.

If it is set to null, the default NAT policy from the core will be used instead.

Returns

Linphone.NatPolicy object in use.

See : Linphone.Core.NatPolicy

Deprecated : 06/04/2020 Use Linphone.Account object instead

uint Linphone.ProxyConfig.Privacy

getset

Get default privacy policy for all calls routed through this proxy.

Returns

Privacy mode as LinphonePrivacyMask

Deprecated : 06/04/2020 Use Linphone.Account object instead

bool Linphone.ProxyConfig.PublishEnabled

getset

Gets if the PUBLISH is enabled.

Returns

true if PUBLISH request is enabled for this proxy.

Deprecated : 06/04/2020 Use Linphone.Account object instead

int Linphone.ProxyConfig.PublishExpires

getset

get the publish expiration time in second.

Default value is the registration expiration value.

Returns

expires in second

Deprecated : 06/04/2020 Use Linphone.Account object instead

bool Linphone.ProxyConfig.PushNotificationAllowed

set

Indicates whether to add to the contact parameters the push notification information.

For IOS, it indicates to VOIP push notification.

Parameters

allow

true to allow push notification information, false otherwise.

Deprecated : 06/04/2020 Use Linphone.Account object instead

Linphone.PushNotificationConfig Linphone.ProxyConfig.PushNotificationConfig

getset

Retrieves the push notification configuration.

Returns

The Linphone.PushNotificationConfig.

Deprecated : 06/04/2020 Use Linphone.Account object instead

string Linphone.ProxyConfig.QualityReportingCollector

getset

Get the route of the collector end-point when using quality reporting.

This SIP address should be used on server-side to process packets directly before discarding packets. Collector address should be a non existing account and will not receive any messages. If null, reports will be send to the proxy domain.

Returns

The SIP address of the collector end-point.

Deprecated : 06/04/2020 Use Linphone.Account object instead

bool Linphone.ProxyConfig.QualityReportingEnabled

getset

Indicates whether quality statistics during call should be stored and sent to a collector according to RFC 6035.

Returns

True if quality repotring is enabled, false otherwise.

Deprecated : 06/04/2020 Use Linphone.Account object instead

int Linphone.ProxyConfig.QualityReportingInterval

getset

Get the interval between interval reports when using quality reporting.

Returns

The interval in seconds, 0 means interval reports are disabled.

Deprecated : 06/04/2020 Use Linphone.Account object instead

string Linphone.ProxyConfig.Realm

getset

Get the realm of the given proxy config.

Returns

The realm of the proxy config.

Deprecated : 06/04/2020 Use Linphone.Account object instead

string Linphone.ProxyConfig.RefKey

getset

Get the persistent reference key associated to the proxy config.

The reference key can be for example an id to an external database. It is stored in the config file, thus can survive to process exits/restarts.

Returns

The reference key string that has been associated to the proxy config, or null if none has been associated.

Deprecated : 06/04/2020 Use Linphone.Account object instead

bool Linphone.ProxyConfig.RegisterEnabled

getset

Returns whether the proxy config is enabled or not.

Returns

true if registration to the proxy is enabled.

Deprecated : 06/04/2020 Use Linphone.Account object instead

bool Linphone.ProxyConfig.RemotePushNotificationAllowed

set

Indicates whether to add to the contact parameters the remote push notification information (IOS only).

Parameters

allow

true to allow remote push notification information, false otherwise.

Deprecated : 06/04/2020 Use Linphone.Account object instead

string Linphone.ProxyConfig.Route

set

Sets a SIP route.

When a route is set, all outgoing calls will go to the route's destination if this proxy is the default one (see Linphone.Core.DefaultProxyConfig ).

Parameters

route

the SIP route to set

Returns

-1 if route is invalid, 0 otherwise.

Deprecated : 08/07/2020 use Linphone.ProxyConfig.Routes instead

IEnumerable<string> Linphone.ProxyConfig.Routes

getset

Gets the list of the routes set for this proxy config.

Returns

The list of routes as string. A list of const char * objects.

Deprecated : 06/04/2020 Use Linphone.Account object instead

string Linphone.ProxyConfig.ServerAddr

getset

Gets the proxy config proxy address.

Returns

the proxy's SIP address.

Deprecated : 06/04/2020 Use Linphone.Account object instead

Linphone.RegistrationState Linphone.ProxyConfig.State

get

Get the registration state of the given proxy config.

Returns

The Linphone.RegistrationState of the proxy config.

Deprecated : 06/04/2020 Use Linphone.Account object instead

string Linphone.ProxyConfig.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 : 06/04/2020 Use Linphone.Account object instead

int Linphone.ProxyConfig.UnreadChatMessageCount

get

Return the unread chat message count for a given proxy config.

Returns

The unread chat message count.

Deprecated : 06/04/2020 Use Linphone.Account object instead

---

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

• LinphoneWrapper.cs