LiveCommunicationKit · IOS API REFERENCE

Handle

struct · iOS 17.4+ · SDK 27.1

struct Handle

Uniquely identifies a member in a `Conversation`.

Members (7)

get · iOS 17.4+

displayName

TypeScript

get displayName(): string

Swift declaration

var displayName: String

The value that should be displayed to the user at the UI layer.

set · iOS 17.4+

displayName

TypeScript

set displayName(value: string)

Swift declaration

var displayName: String

The value that should be displayed to the user at the UI layer.

init · iOS 17.4+

init

TypeScript

static init(type: Handle_Kind, value: string, displayName?: (string) | null): Handle

Swift declaration

init(type: Handle.Kind, value: String, displayName: String? = nil)

Creates a new `Handle`. - parameter type: The type of handle (e.g. a phone number or email address) - parameter value: The raw value of the handle. - parameter displayName: The value that should be displayed to the user at the UI layer. If the given `displayName` is `nil` then the `value` is used instead.

get · iOS 17.4+

type

TypeScript

get type(): Handle_Kind

Swift declaration

var type: Handle.Kind

The type of handle (e.g. a phone number or email address)

set · iOS 17.4+

type

TypeScript

set type(value: Handle_Kind)

Swift declaration

var type: Handle.Kind

The type of handle (e.g. a phone number or email address)

get · iOS 17.4+

value

TypeScript

get value(): string

Swift declaration

var value: String

The raw value of the handle.

set · iOS 17.4+

value

TypeScript

set value(value: string)

Swift declaration

var value: String

The raw value of the handle.

Skipped declarations

No declarations were skipped in this snapshot.

All LiveCommunicationKit types →