TomTomSDKRoute 0.2.3404 Docs

TomTomSDKRoute Reference TextWithPhonetics Structure Reference

TextWithPhonetics

public struct TextWithPhonetics

extension TextWithPhonetics: Equatable

Represents a localized string with optional phonetics information.

Important

This is a Public Preview API. It may be changed or removed at any time.

Lifecycle


                    
                    
                    init(plainText:plainTextLanguage:phoneticString:)

Declaration

Swift

public init(
    plainText: String,
    plainTextLanguage: Locale,
    phoneticString: PhoneticString? = nil
) throws

Public

plainText
Plan text value.
Declaration
Swift

public let plainText: String
plainTextLanguage
Language for the plain text value as an IETF language tag, i.e., a dash-two-letter ISO-639 language code, and a two-letter ISO 3166 country code. Example: “en-US”
Declaration
Swift

public let plainTextLanguage: Locale
phoneticString
Phonetic string, if available.
Declaration
Swift

public let phoneticString: PhoneticString?

TextWithPhonetics.InitializationError

InitializationError
Exceptions that can be thrown during the creation of TextWithPhonetics.

Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public enum InitializationError : Error