StreamMentionAutocompleteOptions class
Overlay for displaying users that can be mentioned.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- StreamMentionAutocompleteOptions
Constructors
-
StreamMentionAutocompleteOptions({Key? key, required String query, required Channel channel, StreamChatClient? client, int limit = 10, bool mentionAllAppUsers = false, UserMentionTileBuilder? mentionsTileBuilder, ValueSetter<
User> ? onMentionUserTap}) - Constructor for creating a StreamMentionAutocompleteOptions.
Properties
- channel → Channel
-
The channel to search for users.
final
- client → StreamChatClient?
-
The client to search for users in case mentionAllAppUsers is True.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- limit → int
-
Limit applied on user search results.
final
- mentionAllAppUsers → bool
-
When enabled mentions search users across the entire app.
final
- mentionsTileBuilder → UserMentionTileBuilder?
-
Customize the tile for the mentions overlay.
final
-
onMentionUserTap
→ ValueSetter<
User> ? -
Callback called when a user is selected.
final
- query → String
-
Query for searching users.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → _StreamMentionAutocompleteOptionsState -
Creates the mutable state for this widget at a given location in the tree.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of
DiagnosticsNodeobjects describing this node's children.inherited -
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited