Class ProxyConfig

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:username@domain.tld) and the proxy server address,

Inheritance
System.Object
LinphoneObject
ProxyConfig
Inherited Members
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 ProxyConfig : LinphoneObject
Remarks

See : Linphone.ProxyConfig.ServerAddr.

Properties

AvpfEnabled

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

Declaration
[Obsolete]
public bool AvpfEnabled { get; }
Property Value
Type Description
System.Boolean

True if AVPF/SAVPF is enabled, false otherwise.
Remarks

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

AvpfMode

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

Declaration
[Obsolete]
public AVPFMode AvpfMode { get; set; }
Property Value
Type Description
AVPFMode

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

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

AvpfRrInterval

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

Declaration
[Obsolete]
public uint AvpfRrInterval { get; set; }
Property Value
Type Description
System.UInt32

The interval in seconds.
Remarks

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

ConferenceFactoryUri

Get the conference factory uri.

Declaration
[Obsolete]
public string ConferenceFactoryUri { get; set; }
Property Value
Type Description
System.String

The uri of the conference factory. @maybenil
Remarks

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

Contact

Return the contact address of the proxy config.

Declaration
[Obsolete]
public Address Contact { get; }
Property Value
Type Description
Address

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

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

ContactParameters

Returns the contact parameters.

Declaration
[Obsolete]
public string ContactParameters { get; set; }
Property Value
Type Description
System.String

previously set contact parameters. @maybenil
Remarks

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

ContactUriParameters

Returns the contact URI parameters.

Declaration
[Obsolete]
public string ContactUriParameters { get; set; }
Property Value
Type Description
System.String

previously set contact URI parameters. @maybenil
Remarks

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

Core

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

Declaration
[Obsolete]
public Core Core { get; }
Property Value
Type Description
Core

The Linphone.Core object to which is associated the Linphone.ProxyConfig. @notnil
Remarks

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

Dependency

Get the dependency of a Linphone.ProxyConfig.

Declaration
[Obsolete]
public ProxyConfig Dependency { get; set; }
Property Value
Type Description
ProxyConfig

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

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

DialEscapePlus

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

Declaration
[Obsolete]
public bool DialEscapePlus { get; set; }
Property Value
Type Description
System.Boolean

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

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

DialPrefix

Gets the prefix set for this proxy config.

Declaration
[Obsolete]
public string DialPrefix { get; set; }
Property Value
Type Description
System.String

dialing prefix. @maybenil
Remarks

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

Domain

Get the domain name of the given proxy config.

Declaration
[Obsolete]
public string Domain { get; }
Property Value
Type Description
System.String

The domain name of the proxy config. @maybenil
Remarks

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

Error

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

Declaration
[Obsolete]
public Reason Error { get; }
Property Value
Type Description
Reason

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

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

ErrorInfo

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

Declaration
[Obsolete]
public ErrorInfo ErrorInfo { get; }
Property Value
Type Description
ErrorInfo

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

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

Expires

Gets the proxy config expires.

Declaration
[Obsolete]
public int Expires { get; set; }
Property Value
Type Description
System.Int32

the duration of registration.
Remarks

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

IdentityAddress

Gets the identity addres of the proxy config.

Declaration
[Obsolete]
public Address IdentityAddress { get; set; }
Property Value
Type Description
Address

the SIP identity that belongs to this proxy configuration. @maybenil
Remarks

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

Idkey

Get the idkey property of a Linphone.ProxyConfig.

Declaration
[Obsolete]
public string Idkey { get; set; }
Property Value
Type Description
System.String

The idkey string, or null. @maybenil
Remarks

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

IsPushNotificationAllowed

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

For IOS, it indicates to VOIP push notification.

Declaration
[Obsolete]
public bool IsPushNotificationAllowed { get; }
Property Value
Type Description
System.Boolean

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

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

IsPushNotificationAvailable

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

Declaration
[Obsolete]
public bool IsPushNotificationAvailable { get; }
Property Value
Type Description
System.Boolean

true if push notifications are available, false otherwise
Remarks

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

IsRemotePushNotificationAllowed

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

Default value is false.

Declaration
[Obsolete]
public bool IsRemotePushNotificationAllowed { get; }
Property Value
Type Description
System.Boolean

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

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

NatPolicy

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.

Declaration
[Obsolete]
public NatPolicy NatPolicy { get; set; }
Property Value
Type Description
NatPolicy

Linphone.NatPolicy object in use. @maybenil
Remarks

See : Linphone.Core.NatPolicy

Privacy

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

Declaration
[Obsolete]
public uint Privacy { get; set; }
Property Value
Type Description
System.UInt32

Privacy mode as LinphonePrivacyMask
Remarks

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

PublishEnabled

Gets if the PUBLISH is enabled.

Declaration
[Obsolete]
public bool PublishEnabled { get; set; }
Property Value
Type Description
System.Boolean

true if PUBLISH request is enabled for this proxy.
Remarks

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

PublishExpires

get the publish expiration time in second.

Default value is the registration expiration value.

Declaration
[Obsolete]
public int PublishExpires { get; set; }
Property Value
Type Description
System.Int32

expires in second
Remarks

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

PushNotificationAllowed

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

For IOS, it indicates to VOIP push notification.

Declaration
[Obsolete]
public bool PushNotificationAllowed { set; }
Property Value
Type Description
System.Boolean
Remarks

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

PushNotificationConfig

Retrieves the push notification configuration.

Declaration
[Obsolete]
public PushNotificationConfig PushNotificationConfig { get; set; }
Property Value
Type Description
PushNotificationConfig

The Linphone.PushNotificationConfig. @notnil
Remarks

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

QualityReportingCollector

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.

Declaration
[Obsolete]
public string QualityReportingCollector { get; set; }
Property Value
Type Description
System.String

The SIP address of the collector end-point. @maybenil
Remarks

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

QualityReportingEnabled

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

Declaration
[Obsolete]
public bool QualityReportingEnabled { get; set; }
Property Value
Type Description
System.Boolean

True if quality repotring is enabled, false otherwise.
Remarks

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

QualityReportingInterval

Get the interval between interval reports when using quality reporting.

Declaration
[Obsolete]
public int QualityReportingInterval { get; set; }
Property Value
Type Description
System.Int32

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

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

Realm

Get the realm of the given proxy config.

Declaration
[Obsolete]
public string Realm { get; set; }
Property Value
Type Description
System.String

The realm of the proxy config. @maybenil
Remarks

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

RefKey

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.

Declaration
[Obsolete]
public string RefKey { get; set; }
Property Value
Type Description
System.String

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

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

RegisterEnabled

Returns whether the proxy config is enabled or not.

Declaration
[Obsolete]
public bool RegisterEnabled { get; set; }
Property Value
Type Description
System.Boolean

true if registration to the proxy is enabled.
Remarks

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

RemotePushNotificationAllowed

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

Declaration
[Obsolete]
public bool RemotePushNotificationAllowed { set; }
Property Value
Type Description
System.Boolean
Remarks

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

Route

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 ).

Declaration
[Obsolete]
public string Route { set; }
Property Value
Type Description
System.String

-1 if route is invalid, 0 otherwise.
Remarks

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

Routes

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

Declaration
[Obsolete]
public IEnumerable<string> Routes { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<System.String>

The list of routes as string. @maybenil
Remarks

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

ServerAddr

Gets the proxy config proxy address.

Declaration
[Obsolete]
public string ServerAddr { get; set; }
Property Value
Type Description
System.String

the proxy's SIP address. @maybenil
Remarks

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

State

Get the registration state of the given proxy config.

Declaration
[Obsolete]
public RegistrationState State { get; }
Property Value
Type Description
RegistrationState

The Linphone.RegistrationState of the proxy config.
Remarks

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

Transport

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

Declaration
[Obsolete]
public string Transport { get; }
Property Value
Type Description
System.String

The transport as a string (I.E udp, tcp, tls, dtls) @notnil
Remarks

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

UnreadChatMessageCount

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

Declaration
[Obsolete]
public int UnreadChatMessageCount { get; }
Property Value
Type Description
System.Int32

The unread chat message count.
Remarks

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

Methods

Done()

Commits modification made to the proxy configuration.

Declaration
[Obsolete]
public void Done()
Remarks

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

Edit()

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.

Declaration
[Obsolete]
public void Edit()
Remarks

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

FindAuthInfo()

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

Declaration
[Obsolete]
public AuthInfo FindAuthInfo()
Returns
Type Description
AuthInfo

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

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

GetCustomHeader(String)

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

Declaration
[Obsolete]
public string GetCustomHeader(string headerName)
Parameters
Type Name Description
System.String headerName

the header name for which to fetch corresponding value @notnil
Returns
Type Description
System.String

the value of the queried header. @maybenil
Remarks

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

NormalizePhoneNumber(String)

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.

Declaration
[Obsolete]
public string NormalizePhoneNumber(string username)
Parameters
Type Name Description
System.String username

the string to parse @notnil
Returns
Type Description
System.String

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

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

NormalizeSipUri(String)

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

A sip address should look like DisplayName <sip:username@domain: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.

Declaration
[Obsolete]
public Address NormalizeSipUri(string username)
Parameters
Type Name Description
System.String username

the string to parse @notnil
Returns
Type Description
Address

null if invalid input, normalized sip address otherwise. @maybenil
Remarks

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

PauseRegister()

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().

Declaration
[Obsolete]
public void PauseRegister()
Remarks

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

RefreshRegister()

Refresh a proxy registration.

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

Declaration
[Obsolete]
public void RefreshRegister()
Remarks

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

SetCustomHeader(String, String)

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

Declaration
[Obsolete]
public void SetCustomHeader(string headerName, string headerValue)
Parameters
Type Name Description
System.String headerName

the header name @notnil
System.String headerValue

the header's value @maybenil
Remarks

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