One Logo Pool Ball
LiveCommunicationKit · IOS API REFERENCE

ConversationManager

class · iOS 17.4+ · SDK 27.1

final class ConversationManager

A programmatic interface for interacting with and observing conversations.

Members (12)

method · iOS 17.4+

reportNewIncomingConversation

TypeScript
reportNewIncomingConversation(uuid: string, update: Conversation_Update): Promise<void>
Swift declaration
final func reportNewIncomingConversation(uuid: UUID, update: Conversation.Update) async throws

Informs the system that there's a new incoming Conversation, and the device should begin to ring and present the incoming Conversation UI. - parameter uuid: The `UUID` used to identify the created Conversation. - parameter update: Optional fields used to configure the Conversation to an initial state.

method · iOS 17.4+

reportConversationEvent

TypeScript
reportConversationEvent(event: Conversation_Event, conversation: Conversation): void
Swift declaration
final func reportConversationEvent(_ event: Conversation.Event, for conversation: Conversation)

Informs the system that some event has occurred and to update the given `Conversation` as needed. - parameter event: The `Event` to be processed by the system. - parameter conversation: The `Conversation` to which the `Event` applies.

method · iOS 17.4+

pendingConversationActions

TypeScript
pendingConversationActions(conversationActionClass: string, conversation: Conversation): Array<ConversationAction>
Swift declaration
final func pendingConversationActions(of conversationActionClass: ConversationAction.Type, for conversation: Conversation) -> [ConversationAction]

Returns all pending `ConversationAction`s of the specified class for the specified call identifier that are incomplete. - parameter conversationActionClass: The desired `ConversationAction` subclass of actions to return. - parameter conversation: The desired `Conversation` for returned actions. - returns: An array of call actions of the specified class for the specified `Conversation`.

method · iOS 17.4+

invalidate

TypeScript
invalidate(): void
Swift declaration
final func invalidate()

Invalidates the manager, ends all `Conversation`s, and fails all pending `ConversationAction`s.

init · iOS 17.4+

init

TypeScript
static init(configuration: ConversationManager_Configuration): ConversationManager
Swift declaration
convenience init(configuration: ConversationManager.Configuration)

Creates a new `ConversationManager` with the given `ConversationManager.Configuration`. - parameter configuration: A collection of options used to configure the `ConversationManager`.

get · iOS 17.4+

configuration

TypeScript
get configuration(): ConversationManager_Configuration
Swift declaration
final let configuration: ConversationManager.Configuration

The configuration of the manager.

get · iOS 17.4+

conversations

TypeScript
get conversations(): Array<Conversation>
Swift declaration
final var conversations: [Conversation] { get }
get · iOS 17.4+

pendingActions

TypeScript
get pendingActions(): Array<ConversationAction>
Swift declaration
final var pendingActions: [ConversationAction] { get }

`ConversationAction`s that have not yet been fulfilled.

static · iOS 17.4+

reportNewIncomingVoIPPushPayload

TypeScript
static reportNewIncomingVoIPPushPayload(payload: NativeMap<unknown, unknown>): Promise<void>
Swift declaration
final class func reportNewIncomingVoIPPushPayload(_ payload: [AnyHashable : Any]) async throws

Reports a new incoming call after your notification service extension decrypts a VoIP call request. - parameter payload: A dictionary containing additional data about the incoming call. All keys and values in the dictionary must implement the `NSSecureCoding` protocol. - throws: When the system disallows a `Conversation`, an error is thrown that contains information about why it disallowed the `Conversation`.

method · iOS 17.4+

perform

TypeScript
perform(actions: Array<ConversationAction>): Promise<void>
Swift declaration
final func perform(_ actions: [ConversationAction]) async throws

Instructs the `ConversationManager` to asynchronously perform the given actions. - parameter actions: An array of `ConversationAction` to perform.

get · iOS 17.4+

delegate

TypeScript
get delegate(): (SDKHandle) | null
Swift declaration
weak final var delegate: (any ConversationManagerDelegate)?
set · iOS 17.4+

delegate

TypeScript
set delegate(value: (Implements<ConversationManagerDelegate> | SDKHandle) | null)
Swift declaration
weak final var delegate: (any ConversationManagerDelegate)?

Skipped declarations

No declarations were skipped in this snapshot.

All LiveCommunicationKit types →