Class AccountParams
Object that is used to set the different parameters of a Account.
Note that authenticated accounts should have a corresponding AuthInfo added to the Core to register properly.
Inherited Members
Namespace: Linphone
Assembly: cs.temp.dll.dll
Syntax
public class AccountParams : LinphoneObject
Properties
AudioVideoConferenceFactoryAddress
Get the audio video conference factory uri.
Declaration
public Address AudioVideoConferenceFactoryAddress { get; set; }
Property Value
Type | Description |
---|---|
Address | The Address of the audio video conference factory. |
AvpfMode
Get enablement status of RTCP feedback (also known as AVPF profile).
Declaration
public AVPFMode AvpfMode { get; set; }
Property Value
Type | Description |
---|---|
AVPFMode | the enablement mode, which can be Default (use LinphoneCore's mode), Enabled (avpf is enabled), or Disabled (disabled). |
AvpfRrInterval
Get the interval between regular RTCP reports when using AVPF/SAVPF.
Declaration
public uint AvpfRrInterval { get; set; }
Property Value
Type | Description |
---|---|
System.UInt32 | The interval in seconds. |
ConferenceFactoryAddress
Get the conference factory uri.
Declaration
public Address ConferenceFactoryAddress { get; set; }
Property Value
Type | Description |
---|---|
Address | The Address of the conference factory. |
ConferenceFactoryUri
Get the conference factory uri.
Declaration
public string ConferenceFactoryUri { get; set; }
Property Value
Type | Description |
---|---|
System.String | The uri of the conference factory. |
ContactParameters
Returns the contact parameters.
Declaration
public string ContactParameters { get; set; }
Property Value
Type | Description |
---|---|
System.String | The previously set contact parameters. |
ContactUriParameters
Return the contact URI parameters.
Declaration
public string ContactUriParameters { get; set; }
Property Value
Type | Description |
---|---|
System.String | The previously set contact URI parameters. |
CpimInBasicChatRoomEnabled
Indicates whether chat messages sent by this account in a 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 FlexisipChat chat rooms.
Declaration
public bool CpimInBasicChatRoomEnabled { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | true if chat messages will be sent out in CPIM format, false if chat messages will be sent out as SIP SIMPLE. |
Remarks
CustomContact
Get the custom contact address previously used when registering to the SIP server.
Declaration
public Address CustomContact { get; set; }
Property Value
Type | Description |
---|---|
Address | a Address |
DialEscapePlusEnabled
Return whether or not the + should be replaced by 00.
Declaration
public bool DialEscapePlusEnabled { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | Whether liblinphone should replace "+" by "00" in
dialed numbers (passed to |
Domain
Get the domain name of the given account params.
Declaration
public string Domain { get; }
Property Value
Type | Description |
---|---|
System.String | The domain name of the account params. |
Expires
Get the account params expires.
Declaration
public int Expires { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 | The duration of registration. |
Identity
Get the identity of the account params.
Declaration
public string Identity { get; }
Property Value
Type | Description |
---|---|
System.String | The SIP identity that belongs to this account params. |
IdentityAddress
Get the identity address of the account params.
Declaration
public Address IdentityAddress { get; set; }
Property Value
Type | Description |
---|---|
Address | The SIP identity that belongs to this account params. |
Idkey
Get the idkey property of a AccountParams.
Declaration
public string Idkey { get; set; }
Property Value
Type | Description |
---|---|
System.String | The idkey string, or null. |
InternationalPrefix
Gets the prefix set for this account params.
Declaration
public string InternationalPrefix { get; set; }
Property Value
Type | Description |
---|---|
System.String | The international prefix if set, null otherwise. |
InternationalPrefixIsoCountryCode
Gets the ISO country code set for the international prefix in this account params.
Declaration
public string InternationalPrefixIsoCountryCode { get; set; }
Property Value
Type | Description |
---|---|
System.String | The international prefix ISO country code if set, null otherwise. |
IsPushNotificationAvailable
Gets whether push notifications are available or not (Android & iOS only).
Declaration
public bool IsPushNotificationAvailable { get; }
Property Value
Type | Description |
---|---|
System.Boolean | true if push notifications are available, false otherwise |
LimeServerUrl
Get the x3dh server url.
Declaration
public string LimeServerUrl { get; set; }
Property Value
Type | Description |
---|---|
System.String | The x3dh server url. |
MwiServerAddress
Get the Message Waiting Indication server address.
Declaration
public Address MwiServerAddress { get; set; }
Property Value
Type | Description |
---|---|
Address | The Message Waiting Indication server address. |
NatPolicy
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.
Declaration
public NatPolicy NatPolicy { get; set; }
Property Value
Type | Description |
---|---|
NatPolicy | The NatPolicy object in use. |
Remarks
See : NatPolicy
OutboundProxyEnabled
Tell if the proxy is used as the only route.
Declaration
public bool OutboundProxyEnabled { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | enable true if enabled, false otherwise. |
PictureUri
Gets the account picture URI if set, null otherwise.
Declaration
public string PictureUri { get; set; }
Property Value
Type | Description |
---|---|
System.String | The account picture URI. |
Privacy
Get default privacy policy for all calls routed through this proxy.
Declaration
public uint Privacy { get; set; }
Property Value
Type | Description |
---|---|
System.UInt32 | Privacy mode as LinphonePrivacyMask |
PublishEnabled
Tell if the PUBLISH is enabled.
Declaration
public bool PublishEnabled { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | true if PUBLISH request is enabled for this proxy. |
PublishExpires
Get the publish expiration time in second.
Default value is the registration expiration value.
Declaration
public int PublishExpires { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 | The expire time in seconds. |
PushNotificationAllowed
Indicates whether to add to the contact parameters the push notification information.
For IOS, it indicates for VOIP push notification.
Declaration
public bool PushNotificationAllowed { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | true if push notification informations should be added, false otherwise. |
PushNotificationConfig
Returns the push notification configuration.
Declaration
public PushNotificationConfig PushNotificationConfig { get; set; }
Property Value
Type | Description |
---|---|
PushNotificationConfig | The PushNotificationConfig object. |
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
public string QualityReportingCollector { get; set; }
Property Value
Type | Description |
---|---|
System.String | The SIP address of the collector end-point. |
QualityReportingEnabled
Indicates whether quality statistics during call should be stored and sent to a collector according to RFC 6035.
Declaration
public bool QualityReportingEnabled { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | true if quality repotring is enabled, false otherwise. |
QualityReportingInterval
Get the interval between interval reports when using quality reporting.
Declaration
public int QualityReportingInterval { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 | The interval in seconds, 0 means interval reports are disabled. |
Realm
Get the realm of the given account params.
Declaration
public string Realm { get; set; }
Property Value
Type | Description |
---|---|
System.String | The realm of the account params. |
RefKey
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.
Declaration
public string RefKey { get; set; }
Property Value
Type | Description |
---|---|
System.String | The reference key string that has been associated to the account params, or null if none has been associated. |
RegisterEnabled
Returns whether the account params is enabled or not.
Declaration
public bool RegisterEnabled { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | true if registration to the proxy is enabled. |
RemotePushNotificationAllowed
Indicates whether to add to the contact parameters the push notification information.
Declaration
public bool RemotePushNotificationAllowed { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | true if remote push notification informations should be added, false otherwise. |
RoutesAddresses
Gets the list of the routes set for this account params.
Declaration
public IEnumerable<Address> RoutesAddresses { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<Address> | The list of routes. |
Remarks
Warning : If linphone_account_params_is_outbound_proxy_enabled is true then it will only return the proxy address.
RtpBundleAssumptionEnabled
Returns whether RTP bundle mode is assumed.
See https://datatracker.ietf.org/doc/html/rfc8843 for more information.
Declaration
public bool RtpBundleAssumptionEnabled { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | a boolean indicating when rtp bundle support is assumed. |
RtpBundleEnabled
Returns whether RTP bundle mode (also known as Media Multiplexing) is enabled.
See https://datatracker.ietf.org/doc/html/rfc8843 for more information.
Declaration
public bool RtpBundleEnabled { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | a boolean indicating the enablement of rtp bundle mode. |
ServerAddr
Get the account params proxy address.
Declaration
public string ServerAddr { get; set; }
Property Value
Type | Description |
---|---|
System.String | The proxy's SIP address. |
ServerAddress
Get the account params proxy address.
Declaration
public Address ServerAddress { get; set; }
Property Value
Type | Description |
---|---|
Address | The proxy's SIP Address. |
Transport
Returns the transport type of the server address.
Declaration
public TransportType Transport { get; set; }
Property Value
Type | Description |
---|---|
TransportType | The TransportType of the server address. |
UseInternationalPrefixForCallsAndChats
Return whether or not the international prefix will automaticaly be used for calls and chats.
Declaration
public bool UseInternationalPrefixForCallsAndChats { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | Whether we should use international prefix automatically for calls. |
Methods
AddCustomParam(String, String)
Set one custom parameter to this AccountParams.
Declaration
public void AddCustomParam(string key, string val)
Parameters
Type | Name | Description |
---|---|---|
System.String | key | key of the searched parameter. |
System.String | val | value of the searched parameter. |
Clone()
Instantiate a new account params with values from source.
Declaration
public AccountParams Clone()
Returns
Type | Description |
---|---|
AccountParams | The newly created AccountParams object. |
GetCustomParam(String)
Get the custom parameter with key to this AccountParams.
Declaration
public string GetCustomParam(string key)
Parameters
Type | Name | Description |
---|---|---|
System.String | key | key of the searched parameter. |
Returns
Type | Description |
---|---|
System.String | The value of the parameter with key if found or an empty string otherwise. |
NewWithConfig(Core, Int32)
Create a new AccountParams object from a configuration.
Declaration
public static AccountParams NewWithConfig(Core lc, int index)
Parameters
Type | Name | Description |
---|---|---|
Core | lc | The Core object. |
System.Int32 | index | The index of the configuration. |
Returns
Type | Description |
---|---|
AccountParams | The newly created AccountParams object. |