DirectCallLogListQuery

@objcMembers
@objc(SBCDirectCallLogListQuery)
public class DirectCallLogListQuery : NSObject

A user’s call history is available via a DirectCallLogListQuery instance.

let params = DirectCallLogListQuery.Params()
let query = SendBirdCall.createDirectCallLogListQuery(with: params)

query.next { callLogs, error in
    //
}

Since

1.0.0

  • Filter for DirectCallLogListQuery of specific type of user in a call.

    • Cases:

      • caller: Caller in a call.
      • callee: Callee in a call.
      • all: all users.

    Since

    1.0.0

    See more

    Declaration

    Swift

    @objc
public enum UserRoleFilter : Int, RawRepresentable

  • If true, call history is being retrieved from SendBirdCall server. The default value is false

    Since

    1.0.0

    Declaration

    Swift

    public private(set) var isLoading: Bool { get }

  • If true, there is more call history to be retrieved. The default value is true.

    Since

    1.0.0

    Declaration

    Swift

    public private(set) var hasNext: Bool { get }

  • Returns call logs of the specified role. For example, setMyRole(Callee) returns only the callee’s call logs.

    Since

    1.0.0

    Declaration

    Swift

    public var myRole: UserRoleFilter { get }

  • Returns the call logs for specified results. If you specify more than one result, they are processed as OR condition and all call logs corresponding with the specified end results will be returned. For example, [.noAnswer, .canceled], only the .noAnswer or .canceled call logs will be returned.

    Since

    1.0.0

    Declaration

    Swift

    public var endResults: [DirectCallEndResult] { get }

  • Returns endResults as a NSArray.

    Since

    1.0.0

    Declaration

    Swift

    public var endResultsArray: NSArray { get }

  • The number of call logs to return at once. This is read-only property. If you want to set the limit, see Param.limit

    Note

    The maximum value is 100 and the minimum is 1.

    Since

    1.0.0

    See

    See Also: Param.limit

    Declaration

    Swift

    public var limit: Int32 { get }

  • Used to query call history from SendBirdCall server.

    Since

    1.0.0

    Declaration

    Swift

    public func next(completionHandler: @escaping CallLogsResultHandler)

  • Parameters for configuring DirectCallLogListQuery

    let params = DirectCallLogListQuery.Params()
let query = SendBirdCall.createDirectCallLogListQuery(with: params)
query.next { callLogs, error in
    //
}

    Since

    1.0.0
    See more

    Declaration

    Swift

    @objcMembers
@objc(SBCDirectCallLogListQueryParams)
public class Params : NSObject