LdapParams

public class LdapParams : LinphoneObject

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

  • Undocumented

    Declaration

    Swift

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

    Declaration

    Swift

    public var getCobject: OpaquePointer? { get }
  • Authentification method. Check LdapAuthMethod for authentification values. Default value : LinphoneLdapAuthMethodSimple

    Declaration

    Swift

    public var authMethod: LdapAuthMethod { get set }

    Parameters

    authMethod

    The LdapAuthMethod. Get the authentification method. Check LdapAuthMethod for authentification values.

    Return Value

    The LdapAuthMethod.

  • BaseObject is a specification for LDAP Search Scopes that specifies that the Search Request should only be performed against the entry specified as the search base DN. No entries above it will be considered. This field is required. Default value : “dc=example,dc=com”

    Declaration

    Swift

    public var baseObject: String { get set }

    Parameters

    baseObject

    The specification.
    Get the BaseObject. It is a specification for LDAP Search Scopes that specifies that the Search Request should only be performed against the entry specified as the search base DN. No entries above it will be considered. This field is required.

    Return Value

    The specification.

  • Bind DN to use for bindings. The bindDN DN is the credential that is used to authenticate against an LDAP. If empty, the connection will be Anonymous. eg: cn=ausername,ou=people,dc=bc,dc=com Default value : “”.

    Declaration

    Swift

    public var bindDn: String { get set }

    Parameters

    bindDn

    The Bind DN to use for bindings.
    Get the Bind DN to use for bindings. The bindDN DN is the credential that is used to authenticate against an LDAP. If empty, the connection will be Anonymous. eg: cn=ausername,ou=people,dc=bc,dc=com

    Return Value

    The Bind DN to use for bindings.

  • The debug verbosity level from internal LDAP API. Values are LdapDebugLevel Default value: LinphoneLdapDebugLevelOff

    Declaration

    Swift

    public var debugLevel: LdapDebugLevel { get set }

    Parameters

    level

    The LdapDebugLevel debug level. Return the debug verbosity level.

    Return Value

    The LdapDebugLevel debug level.

  • Delay between each search in milliseconds Default value : 500.

    Declaration

    Swift

    public var delay: Int { get set }

    Parameters

    delay

    The timeout in milliseconds. Get the delay between each search in milliseconds.

    Return Value

    The delay in milliseconds.

  • If this config is enabled. Default value : false.

    Declaration

    Swift

    public var enabled: Bool { get set }

    Parameters

    enable

    Enable or not the LDAP configuration. Return if the configuration is enabled.

    Return Value

    Enable or not the LDAP configuration.

  • The search is based on this filter to search contacts. Default value : “(sn=%s)”.

    Declaration

    Swift

    public var filter: String { get set }

    Parameters

    filter

    The filter to use.
    Get the search is based on this filter to search contacts.

    Return Value

    The filter to use.

  • The max results when requesting searches. Default value : 5. This value fit for standard cases where only first results are needed. Also, it avoids latency on each searchs.

    Declaration

    Swift

    public var maxResults: Int { get set }

    Parameters

    maxResults

    The max results when requesting searches. Get the max results when requesting searches.

    Return Value

    The max results when requesting searches.

  • The minimum characters needed for doing a search on LDAP servers. Default value : 0.

    Declaration

    Swift

    public var minChars: Int { get set }

    Parameters

    minChars

    The minimum characters needed by a search. Get the minimum characters needed for doing a search on LDAP servers.

    Return Value

    The minimum characters needed by a search.

  • Check these attributes to build Name Friend, separated by a comma and the first is the highest priority. Default value : “sn”.

    Declaration

    Swift

    public var nameAttribute: String { get set }

    Parameters

    nameAttribute

    The comma separated attributes for the search.
    Get the attributes to build Name Friend, separated by a comma and the first is the highest priority.

    Return Value

    The comma separated attributes for the search.

  • The password to pass to server when binding. Default value : “”.

    Declaration

    Swift

    public var password: String { get set }

    Parameters

    password

    The password to pass to server when binding.
    Get the password to pass to server when binding.

    Return Value

    The password to pass to server when binding.

  • The dns resolution is done by Linphone using Sal. It will pass an IP to LDAP. By doing that, the TLS negociation could not check the hostname. You may deactivate the verifications if wanted to force the connection. Default value : false.

    Declaration

    Swift

    public var salEnabled: Bool { get set }

    Parameters

    enable

    Enable or not the use of sal. Return if the dns resolution is done by Linphone using Sal. It will pass an IP to LDAP. By doing that, the TLS negociation could not check the hostname. You may deactivate the verifications if wanted to force the connection.

    Return Value

    Enable or not the use of sal.

  • LDAP Server. eg: ldap:/// for a localhost server or ldap://ldap.example.org/ Default value: “ldap:///”. This field is required. You must use ‘ldap’ scheme. ‘ldaps’ for LDAP over SSL is non-standardized and deprecated.

    Declaration

    Swift

    public var server: String { get set }

    Parameters

    server

    LDAP Server address.
    Get the LDAP Server.

    Return Value

    LDAP Server address.

  • Specify whether the tls server certificate must be verified when connecting to a LDAP server. Values are LdapCertVerificationMode Default value : LinphoneLdapCertVerificationDefault (auto)

    Declaration

    Swift

    public var serverCertificatesVerificationMode: LdapCertVerificationMode { get set }

    Parameters

    verifyServerCertificates

    The TLS verification mode from LdapCertVerificationMode Return whether the tls server certificate must be verified when connecting to a LDAP server.

    Return Value

    The TLS verification mode from LdapCertVerificationMode

  • Check these attributes to build the SIP username in address of Friend. Attributes are separated by a comma. Default value : “mobile,telephoneNumber,homePhone,sn”.

    Declaration

    Swift

    public var sipAttribute: String { get set }

    Parameters

    sipAttribute

    The comma separated attributes for building Friend.
    Get the attributes to build the SIP username in address of Friend. Attributes are separated by a comma.

    Return Value

    The comma separated attributes for building Friend.

  • Add the domain to the sip address(sip:username@domain). By default or if it is empty, the domain will be specify while searching on the current proxy account. Default value : “”.

    Declaration

    Swift

    public var sipDomain: String { get set }

    Parameters

    sipDomain

    The SIP domain for the friend.
    Get the domain to the sip address(sip:username@domain).

    Return Value

    The SIP domain for the friend.

  • Timeout in seconds Default value : 5.

    Declaration

    Swift

    public var timeout: Int { get set }

    Parameters

    timeout

    The timeout in seconds. Get the timeout in seconds.

    Return Value

    The timeout in seconds.

  • Encrypt transactions by LDAP over TLS(StartTLS). You must use ‘ldap’ scheme. ‘ldaps’ for LDAP over SSL is non-standardized and deprecated. StartTLS in an extension to the LDAP protocol which uses the TLS protocol to encrypt communication. It works by establishing a normal - i.e. unsecured - connection with the LDAP server before a handshake negotiation between the server and the web services is carried out. Here, the server sends its certificate to prove its identity before the secure connection is established. Default value : true.

    Declaration

    Swift

    public var tlsEnabled: Bool { get set }

    Parameters

    enable

    Enable or not the use of TLS. Return if transactions are encrypted by LDAP over TLS(StartTLS). You must use \‘ldap\’ scheme. \‘ldaps\’ for LDAP over SSL is non-standardized and deprecated. StartTLS in an extension to the LDAP protocol which uses the TLS protocol to encrypt communication. It works by establishing a normal - i.e. unsecured - connection with the LDAP server before a handshake negotiation between the server and the web services is carried out. Here, the server sends its certificate to prove its identity before the secure connection is established.

    Return Value

    Enable or not the use of TLS.

  • Check parameters and return what are wrong.

    Declaration

    Swift

    public func check() -> Int

    Return Value

    The LdapCheck values. LinphoneLdapCheckOk if everything is ok.

  • Instantiate a new LdapParams with values from source.

    Declaration

    Swift

    public func clone() -> LdapParams?

    Return Value

    The newly created LdapParams object.

  • Get the value from field.

    Declaration

    Swift

    public func getCustomValue(key: String) -> String

    Parameters

    key

    The key string.

    Return Value

    The Value associated to the key.

  • Set custom field.

    Declaration

    Swift

    public func setCustomValue(key: String, value: String?)

    Parameters

    key

    The key string.

    value

    The value string.