PrivMX DOCS
API Reference/PrivMX Endpoint Swift Extra/Events

privmx.endpoint.core.LibBreakEvent

Event that can be emitted to break the waitEvent loop.

Static Methods

typeStr()

Returns the event type as a string. This method returns the constant string "libBreak", identifying the type of this event as libBreak.

public static func typeStr() -> String

Returns

String · A String representing the event type, in this case, "libBreak".

Methods

getChannel()

Returns the event channel as a string. This implementation returns the constant string "platform", identifying the channel associated with LibBreakEvent.

public func getChannel() -> String

Returns

String · A String representing the event channel, in this case, "platform".

handleWith(cb:)

Handles the event by calling the provided callback with an optional argument. This implementation always passes nil to the callback.

Params

cb

@escaping (@Sendable @MainActor (Any?) async -> Void)

A closure that accepts an optional Any? argument, representing the data to be passed when the event is handled.

public func handleWith(
cb: @escaping (@Sendable @MainActor (Any?) async -> Void)
)

We use cookies on our website. We use them to ensure the proper functioning of the site and, if you agree, for purposes we set, such as analytics or marketing.