ContactsView class

Inheritance

Constructors

ContactsView({ChatUIKitAppBarModel? appBarModel, bool enableAppBar = true, bool enableSearchBar = true, void onSearchTap(List<ContactItemModel> data)?, String? searchHideText, Widget? listViewBackground, void onTap(BuildContext context, ContactItemModel model)?, void onLongPress(BuildContext context, ContactItemModel model)?, ChatUIKitContactItemBuilder? itemBuilder, ContactListViewController? controller, String? loadErrorMessage, List<NeedAlphabeticalWidget>? beforeItems, List<NeedAlphabeticalWidget>? afterItems, String? attributes, ChatUIKitViewObserver? viewObserver, String specialAlphabeticalLetter = '#', String? sortAlphabetical, void onSelectLetterChanged(BuildContext context, String? letter)?, bool enableSorting = true, bool showAlphabeticalIndicator = true, Key? key})
const
ContactsView.arguments(ContactsViewArguments arguments, {Key? key})

Properties

afterItems → List<NeedAlphabeticalWidget>?
联系人列表之后的数据。
final
appBarModel → ChatUIKitAppBarModel?
自定义消息页面 appBar。如不设置会使用默认的。
final
attributes → String?
View 附加属性，设置后的内容将会带入到下一个页面。
final
beforeItems → List<NeedAlphabeticalWidget>?
联系人列表之前的数据。
final
controller → ContactListViewController?
联系人列表控制器，用于控制联系人列表数据，如果不设置将会自动创建。详细参考 ContactListViewController。
final
enableAppBar → bool
是否显示AppBar, 默认为 true。 当为 false 时将不会显示AppBar。同时也会影响到是否显示标题。
final
enableSearchBar → bool
是否开启搜索框，默认为 true。如果设置为 false 将不会显示搜索框。
final
enableSorting → bool
是否进行首字母排序
final
hashCode → int
The hash code for this object.
no setterinherited
itemBuilder → ChatUIKitContactItemBuilder?
联系人列表的 item 构建器，如果设置后需要显示联系人时会直接回调，如果不处理可以返回 null。
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
listViewBackground → Widget?
联系人列表的背景，联系人为空时会显示，如果设置后将会替换默认的背景。
final
loadErrorMessage → String?
联系人列表的加载错误提示，如果设置后将会替换默认的错误提示。
final
onLongPress → void Function(BuildContext context, ContactItemModel model)?
长按联系人列表的回调，长按后会把当前的联系人数据传递过来。具体参考 ContactItemModel。
final
onSearchTap → void Function(List<ContactItemModel> data)?
点击搜索按钮的回调，点击后会把当前的联系人列表数据传递过来。如果不设置默认会跳转到搜索页面。具体参考 SearchView。
final
onSelectLetterChanged → void Function(BuildContext context, String? letter)?
final
onTap → void Function(BuildContext context, ContactItemModel model)?
点击联系人列表的回调，点击后会把当前的联系人数据传递过来。具体参考 ContactItemModel。 如果不是设置默认会跳转到联系人详情页面。具体参考 ContactDetailsView。
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
searchHideText → String?
联系人搜索框的隐藏文字。
final
showAlphabeticalIndicator → bool
是否显示字母索引
final
sortAlphabetical → String?
字母排序
final
specialAlphabeticalLetter → String
通讯录列表的字母排序默认字，默认为 '#'
final
viewObserver → ChatUIKitViewObserver?
用于刷新页面的Observer
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<ContactsView>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects 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, int wrapWidth = 65}) → 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