FFGenUIChatWidgetProperties class

@doc Properties for the GenUI Chat Widget that enables AI-powered conversations. Next available tag: 10

Inheritance
Available extensions

Constructors

FFGenUIChatWidgetProperties({FFGenUIBackendConfig? backendConfig, FFStringValue? userSystemPrompt, Iterable<String>? catalogComponentKeys, FFGenUIChatStyling? styling, Iterable<FFGenUIFunctionConfig>? functionConfigs, FFStringValue? thinkingMessage, Iterable<FFGenUIAppEventListenerConfig>? appEventListenerConfigs})
factory
FFGenUIChatWidgetProperties.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory
FFGenUIChatWidgetProperties.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory

Properties

appEventListenerConfigs → PbList<FFGenUIAppEventListenerConfig>
@doc App event listener configurations for injecting event context into the AI conversation.
no setter
backendConfig ↔ FFGenUIBackendConfig
@doc Backend configuration for AI content generation.
getter/setter pair
catalogComponentKeys → PbList<String>
@doc Component keys to include in the GenUI catalog (must not have action params).
no setter
functionConfigs → PbList<FFGenUIFunctionConfig>
@doc Function configurations for AI-callable functions. Each function must have an action block identifier and a user-friendly loading message.
no setter
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
info_ → BuilderInfo
no setteroverride
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
styling ↔ FFGenUIChatStyling
@doc Direct styling properties.
getter/setter pair
thinkingMessage ↔ FFStringValue
@doc Default status message shown when AI is thinking (before any tool is called). Defaults to "Thinking..." if not specified.
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited
userSystemPrompt ↔ FFStringValue
@doc User's domain-specific system prompt (augmented with GenUI instructions).
getter/setter pair

Methods

addExtension(Extension extension, Object? value) → void
Adds an extension field value to a repeated field.
inherited
check() → void
Throws a StateError if the message has required fields without a value.
inherited
clear() → void
Clears all data that was set in this message.
inherited
clearBackendConfig() → void
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearStyling() → void
clearThinkingMessage() → void
clearUserSystemPrompt() → void
clone() → FFGenUIChatWidgetProperties
Creates a deep copy of the fields in this message.
override
copyWith(void updates(FFGenUIChatWidgetProperties)) → FFGenUIChatWidgetProperties
Apply updates to a copy of this message.
override
createEmptyInstance() → FFGenUIChatWidgetProperties
Creates an empty instance of the same message type as this.
override
deepCopy() → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Returns a writable deep copy of this message.
ensureBackendConfig() → FFGenUIBackendConfig
ensureStyling() → FFGenUIChatStyling
ensureThinkingMessage() → FFStringValue
ensureUserSystemPrompt() → FFStringValue
extensionsAreInitialized() → bool
inherited
freeze() → GeneratedMessage
Make this message read-only.
inherited
fromCompressedSerializedBuffer(List<int> buffer, [int recursionLimit = 512]) → void

Available on GeneratedMessage, provided by the SchemaCompressedSerializationExtensions extension

fromCompressedSerializedBufferString(String buffer, [int recursionLimit = 512]) → void

Available on GeneratedMessage, provided by the SchemaCompressedSerializationExtensions extension

getDefaultForField(int tagNumber) → dynamic
Returns the default value for the given field.
inherited
getExtension(Extension extension) → dynamic
Returns the value of extension.
inherited
getField(int tagNumber) → dynamic
Returns the value of the field associated with tagNumber, or the default value if it is not set.
inherited
getFieldOrNull(int tagNumber) → dynamic
Returns the value of a field, ignoring any defaults.
inherited
getTagNumber(String fieldName) → int?
inherited
hasBackendConfig() → bool
hasExtension(Extension extension) → bool
Returns true if a value of extension is present.
inherited
hasField(int tagNumber) → bool
Whether this message has a field associated with tagNumber.
inherited
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasStyling() → bool
hasThinkingMessage() → bool
hasUserSystemPrompt() → bool
isInitialized() → bool
Whether all required fields in the message and embedded messages are set.
inherited
mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges serialized protocol buffer data into this message.
inherited
mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Same as mergeFromBuffer, but takes a CodedBufferReader input.
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.
inherited
mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from a JSON object represented as a Dart map.
inherited
mergeFromMessage(GeneratedMessage other) → void
Merges the contents of the other into this message.
inherited
mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void
Merges field values from json, a JSON object using proto3 encoding.
inherited
mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(void updates(T)) → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Apply updates to a copy of this message.
setExtension(Extension extension, Object value) → void
Sets the value of a non-repeated extension field to value.
inherited
setField(int tagNumber, Object value) → void
Sets the value of a field by its tagNumber.
inherited
toBuilder() → GeneratedMessage
Creates a writable, shallow copy of this message.
inherited
toDebugString() → String
Returns a String representation of this message.
inherited
toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?
Returns an Object representing Proto3 JSON serialization of this.
inherited
toString() → String
Returns a String representation of this message.
inherited
toTextFormat() → String

Available on GeneratedMessage, provided by the TextFormatExtension extension

Returns a TextFormat String representation of this message.
writeTextFormat(StringSink sink) → void

Available on GeneratedMessage, provided by the TextFormatExtension extension

Writes a TextFormat String representation of this message to sink.
writeToBuffer() → Uint8List
Serialize the message as the protobuf binary format.
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void
Same as writeToBuffer, but serializes to the given CodedBufferWriter.
inherited
writeToJson() → String
Returns a JSON string that encodes this message.
inherited
writeToJsonMap() → Map<String, dynamic>
Returns the JSON encoding of this message as a Dart Map.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited