AccountParams

public class AccountParams : LinphoneObject

Object that is used to set the different parameters of a Account.

  • Undocumented

    Declaration

    Swift

    public static func getSwiftObject(cObject: OpaquePointer) -> AccountParams
  • Undocumented

    Declaration

    Swift

    public var getCobject: OpaquePointer? { get }
  • Create a new AccountParams object from a configuration.

    Declaration

    Swift

    public static func newWithConfig(lc: Core, index: Int) -> AccountParams?

    Parameters

    lc

    The Core object.

    index

    The index of the configuration.

    Return Value

    The newly created AccountParams object.

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

    Declaration

    Swift

    public var avpfMode: AVPFMode { get set }

    Return Value

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

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

    Declaration

    Swift

    public var avpfRrInterval: UInt8 { get set }

    Return Value

    The interval in seconds.

  • Get the conference factory uri.

    Declaration

    Swift

    public var conferenceFactoryUri: String { get set }

    Return Value

    The uri of the conference factory.

  • Returns the contact parameters.

    Declaration

    Swift

    public var contactParameters: String { get set }

    Return Value

    The previously set contact parameters.

  • Return the contact URI parameters.

    Declaration

    Swift

    public var contactUriParameters: String { get set }

    Return Value

    The previously set contact URI parameters.

  • 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. - See also: https://wiki.linphone.org/xwiki/wiki/public/view/Lib/Features/Instant%20Messaging/Reply%20to%20a%20specific%20message/

    Declaration

    Swift

    public var cpimInBasicChatRoomEnabled: Bool { get set }

    Return Value

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

  • Return whether or not the + should be replaced by 00.

    Declaration

    Swift

    public var dialEscapePlusEnabled: Bool { get set }

    Return Value

    Whether liblinphone should replace “+” by “00” in dialed numbers (passed to Core.invite()).

  • Get the domain name of the given account params.

    Declaration

    Swift

    public var domain: String { get }

    Return Value

    The domain name of the account params.

  • Get the account params expires.

    Declaration

    Swift

    public var expires: Int { get set }

    Return Value

    The duration of registration.

  • Get the identity of the account params.

    • deprecated: 01/03/2021 Use getIdentityAddress() instead.

    Declaration

    Swift

    @available(*, deprecated)
    public var identity: String { get }

    Return Value

    The SIP identity that belongs to this account params.

  • Get the identity address of the account params.

    Declaration

    Swift

    public var identityAddress: Address? { get }

    Return Value

    The SIP identity that belongs to this account params.

  • Undocumented

    Declaration

    Swift

    public func setIdentityaddress(newValue: Address) throws
  • Get the idkey property of a AccountParams.

    Declaration

    Swift

    public var idkey: String { get set }

    Return Value

    The idkey string, or nil.

  • Get the prefix set for this account params.

    Declaration

    Swift

    public var internationalPrefix: String { get set }

    Return Value

    The international prefix.

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

    Declaration

    Swift

    public var isPushNotificationAvailable: Bool { get }

    Return Value

    true if push notifications are available, false otherwise

  • Get The policy that is used to pass through NATs/firewalls when using this account params. If it is set to nil, the default NAT policy from the core will be used instead.

    See

    See also: Core.getNatPolicy()

    Declaration

    Swift

    public var natPolicy: NatPolicy? { get set }

    Return Value

    The NatPolicy object in use.

  • Tell if the proxy is used as the only route.

    Declaration

    Swift

    public var outboundProxyEnabled: Bool { get set }

    Return Value

    enable true if enabled, false otherwise.

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

    Declaration

    Swift

    public var privacy: UInt { get set }

    Return Value

    Privacy mode as LinphonePrivacyMask

  • Tell if the PUBLISH is enabled.

    Declaration

    Swift

    public var publishEnabled: Bool { get set }

    Return Value

    true if PUBLISH request is enabled for this proxy.

  • Get the publish expiration time in second. Default value is the registration expiration value.

    Declaration

    Swift

    public var publishExpires: Int { get set }

    Return Value

    The expire time in seconds.

  • Indicates whether to add to the contact parameters the push notification information. For IOS, it indicates for VOIP push notification.

    Declaration

    Swift

    public var pushNotificationAllowed: Bool { get set }

    Return Value

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

  • Returns the push notification configuration.

    Declaration

    Swift

    public var pushNotificationConfig: PushNotificationConfig? { get set }

    Return Value

    The PushNotificationConfig object.

  • 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 nil, reports will be send to the proxy domain.

    Declaration

    Swift

    public var qualityReportingCollector: String { get set }

    Return Value

    The SIP address of the collector end-point.

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

    Declaration

    Swift

    public var qualityReportingEnabled: Bool { get set }

    Return Value

    true if quality repotring is enabled, false otherwise.

  • Get the interval between interval reports when using quality reporting.

    Declaration

    Swift

    public var qualityReportingInterval: Int { get set }

    Return Value

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

  • Get the realm of the given account params.

    Declaration

    Swift

    public var realm: String { get set }

    Return Value

    The realm of the account params.

  • 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

    Swift

    public var refKey: String { get set }

    Return Value

    The reference key string that has been associated to the account params, or nil if none has been associated.

  • Returns whether the account params is enabled or not.

    Declaration

    Swift

    public var registerEnabled: Bool { get set }

    Return Value

    true if registration to the proxy is enabled.

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

    Declaration

    Swift

    public var remotePushNotificationAllowed: Bool { get set }

    Return Value

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

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

    Warning

    If linphone_account_params_is_outbound_proxy_enabled is true then it will only return the proxy address.

    Declaration

    Swift

    public var routesAddresses: [Address] { get }

    Return Value

    The list of routes.

  • Undocumented

    Declaration

    Swift

    public func setRoutesaddresses(newValue: [Address]) throws
  • Get the account params proxy address.

    • deprecated: 01/03/2021 Use getServerAddress() instead.

    Declaration

    Swift

    @available(*, deprecated)
    public var serverAddr: String { get }

    Return Value

    The proxy’s SIP address.

  • Undocumented

    Declaration

    Swift

    public func setServeraddr(newValue: String) throws
  • Get the account params proxy address.

    Declaration

    Swift

    public var serverAddress: Address? { get }

    Return Value

    The proxy’s SIP Address.

  • Undocumented

    Declaration

    Swift

    public func setServeraddress(newValue: Address) throws
  • Returns the transport type of the server address.

    Declaration

    Swift

    public var transport: TransportType { get set }

    Return Value

    The TransportType of the server address.

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

    Declaration

    Swift

    public var useInternationalPrefixForCallsAndChats: Bool { get set }

    Return Value

    Whether we should use international prefix automatically for calls.

  • Retrieve the user pointer associated with the account params.

    Declaration

    Swift

    public var userData: UnsafeMutableRawPointer? { get set }

    Return Value

    The user data.

  • Instantiate a new account params with values from source.

    Declaration

    Swift

    public func clone() -> AccountParams?

    Return Value

    The newly created AccountParams object.