Type Aliases

The following type aliases are available globally.

  • Returns a User and an error based on the results of the call to SendBirdCall.authenticate.

    Since

    1.0.0

    Declaration

    Swift

    public typealias AuthenticateHandler = (_ user: User?, _ error: SBCError?) -> Void

    Parameters

    user

    An authenticated user.
    error

    An error that could occur while authenticating.

  • Returns a DirectCall and an error after a call to SendBirdCall.dial.

    Since

    1.0.0

    Declaration

    Swift

    public typealias DirectCallHandler = (_ call: DirectCall?, _ error: SBCError?) -> Void

    Parameters

    call

    DirectCall instance of the newly initiated call.
    error

    An error that could occur while processing the request.

Room

  • Returns a Room and an error .

    Since

    1.6.0

    Declaration

    Swift

    public typealias RoomHandler = (_ room: Room?, _ error: SBCError?) -> Void

    Parameters

    room

    Room instance.
    error

    An error that could occur while processing the request.

  • Returns a customItems and an error after a call to get the CustomItems.

    Since

    1.8.0

    Declaration

    Swift

    public typealias CustomItemsResultHandler = (_ customItems: [String : String]?, _ error: SBCError?) -> Void

    Parameters

    customItems

    Key-value dictionary of the updated custom items.
    error

    An error that could occur while changing CustomItems.

  • Returns a customItems, an affectedKeys, and an error after a call to modify the CustomItems.

    Since

    1.0.0

    Declaration

    Swift

    public typealias CustomItemsHandler = (_ customItems: [String : String]?, _ affectedKeys: [String]?, _ error: SBCError?) -> Void

    Parameters

    customItems

    Key-value dictionary of the updated custom items.
    affectedKeys

    Array of String keys that are modified as a result of the function call.
    error

    An error that could occur while changing CustomItems.

  • Handler called when the processing completes. May contain an error if the request has failed.

    Since

    1.0.0

    Declaration

    Swift

    public typealias ErrorHandler = (_ error: SBCError?) -> Void

    Parameters

    error

    An error that could occur while processing the request.

  • Returns an UIImage and an error after capturing a video call.

    Since

    1.3.0

    Declaration

    Swift

    public typealias CaptureVideoViewHandler = (_ image: UIImage?, _ error: SBCError?) -> Void

    Parameters

    image

    Captured image of the video view.
    error

    An error that could occur while capturing a video view.

  • Handler called when the processing completes.

    Since

    1.0.0

    Declaration

    Swift

    public typealias VoidHandler = () -> Void

  • Returns a DirectCallLog and an error after a call to DirectCallLogListQuery.next.

    Since

    1.0.0

    Declaration

    Swift

    public typealias CallLogsResultHandler = (_ callLogs: [DirectCallLog]?, _ error: SBCError?) -> Void

    Parameters

    callLogs

    An array of DirectCallLog from the query request.
    error

    An error that could occur while querying call history.

  • Returns a unique identifier(UUID) of a call after processing the push payload from CallKit.

    Since

    1.0.0

    Declaration

    Swift

    public typealias PushRegistryHandler = (_ callUUID: UUID?) -> Void

    Parameters

    callUUID

    A unique identifier(UUID) value of a specific call.

  • Handles the recordingId and an error depending on the result at the start of a recording session.

    Since

    1.3.0

    Declaration

    Swift

    public typealias RecordingStartedHandler = (_ recorderId: String?, _ error: SBCError?) -> Void

    Parameters

    recordingId

    A unique value for the specific recording session used to identify and stop the recording.
    error

    An error that could occur while starting a recording session.