LiveCommunicationKit · IOS API REFERENCE

ConversationManager.Configuration

struct · iOS 17.4+ · SDK 27.1

struct Configuration

An encapsulation of the configuration of a `ConversationManager`.

Members (18)

get · iOS 17.4+

maximumConversationsPerConversationGroup

TypeScript

get maximumConversationsPerConversationGroup(): number

Swift declaration

var maximumConversationsPerConversationGroup: Int

The maximum number of `Conversation`s per `Conversation` group.

set · iOS 17.4+

maximumConversationsPerConversationGroup

TypeScript

set maximumConversationsPerConversationGroup(value: number)

Swift declaration

var maximumConversationsPerConversationGroup: Int

The maximum number of `Conversation`s per `Conversation` group.

get · iOS 17.4+

maximumConversationGroups

TypeScript

get maximumConversationGroups(): number

Swift declaration

var maximumConversationGroups: Int

The maximum number of `Conversation`s groups.

set · iOS 17.4+

maximumConversationGroups

TypeScript

set maximumConversationGroups(value: number)

Swift declaration

var maximumConversationGroups: Int

The maximum number of `Conversation`s groups.

get · iOS 17.4+

includesConversationInRecents

TypeScript

get includesConversationInRecents(): boolean

Swift declaration

var includesConversationInRecents: Bool

A Boolean value that indicates whether the provider includes a call in the system’s Recents list after the call ends.

set · iOS 17.4+

includesConversationInRecents

TypeScript

set includesConversationInRecents(value: boolean)

Swift declaration

var includesConversationInRecents: Bool

A Boolean value that indicates whether the provider includes a call in the system’s Recents list after the call ends.

init · iOS 17.4+

init

TypeScript

static initRingtoneNameIconTemplateImageDataMaximumConversationGroupsMaximumConversationsPerConversationGroupIncludesConversationInRecentsSupportsVideoSupportedHandleTypesSupportsAudioTranslation(ringtoneName: (string) | null, iconTemplateImageData: (ArrayBuffer) | null, maximumConversationGroups: number, maximumConversationsPerConversationGroup: number, includesConversationInRecents: boolean, supportsVideo: boolean, supportedHandleTypes: Array<Handle_Kind>, supportsAudioTranslation: boolean): ConversationManager_Configuration

Swift declaration

init(ringtoneName: String?, iconTemplateImageData: Data?, maximumConversationGroups: Int, maximumConversationsPerConversationGroup: Int, includesConversationInRecents: Bool, supportsVideo: Bool, supportedHandleTypes: Set<Handle.Kind>, supportsAudioTranslation: Bool)

Creates a new `Configuration`. - parameter ringtoneName: The name of the sound resource in the app bundle to be used for the provider ringtone. - parameter iconTemplateImageData: PNG data for the icon image to be displayed for the provider. - parameter maximumConversationGroups: The maximum number of `Conversation`s groups. - parameter maximumConversationsPerConversationGroup: The maximum number of `Conversation`s per `Conversation` group. - parameter includesConversationInRecents: A Boolean value that indicates whether the provider includes a call in the system’s Recents list after the call ends. - parameter supportsVideo: A Boolean value that indicates whether the provider supports video in addition to audio. - parameter supportedHandleTypes: The supported handle types. - parameter supportsAudioTranslation: A Boolean value that indicates whether the provider supports real-time audio translation.

init · iOS 17.4+

init

TypeScript

static initRingtoneNameIconTemplateImageDataMaximumConversationGroupsMaximumConversationsPerConversationGroupIncludesConversationInRecentsSupportsVideoSupportedHandleTypes(ringtoneName: (string) | null, iconTemplateImageData: (ArrayBuffer) | null, maximumConversationGroups: number, maximumConversationsPerConversationGroup: number, includesConversationInRecents: boolean, supportsVideo: boolean, supportedHandleTypes: Array<Handle_Kind>): ConversationManager_Configuration

Swift declaration

init(ringtoneName: String?, iconTemplateImageData: Data?, maximumConversationGroups: Int, maximumConversationsPerConversationGroup: Int, includesConversationInRecents: Bool, supportsVideo: Bool, supportedHandleTypes: Set<Handle.Kind>)

get · iOS 17.4+

ringtoneName

TypeScript

get ringtoneName(): (string) | null

Swift declaration

var ringtoneName: String?

The name of the sound resource in the app bundle to be used for the provider ringtone.

set · iOS 17.4+

ringtoneName

TypeScript

set ringtoneName(value: (string) | null)

Swift declaration

var ringtoneName: String?

The name of the sound resource in the app bundle to be used for the provider ringtone.

get · iOS 17.4+

supportsVideo

TypeScript

get supportsVideo(): boolean

Swift declaration

var supportsVideo: Bool

A Boolean value that indicates whether the provider supports video in addition to audio.

set · iOS 17.4+

supportsVideo

TypeScript

set supportsVideo(value: boolean)

Swift declaration

var supportsVideo: Bool

A Boolean value that indicates whether the provider supports video in addition to audio.

get · iOS 17.4+

supportedHandleTypes

TypeScript

get supportedHandleTypes(): Array<Handle_Kind>

Swift declaration

var supportedHandleTypes: Set<Handle.Kind>

The supported handle types.

set · iOS 17.4+

supportedHandleTypes

TypeScript

set supportedHandleTypes(value: Array<Handle_Kind>)

Swift declaration

var supportedHandleTypes: Set<Handle.Kind>

The supported handle types.

get · iOS 17.4+

iconTemplateImageData

TypeScript

get iconTemplateImageData(): (ArrayBuffer) | null

Swift declaration

var iconTemplateImageData: Data?

PNG data for the icon image to be displayed for the provider.

set · iOS 17.4+

iconTemplateImageData

TypeScript

set iconTemplateImageData(value: (ArrayBuffer) | null)

Swift declaration

var iconTemplateImageData: Data?

PNG data for the icon image to be displayed for the provider.

get · iOS 26.0+

supportsAudioTranslation

TypeScript

get supportsAudioTranslation(): boolean

Swift declaration

var supportsAudioTranslation: Bool

A Boolean value that indicates whether the provider supports real-time audio translation

set · iOS 26.0+

supportsAudioTranslation

TypeScript

set supportsAudioTranslation(value: boolean)

Swift declaration

var supportsAudioTranslation: Bool

A Boolean value that indicates whether the provider supports real-time audio translation

Skipped declarations

No declarations were skipped in this snapshot.

All LiveCommunicationKit types →