CallLog

public class CallLog : LinphoneObject

Object used to keep track of all calls initiated, received or missed. It contains the call ID, date & time at which the call took place and it’s duration (0 if it wasn’t answered). You can also know if video was enabled or not or if it was a conference, as well as it’s average quality. If needed, you can also create a fake CallLog using Core.createCallLog(), otherwise use Core.getCallLogs() or even Call.getCallLog() to get the log of an ongoing call.

  • Undocumented

    Declaration

    Swift

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

    Declaration

    Swift

    public var getCobject: OpaquePointer? { get }
  • Get the call ID used by the call.

    Declaration

    Swift

    public var callId: String { get }

    Return Value

    The call ID used by the call as a string.

  • Retrieves the conference info associated to this call log in DB.

    Declaration

    Swift

    public var conferenceInfo: ConferenceInfo? { get }

    Return Value

    The ConferenceInfo associated.

  • dir

    Get the direction of the call.

    Declaration

    Swift

    public var dir: Call.Dir { get }

    Return Value

    The Call.Dir of the call.

  • Get the duration of the call since connected.

    Declaration

    Swift

    public var duration: Int { get }

    Return Value

    The duration of the call in seconds.

  • When the call was failed, return an object describing the failure.

    Declaration

    Swift

    public var errorInfo: ErrorInfo? { get }

    Return Value

    ErrorInfo about the error encountered by the call associated with this call log or nil.

  • Get the origin address (ie from) of the call.

    Declaration

    Swift

    public var fromAddress: Address? { get }

    Return Value

    The origin Address (ie from) of the call.

  • Get the local address (that is from or to depending on call direction)

    Declaration

    Swift

    public var localAddress: Address? { get }

    Return Value

    The local Address of the call

  • Get the overall quality indication of the call.

    Declaration

    Swift

    public var quality: Float { get }

    Return Value

    The overall quality indication of the call.

  • Associate a persistent reference key to the call log. 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 }

    Parameters

    refkey

    The reference key string to associate to the call log.
    Get the persistent reference key associated to the call log. 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.

    Return Value

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

  • Set the remote address (that is ‘from’ or ‘to’ depending on call direction). It allows to fill more information that the SDK doesn’t have. A use case can be to fill the display name (coming from an external address book) into a call log on incoming call. When the call end, the database will take account of the new information and can be used later

    Declaration

    Swift

    public var remoteAddress: Address? { get set }

    Parameters

    address

    Address object
    Get the remote address (that is from or to depending on call direction).

    Return Value

    The remote Address of the call.

  • Get the start date of the call.

    Declaration

    Swift

    public var startDate: time_t { get }

    Return Value

    The date of the beginning of the call.

  • Get the status of the call.

    Declaration

    Swift

    public var status: Call.Status { get }

    Return Value

    The Call.Status of the call.

  • Get the destination address (ie to) of the call.

    Declaration

    Swift

    public var toAddress: Address? { get }

    Return Value

    The destination Address (ie to) of the call.

  • Assign a user data to the call log.

    Declaration

    Swift

    public var userData: UnsafeMutableRawPointer? { get set }

    Parameters

    userData

    The user data to associate with the call log.
    Get the user data associated with the call log.

    Return Value

    The user data associated with the call log.

  • Tell whether video was enabled at the end of the call or not.

    Declaration

    Swift

    public var videoEnabled: Bool { get }

    Return Value

    A boolean value telling whether video was enabled at the end of the call.

  • Get a human readable string describing the call.

    Note

    : the returned string must be freed by the application (use ms_free()).

    Declaration

    Swift

    public func toStr() -> String

    Return Value

    A human readable string describing the call.

  • Tells whether that call was part of a conference.

    Declaration

    Swift

    public func wasConference() -> Bool

    Return Value

    true if the call was part of a conference, false otherwise.