PlanetKitCallKitParam

@objc
public class PlanetKitCallKitParam : NSObject

A class representing parameters for handling CallKit interactions in the PlanetKit framework.

  • The name of the app. Available for iOS versions greater than or equal to 10.0 and less than 14.0.

    Declaration

    Swift

    @objc
public let appName: String?

  • The name of the caller.

    Declaration

    Swift

    @objc
public let callerName: String

  • A Boolean value indicating whether the call has video.

    Declaration

    Swift

    @objc
public let hasVideo: Bool

  • The URL of the ringtone sound.

    Declaration

    Swift

    @objc
public let ringtoneSound: URL?

  • The icon associated with the call.

    Declaration

    Swift

    @objc
public let icon: String?

  • A Boolean value indicating whether to add the call to the call list.

    Declaration

    Swift

    @objc
public let addCallToList: Bool

  • A Boolean value indicating whether the call supports holding.

    Declaration

    Swift

    @objc
public let supportsHolding: Bool

  • The start message used for incoming calls.

    Remark

    startMessage used for incoming calls.

    Declaration

    Swift

    @objc
public let startMessage: PlanetKitCallStartMessage?

  • A Boolean value indicating whether to use responder preparation for incoming calls.

    Remark

    useResponderPreparation used for incoming calls.

    Declaration

    Swift

    @objc
public let useResponderPreparation: Bool

  • A Boolean value indicating whether to record the call on the cloud.

    Remark

    recordOnCloud used for incoming calls.

    Declaration

    Swift

    @objc
public let recordOnCloud: Bool

  • The initial state of the user’s video during the call.

    Declaration

    Swift

    @objc
public let initialMyVideoState: PlanetKitInitialMyVideoState

  • Initializes a new instance of the PlanetKitCallKitParam class.

    Declaration

    Swift

    @objc
public init(appName: String?, callerName: String, isVideo: Bool, ringtoneSound: URL?, icon: String?, addCallToList: Bool, supportsHolding: Bool, startMessage: PlanetKitCallStartMessage? = nil, useResponderPreparation: Bool = false, recordOnCloud: Bool = false, initialMyVideoState: PlanetKitInitialMyVideoState = .resume)