Inheritance diagram for Linphone.AccountParams:

Public Member Functions
void	AddCustomParam (string key, string val)

Linphone.AccountParams	Clone ()

string	GetCustomParam (string key)

Static Public Member Functions
static Linphone.AccountParams	NewWithConfig (Linphone.Core lc, int index)

Properties
Linphone.Address	AudioVideoConferenceFactoryAddress `[get, set]`

Linphone.AVPFMode	AvpfMode `[get, set]`

uint	AvpfRrInterval `[get, set]`

string	CcmpServerUrl `[get, set]`

string	CcmpUserId `[get]`

Linphone.Address	ConferenceFactoryAddress `[get, set]`

string	ConferenceFactoryUri `[get, set]`

string	ContactParameters `[get, set]`

string	ContactUriParameters `[get, set]`

bool	CpimInBasicChatRoomEnabled `[get, set]`

Linphone.Address	CustomContact `[get, set]`

bool	DialEscapePlusEnabled `[get, set]`

string	Domain `[get]`

int	Expires `[get, set]`

string	Identity `[get]`

Linphone.Address	IdentityAddress `[get, set]`

string	Idkey `[get, set]`

bool	InstantMessagingEncryptionMandatory `[get, set]`

string	InternationalPrefix `[get, set]`

string	InternationalPrefixIsoCountryCode `[get, set]`

bool	IsPushNotificationAvailable `[get]`

string	LimeAlgo `[get, set]`

string	LimeServerUrl `[get, set]`

Linphone.Address	MwiServerAddress `[get, set]`

Linphone.NatPolicy	NatPolicy `[get, set]`

bool	OutboundProxyEnabled `[get, set]`

string	PictureUri `[get, set]`

uint	Privacy `[get, set]`

bool	PublishEnabled `[get, set]`

int	PublishExpires `[get, set]`

bool	PushNotificationAllowed `[get, 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 `[get, set]`

IEnumerable< Linphone.Address >	RoutesAddresses `[get, set]`

bool	RtpBundleAssumptionEnabled `[get, set]`

bool	RtpBundleEnabled `[get, set]`

string	ServerAddr `[get, set]`

Linphone.Address	ServerAddress `[get, set]`

IEnumerable< string >	SupportedTagsList `[get, set]`

Linphone.TransportType	Transport `[get, set]`

bool	UnregisterAtStopEnabled `[get, set]`

bool	UseInternationalPrefixForCallsAndChats `[get, set]`

Linphone.Address	VoicemailAddress `[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 that is used to set the different parameters of a Linphone.Account.

Note that authenticated accounts should have a corresponding Linphone.AuthInfo added to the Linphone.Core to register properly.

Member Function Documentation

void Linphone.AccountParams.AddCustomParam	(	string	key,
		string	val
	)

inline

Set one custom parameter to this Linphone.AccountParams.

Parameters

key	key of the searched parameter.
val	value of the searched parameter.

Linphone.AccountParams Linphone.AccountParams.Clone ( )

inline

Instantiate a new account params with values from source.

Returns: The newly created Linphone.AccountParams object.

string Linphone.AccountParams.GetCustomParam ( string key )

inline

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

Parameters

key	key of the searched parameter.

Returns: The value of the parameter with key if found or an empty string otherwise.

static Linphone.AccountParams Linphone.AccountParams.NewWithConfig	(	Linphone.Core	lc,
		int	index
	)

inlinestatic

Create a new Linphone.AccountParams object from a configuration.

Parameters

lc	The Linphone.Core object.
index	The index of the configuration.

Returns: The newly created Linphone.AccountParams object.

Property Documentation

Linphone.Address Linphone.AccountParams.AudioVideoConferenceFactoryAddress

getset

Get the audio video conference factory uri.

Returns: The Linphone.Address of the audio video conference factory.

Linphone.AVPFMode Linphone.AccountParams.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).

uint Linphone.AccountParams.AvpfRrInterval

getset

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

Returns: The interval in seconds.

string Linphone.AccountParams.CcmpServerUrl

getset

Get the CCMP server address.

Returns: The URL of the CCMP server.

string Linphone.AccountParams.CcmpUserId

get

Get the CCMP user ID.

Returns: The ID of the CCMP user.

Linphone.Address Linphone.AccountParams.ConferenceFactoryAddress

getset

Get the conference factory uri.

Returns: The Linphone.Address of the conference factory.

string Linphone.AccountParams.ConferenceFactoryUri

getset

Get the conference factory uri.

Returns: The uri of the conference factory.

string Linphone.AccountParams.ContactParameters

getset

Returns the contact parameters.

Returns: The previously set contact parameters.

string Linphone.AccountParams.ContactUriParameters

getset

Return the contact URI parameters.

Returns: The previously set contact URI parameters.

bool Linphone.AccountParams.CpimInBasicChatRoomEnabled

getset

Indicates whether chat messages sent by this account in a Linphone.ChatRoomBackend.Basic chat room will be using CPIM format or not.

By default SIP SIMPLE format is used for "basic" chat rooms, CPIM is only used for Linphone.ChatRoomBackend.FlexisipChat chat rooms.

See : https://wiki.linphone.org/xwiki/wiki/public/view/Lib/Features/Instant%20Messaging/Reply%20to%20a%20specific%20message/

Returns: true if chat messages will be sent out in CPIM format, false if chat messages will be sent out as SIP SIMPLE.

Linphone.Address Linphone.AccountParams.CustomContact

getset

Get the custom contact address previously used when registering to the SIP server.

Returns: a Linphone.Address

bool Linphone.AccountParams.DialEscapePlusEnabled

getset

Return whether or not the + should be replaced by the International Call Prefix.

Returns: Whether liblinphone should replace "+" by the International Call Prefix. in dialed numbers (passed to Linphone.Core.Invite()).

string Linphone.AccountParams.Domain

get

Get the domain name of the given account params.

Returns: The domain name of the account params.

int Linphone.AccountParams.Expires

getset

Get the account params expires.

Returns: The duration of registration.

string Linphone.AccountParams.Identity

get

Get the identity of the account params.

Returns: The SIP identity that belongs to this account params.

Deprecated : 01/03/2021 Use Linphone.AccountParams.IdentityAddress instead.

Linphone.Address Linphone.AccountParams.IdentityAddress

getset

Get the identity address of the account params.

Returns: The SIP identity that belongs to this account params.

string Linphone.AccountParams.Idkey

getset

Get the idkey property of a Linphone.AccountParams.

Returns: The idkey string, or null.

bool Linphone.AccountParams.InstantMessagingEncryptionMandatory

getset

Checks if encryption is mandatory for instant messages or not.

Returns: true if encryption is mandatory; false otherwise.

string Linphone.AccountParams.InternationalPrefix

getset

Gets the prefix set for this account params.

Returns: The international prefix if set, null otherwise.

string Linphone.AccountParams.InternationalPrefixIsoCountryCode

getset

Gets the ISO country code set for the international prefix in this account params.

Returns: The international prefix ISO country code if set, null otherwise.

bool Linphone.AccountParams.IsPushNotificationAvailable

get

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

Returns: true if push notifications are available, false otherwise

string Linphone.AccountParams.LimeAlgo

getset

Get the base x3dh algorithm.

Returns: The x3dh base algorithm.

string Linphone.AccountParams.LimeServerUrl

getset

Get the x3dh server url.

Returns: The x3dh server url.

Linphone.Address Linphone.AccountParams.MwiServerAddress

getset

Gets the Message Waiting Indication server address.

Returns: The Message Waiting Indication server address.

Linphone.NatPolicy Linphone.AccountParams.NatPolicy

getset

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

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

Returns: The Linphone.NatPolicy object in use.

See : Linphone.Core.NatPolicy

bool Linphone.AccountParams.OutboundProxyEnabled

getset

Tell if the proxy is used as the only route.

Returns: enable true if enabled, false otherwise.

string Linphone.AccountParams.PictureUri

getset

Gets the account picture URI if set, null otherwise.

Returns: The account picture URI.

uint Linphone.AccountParams.Privacy

getset

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

Returns: Privacy mode as LinphonePrivacyMask

bool Linphone.AccountParams.PublishEnabled

getset

Tell if the PUBLISH is enabled.

Returns: true if PUBLISH request is enabled for this proxy.

int Linphone.AccountParams.PublishExpires

getset

Get the publish expiration time in second.

Default value is the registration expiration value.

Returns: The expire time in seconds.

bool Linphone.AccountParams.PushNotificationAllowed

getset

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

For IOS, it indicates for VOIP push notification.

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

Linphone.PushNotificationConfig Linphone.AccountParams.PushNotificationConfig

getset

Returns the push notification configuration.

Returns: The Linphone.PushNotificationConfig object.

string Linphone.AccountParams.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.

bool Linphone.AccountParams.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.

int Linphone.AccountParams.QualityReportingInterval

getset

Get the interval between interval reports when using quality reporting.

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

string Linphone.AccountParams.Realm

getset

Get the realm of the given account params.

This is optional, but recommended as it allows digest authentication context to be re-used accross subsequent SIP requests, which reduces by almost half the number of SIP rmessages exchanged between a client and a server. The server is required to support the qop=auth digest authentication mode to benefit from this feature.

See : rfc7616 https://datatracker.ietf.org/doc/html/rfc7616

Returns: The realm of the account params.

string Linphone.AccountParams.RefKey

getset

Get the persistent reference key associated to the account params.

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 account params, or null if none has been associated.

bool Linphone.AccountParams.RegisterEnabled

getset

Returns whether the account params is enabled or not.

Returns: true if registration to the proxy is enabled.

bool Linphone.AccountParams.RemotePushNotificationAllowed

getset

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

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

IEnumerable<Linphone.Address> Linphone.AccountParams.RoutesAddresses

getset

Gets the list of the routes set for this account params.

Returns: The list of routes. A list of Linphone.Address objects.

bool Linphone.AccountParams.RtpBundleAssumptionEnabled

getset

Returns whether RTP bundle mode is assumed.

See https://datatracker.ietf.org/doc/html/rfc8843 for more information. See https://datatracker.ietf.org/doc/html/rfc8843 for more information.

Returns: a boolean indicating when rtp bundle support is assumed.

bool Linphone.AccountParams.RtpBundleEnabled

getset

Returns whether RTP bundle mode (also known as Media Multiplexing) is enabled.

See https://datatracker.ietf.org/doc/html/rfc8843 for more information. See https://datatracker.ietf.org/doc/html/rfc8843 for more information.

Returns: a boolean indicating the enablement of rtp bundle mode.

string Linphone.AccountParams.ServerAddr

getset

Get the account params proxy address.

Returns: The proxy's SIP address.

Deprecated : 01/03/2021 Use Linphone.AccountParams.ServerAddress instead.

Linphone.Address Linphone.AccountParams.ServerAddress

getset

Get the account params SIP proxy or registrar address.

Returns: The proxy's SIP Linphone.Address.

IEnumerable<string> Linphone.AccountParams.SupportedTagsList

getset

Gets the list of supported tags.

Returns: The list of supported tags A list of char * objects. .

Linphone.TransportType Linphone.AccountParams.Transport

getset

Returns the transport type of the server address.

Returns: The Linphone.TransportType of the server address.

bool Linphone.AccountParams.UnregisterAtStopEnabled

getset

Gets whether the account will unREGISTER when the core stops but only if the push notifications are not allowed for the account.

Returns: true if the account will unREGISTER at stop, false otherwise.

bool Linphone.AccountParams.UseInternationalPrefixForCallsAndChats

getset

Return whether or not the international prefix will automaticaly be used for calls and chats.

Returns: Whether we should use international prefix automatically for calls.

Linphone.Address Linphone.AccountParams.VoicemailAddress

getset

Gets the Voicemail address.

Returns: The Voicemail address.

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

LinphoneWrapper.cs

Public Member Functions

Static Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation