HomeController class - controller library

Constructors

HomeController(AuthService _auth, MyUserService _myUserService, AbstractSettingsRepository _settings, {bool signedUp = false, ChatDirectLinkSlug? link, BuildContext? context})

Properties

authStatus → Rx<RxStatus>: Returns user authentication status.
no setter
background → Rx<Uint8List?>: Returns the background's Uint8List.
no setter
chatsKey → GlobalKey<State<StatefulWidget>>: GlobalKey of a Chats button in the navigation bar.
final
context → BuildContext?: BuildContext of the HomeView.
final
hashCode → int: The hash code for this object.
no setterinherited
hasListeners → bool: no setterinherited
initialized → bool: Checks whether the controller has already been initialized.
no setterinherited
isClosed → bool: Checks whether the controller has already been closed.
no setterinherited
link → ChatDirectLinkSlug?: ChatDirectLinkSlug to display IntroductionView with.
final
listeners → int: no setterinherited
myUser → Rx<MyUser?>: Returns the currently authenticated MyUser.
no setter
onDelete → InternalFinalCallback<void>: Internal callback that starts the cycle of this controller.
finalinherited
onStart → InternalFinalCallback<void>: Called at the exact moment the widget is allocated in memory. It uses an internal "callable" type, to avoid any @overrides in subclases. This method should be internal and is required to define the lifetime cycle of the subclass.
finalinherited
page ↔ Rx<HomeTab>: Current pages HomeTab value.
latefinal
pages ↔ PageController: Controller of the PageView tab.
getter/setter pair
panelKey → GlobalKey<State<StatefulWidget>>: GlobalKey of a CustomNavigationBar displayed.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
settings → Rx<ApplicationSettings?>: Returns the current ApplicationSettings value.
no setter
sideBarAllowedWidth → double: Returns the width side bar is allowed to occupy.
no setter
sideBarWidth ↔ RxDouble: Current width of the side bar.
latefinal
signedUp → bool: Indicator whether the IntroductionView should be displayed with IntroductionViewStage.signUp initial stage.
final
tabs → List<HomeTab>: Returns the List of the HomeTabs to display.
no setter
unreadChats → RxInt: Reactive MyUser.unreadChatsCount value.
final

Methods

$configureLifeCycle() → void: inherited
addListener(GetStateUpdate listener) → Disposer: Register a closure to be called when the object notifies its listeners.
inherited
addListenerId(Object? key, GetStateUpdate listener) → Disposer: inherited
applySideBarWidth(BuildContext context, double width) → double: Returns corrected according to the side bar constraints width value.
dispose() → void: inherited
disposeId(Object id) → void: To dispose an id from future updates(), this ids are registered by GetBuilder() or similar, so is a way to unlink the state change with the Widget from the Controller.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
notifyChildrens() → void: inherited
onClose() → void: Called before onDelete method. onClose might be used to dispose resources used by the controller. Like closing events, or streams before the controller is destroyed. Or dispose objects that can potentially create some memory leaks, like TextEditingControllers, AnimationControllers. Might be useful as well to persist some data on disk.
override
onInit() → void: Called immediately after the widget is allocated in memory. You might use this to initialize something for the controller.
override
onReady() → void: Called 1 frame after onInit(). It is the perfect place to enter navigation events, like snackbar, dialogs, or a new route, or async request.
override
refresh() → void: inherited
refreshGroup(Object id) → void: inherited
removeListener(VoidCallback listener) → void: Remove a previously registered closure from the list of closures that the object notifies.
inherited
removeListenerId(Object id, VoidCallback listener) → void: inherited
setPresence(Presence presence) → Future<void>: Sets the MyUser.presence to the provided value.
setSideBarWidth() → Future<void>: Sets the current sideBarWidth as the sideBarAllowedWidth.
setWorkWithUsTabEnabled(bool enabled) → Future<void>: Sets the ApplicationSettings.workWithUsTabEnabled value.
toggleMute(bool enabled) → Future<void>: Toggles the MyUser.muted status.
toString() → String: A string representation of this object.
inherited
update([List<Object>? ids, bool condition = true]) → void: Rebuilds GetBuilder each time you call update(); Can take a List of ids, that will only update the matching GetBuilder( id: ), ids can be reused among GetBuilders like group tags. The update will only notify the Widgets, if condition is true.
inherited
updateAvatar() → Future<void>: Refreshes the MyUser to be up to date.

Operators

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

Constants

sideBarMaxWidthPercentage → const double: Maximal percentage of the screen's width which side bar can occupy.
sideBarMinWidth → const double: Minimal width of the side bar.