DispenseTrait.ItemNameSynonym

class DispenseTrait.ItemNameSynonym : ClusterStruct


Synonym names for the dispensed item in a given language.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors

ItemNameSynonym(synonyms: List<String>, lang: String)

Creates the ItemNameSynonym class.

Public functions

open StructDescriptor

Returns the descriptor for the struct.

open Any?

Returns the value of the field for the given tag ID.

Public properties

String

ISO 639-1 language code, for example, en for English.

List<String>

Synonyms for the dispensed item, which should include both singular and plural forms if applicable.

Public constructors

ItemNameSynonym

ItemNameSynonym(synonyms: List<String> = emptyList(), lang: String = "")

Creates the ItemNameSynonym class.

Public functions

getDescriptor

@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?

Returns the value of the field for the given tag ID.

Public properties

lang

val langString

ISO 639-1 language code, for example, en for English.

synonyms

val synonymsList<String>

Synonyms for the dispensed item, which should include both singular and plural forms if applicable.