AuthInfo

public class AuthInfo : LinphoneObject

Object holding authentication information.

Note

The object’s fields should not be accessed directly. Prefer using the accessor methods.

In most case, authentication information consists of a username and password. Sometimes, a userid is required by proxy, and realm can be useful to discriminate different SIP domains.

Once created and filled, a AuthInfo must be added to the Core in order to become known and used automatically when needed. Use Core.addAuthInfo() for that purpose.

The Core object can take the initiative to request authentication information when needed to the application through the auth_info_requested callback of the LinphoneCoreVTable structure.

The application can respond to this information request later using Core.addAuthInfo(). This will unblock all pending authentication transactions and retry them with authentication headers.

  • Gets the algorithm.

    Declaration

    Swift

    public var algorithm: String { get set }

    Return Value

    The algorithm.

  • Gets the domain.

    Declaration

    Swift

    public var domain: String { get set }

    Return Value

    The domain.

  • ha1

    Gets the ha1.

    Declaration

    Swift

    public var ha1: String { get set }

    Return Value

    The ha1.

  • Gets the password.

    • deprecated: , use linphone_auth_info_get_password instead

    Declaration

    Swift

    public var passwd: String { get set }

    Return Value

    The password.

  • Gets the password.

    Declaration

    Swift

    public var password: String { get set }

    Return Value

    The password.

  • Gets the realm.

    Declaration

    Swift

    public var realm: String { get set }

    Return Value

    The realm.

  • Gets the TLS certificate.

    Declaration

    Swift

    public var tlsCert: String { get set }

    Return Value

    The TLS certificate.

  • Gets the TLS certificate path.

    Declaration

    Swift

    public var tlsCertPath: String { get set }

    Return Value

    The TLS certificate path.

  • Gets the TLS key.

    Declaration

    Swift

    public var tlsKey: String { get set }

    Return Value

    The TLS key.

  • Gets the TLS key path.

    Declaration

    Swift

    public var tlsKeyPath: String { get set }

    Return Value

    The TLS key path.

  • Gets the userid.

    Declaration

    Swift

    public var userid: String { get set }

    Return Value

    The userid.

  • Gets the username.

    Declaration

    Swift

    public var username: String { get set }

    Return Value

    The username.

  • Instantiates a new auth info with values from source.

    Declaration

    Swift

    public func clone() -> AuthInfo?

    Return Value

    The newly created AuthInfo object.