DialParams

@objcMembers
@objc(SBCDialParams)
public class DialParams : NSObject
extension DialParams: NSCopying

Parameter for dialing another user. Contains initial configurations for the call.

Since

1.0.0

  • User Id of the callee to be called.

    Since

    1.0.0

    Declaration

    Swift

    public var calleeId: String

  • Bool value indicating whether the call supports vieo call. The default value is false.

    Since

    1.0.0

    Declaration

    Swift

    public var isVideoCall: Bool

  • Options for the call.

    Since

    1.0.0

    Declaration

    Swift

    public var callOptions: CallOptions

  • Custom items for the call.

    Since

    1.0.0

    Declaration

    Swift

    public var customItems: [String : String]

  • Undocumented

    Declaration

    Swift

    public var sendbirdChatOptions: SendBirdChatOptions?

  • Holds the active call and dials a new call.

    Since

    1.8.0

    Declaration

    Swift

    public var holdActiveCall: Bool

  • Since

    1.8.0.

    Declaration

    Swift

    public init(
    calleeId: String,
    isVideoCall: Bool = false,
    callOptions: CallOptions = CallOptions(),
    customItems: [String: String] = [:],
    sendbirdChatOptions: SendBirdChatOptions? = nil,
    holdActiveCall: Bool = false
)

    Parameters

    calleeId

    The callee’s user ID
    isVideoCall

    Bool value indicating whether the call supports vieo call. The default value is false.
    callOptions

    Call options for configuring the outgoing call. The default value is CallOptions() with only audio call capability.
    customItems

    Custom items for the call. The default value is empty dictionary.
    sendbirdChatOptions

    Options for configuring SendBird Chat.
    holdActiveCall

    Holds the active call and dials a new call.

  • Since

    1.5.0

    Declaration

    Swift

    convenience public init(
    calleeId: String,
    isVideoCall: Bool = false,
    callOptions: CallOptions = CallOptions(),
    customItems: [String: String] = [:]
)

    Parameters

    calleeId

    The callee’s user ID
    isVideoCall

    Bool value indicating whether the call supports vieo call. The default value is false.
    callOptions

    Call options for configuring the outgoing call. The default value is CallOptions() with only audio call capability.
    customItems

    Custom items for the call. The default value is empty dictionary.

  • Since

    1.0.0

    Declaration

    Swift

    public convenience init(calleeId: String)

    Parameters

    calleeId

    The callee’s user ID

  • Returns a copied instance of the DialParams.

    Declaration

    Swift

    public func copy(with zone: NSZone? = nil) -> Any