diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme-class.md b/docs/talawa-mobile-docs/apptheme/AppTheme-class.md index 517eacb479a..6ca449b62b7 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme-class.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme-class.md @@ -24,21 +24,21 @@ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -46,21 +46,21 @@ _read-onlyinherited_ ## Methods -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -68,12 +68,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ @@ -81,129 +81,129 @@ _inherited_ ## Static Properties -##### [bodyText1](../apptheme/AppTheme/bodyText1.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) +##### [bodyText1](../apptheme/AppTheme/bodyText1.md) ↔ [TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) -_read / write_ +_\read / write\_ -##### [bodyText2](../apptheme/AppTheme/bodyText2.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) +##### [bodyText2](../apptheme/AppTheme/bodyText2.md) ↔ [TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) -_read / write_ +_\read / write\_ -##### [bodyText3](../apptheme/AppTheme/bodyText3.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) +##### [bodyText3](../apptheme/AppTheme/bodyText3.md) ↔ [TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) -_read / write_ +_\read / write\_ -##### [button](../apptheme/AppTheme/button.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) +##### [button](../apptheme/AppTheme/button.md) ↔ [TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) -_read / write_ +_\read / write\_ -##### [headline1](../apptheme/AppTheme/headline1.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) +##### [headline1](../apptheme/AppTheme/headline1.md) ↔ [TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) -_read / write_ +_\read / write\_ -##### [headline2](../apptheme/AppTheme/headline2.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) +##### [headline2](../apptheme/AppTheme/headline2.md) ↔ [TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) -_read / write_ +_\read / write\_ -##### [headline3](../apptheme/AppTheme/headline3.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) +##### [headline3](../apptheme/AppTheme/headline3.md) ↔ [TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) -_read / write_ +_\read / write\_ -##### [headline4](../apptheme/AppTheme/headline4.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) +##### [headline4](../apptheme/AppTheme/headline4.md) ↔ [TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) -_read / write_ +_\read / write\_ -##### [headline5](../apptheme/AppTheme/headline5.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) +##### [headline5](../apptheme/AppTheme/headline5.md) ↔ [TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) -_read / write_ +_\read / write\_ -##### [headline6](../apptheme/AppTheme/headline6.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) +##### [headline6](../apptheme/AppTheme/headline6.md) ↔ [TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) -_read / write_ +_\read / write\_ -##### [overline](../apptheme/AppTheme/overline.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) +##### [overline](../apptheme/AppTheme/overline.md) ↔ [TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) -_read / write_ +_\read / write\_ -##### [subtitle1](../apptheme/AppTheme/subtitle1.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) +##### [subtitle1](../apptheme/AppTheme/subtitle1.md) ↔ [TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) -_read / write_ +_\read / write\_ -##### [subtitle2](../apptheme/AppTheme/subtitle2.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) +##### [subtitle2](../apptheme/AppTheme/subtitle2.md) ↔ [TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) -_read / write_ +_\read / write\_ -##### [title](../apptheme/AppTheme/title.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) +##### [title](../apptheme/AppTheme/title.md) ↔ [TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) -_read / write_ +_\read / write\_ @@ -214,7 +214,7 @@ _read / write_ ## Constants -##### [blackPrimary](../apptheme/AppTheme/blackPrimary-constant.md) const [Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) +##### [blackPrimary](../apptheme/AppTheme/blackPrimary-constant.md) const [Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) @@ -223,7 +223,7 @@ _read / write_ -##### [blackSecondary](../apptheme/AppTheme/blackSecondary-constant.md) const [Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) +##### [blackSecondary](../apptheme/AppTheme/blackSecondary-constant.md) const [Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) @@ -232,7 +232,7 @@ _read / write_ -##### [blackTertiary](../apptheme/AppTheme/blackTertiary-constant.md) const [Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) +##### [blackTertiary](../apptheme/AppTheme/blackTertiary-constant.md) const [Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) @@ -241,7 +241,7 @@ _read / write_ -##### [blue](../apptheme/AppTheme/blue-constant.md) const [Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) +##### [blue](../apptheme/AppTheme/blue-constant.md) const [Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) @@ -250,7 +250,7 @@ _read / write_ -##### [green](../apptheme/AppTheme/green-constant.md) const [Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) +##### [green](../apptheme/AppTheme/green-constant.md) const [Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) @@ -259,7 +259,7 @@ _read / write_ -##### [grey](../apptheme/AppTheme/grey-constant.md) const [Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) +##### [grey](../apptheme/AppTheme/grey-constant.md) const [Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) @@ -268,7 +268,7 @@ _read / write_ -##### [lightGrey](../apptheme/AppTheme/lightGrey-constant.md) const [Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) +##### [lightGrey](../apptheme/AppTheme/lightGrey-constant.md) const [Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) @@ -277,7 +277,7 @@ _read / write_ -##### [primary](../apptheme/AppTheme/primary-constant.md) const [Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) +##### [primary](../apptheme/AppTheme/primary-constant.md) const [Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) @@ -286,7 +286,7 @@ _read / write_ -##### [red](../apptheme/AppTheme/red-constant.md) const [Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) +##### [red](../apptheme/AppTheme/red-constant.md) const [Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) @@ -295,7 +295,7 @@ _read / write_ -##### [secondary](../apptheme/AppTheme/secondary-constant.md) const [Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) +##### [secondary](../apptheme/AppTheme/secondary-constant.md) const [Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) @@ -304,7 +304,7 @@ _read / write_ -##### [shadow](../apptheme/AppTheme/shadow-constant.md) const [Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) +##### [shadow](../apptheme/AppTheme/shadow-constant.md) const [Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) @@ -313,7 +313,7 @@ _read / write_ -##### [tertiary](../apptheme/AppTheme/tertiary-constant.md) const [Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) +##### [tertiary](../apptheme/AppTheme/tertiary-constant.md) const [Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) @@ -322,7 +322,7 @@ _read / write_ -##### [white](../apptheme/AppTheme/white-constant.md) const [Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) +##### [white](../apptheme/AppTheme/white-constant.md) const [Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) @@ -331,7 +331,7 @@ _read / write_ -##### [yellow](../apptheme/AppTheme/yellow-constant.md) const [Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) +##### [yellow](../apptheme/AppTheme/yellow-constant.md) const [Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/blackPrimary-constant.md b/docs/talawa-mobile-docs/apptheme/AppTheme/blackPrimary-constant.md index 19a5f30263a..2babee56c61 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/blackPrimary-constant.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/blackPrimary-constant.md @@ -9,7 +9,7 @@ -[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const blackPrimary +[Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) const blackPrimary diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/blackSecondary-constant.md b/docs/talawa-mobile-docs/apptheme/AppTheme/blackSecondary-constant.md index df8a790e643..9cda726a8e5 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/blackSecondary-constant.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/blackSecondary-constant.md @@ -9,7 +9,7 @@ -[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const blackSecondary +[Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) const blackSecondary diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/blackTertiary-constant.md b/docs/talawa-mobile-docs/apptheme/AppTheme/blackTertiary-constant.md index 67e61cceebd..776c2478b88 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/blackTertiary-constant.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/blackTertiary-constant.md @@ -9,7 +9,7 @@ -[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const blackTertiary +[Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) const blackTertiary diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/blue-constant.md b/docs/talawa-mobile-docs/apptheme/AppTheme/blue-constant.md index 3b83107b8d9..31676e5e50c 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/blue-constant.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/blue-constant.md @@ -9,7 +9,7 @@ -[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const blue +[Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) const blue diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/bodyText1.md b/docs/talawa-mobile-docs/apptheme/AppTheme/bodyText1.md index 1319aea9ae1..5c327879fd2 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/bodyText1.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/bodyText1.md @@ -9,9 +9,9 @@ -[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) bodyText1 +[TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) bodyText1 -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/bodyText2.md b/docs/talawa-mobile-docs/apptheme/AppTheme/bodyText2.md index 447738bd623..154e35fae40 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/bodyText2.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/bodyText2.md @@ -9,9 +9,9 @@ -[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) bodyText2 +[TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) bodyText2 -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/bodyText3.md b/docs/talawa-mobile-docs/apptheme/AppTheme/bodyText3.md index f5b90827104..8c3ff14e483 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/bodyText3.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/bodyText3.md @@ -9,9 +9,9 @@ -[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) bodyText3 +[TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) bodyText3 -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/button.md b/docs/talawa-mobile-docs/apptheme/AppTheme/button.md index 21a7c237e17..f59ee848ba8 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/button.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/button.md @@ -9,9 +9,9 @@ -[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) button +[TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) button -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/green-constant.md b/docs/talawa-mobile-docs/apptheme/AppTheme/green-constant.md index c5b360b4e67..88a5999b5a7 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/green-constant.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/green-constant.md @@ -9,7 +9,7 @@ -[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const green +[Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) const green diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/grey-constant.md b/docs/talawa-mobile-docs/apptheme/AppTheme/grey-constant.md index 78239681339..cda2ac4fbdf 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/grey-constant.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/grey-constant.md @@ -9,7 +9,7 @@ -[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const grey +[Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) const grey diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/headline1.md b/docs/talawa-mobile-docs/apptheme/AppTheme/headline1.md index 37af53874bb..5bed1593a00 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/headline1.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/headline1.md @@ -9,9 +9,9 @@ -[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) headline1 +[TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) headline1 -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/headline2.md b/docs/talawa-mobile-docs/apptheme/AppTheme/headline2.md index 66e649046f2..16f797d6e58 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/headline2.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/headline2.md @@ -9,9 +9,9 @@ -[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) headline2 +[TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) headline2 -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/headline3.md b/docs/talawa-mobile-docs/apptheme/AppTheme/headline3.md index c768808929a..dd1b48d4ce3 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/headline3.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/headline3.md @@ -9,9 +9,9 @@ -[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) headline3 +[TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) headline3 -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/headline4.md b/docs/talawa-mobile-docs/apptheme/AppTheme/headline4.md index 003c3628281..8049efdd23e 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/headline4.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/headline4.md @@ -9,9 +9,9 @@ -[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) headline4 +[TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) headline4 -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/headline5.md b/docs/talawa-mobile-docs/apptheme/AppTheme/headline5.md index ef7db3e5302..7e8ffc0260d 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/headline5.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/headline5.md @@ -9,9 +9,9 @@ -[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) headline5 +[TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) headline5 -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/headline6.md b/docs/talawa-mobile-docs/apptheme/AppTheme/headline6.md index 2928a6d0f8d..2b3b3ccb313 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/headline6.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/headline6.md @@ -9,9 +9,9 @@ -[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) headline6 +[TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) headline6 -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/lightGrey-constant.md b/docs/talawa-mobile-docs/apptheme/AppTheme/lightGrey-constant.md index 2eb849d4de1..90cf7190483 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/lightGrey-constant.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/lightGrey-constant.md @@ -9,7 +9,7 @@ -[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const lightGrey +[Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) const lightGrey diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/overline.md b/docs/talawa-mobile-docs/apptheme/AppTheme/overline.md index 8e21f35cfbe..a72fa674ebb 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/overline.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/overline.md @@ -9,9 +9,9 @@ -[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) overline +[TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) overline -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/primary-constant.md b/docs/talawa-mobile-docs/apptheme/AppTheme/primary-constant.md index 038d130c59f..0b4b2ec2e2e 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/primary-constant.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/primary-constant.md @@ -9,7 +9,7 @@ -[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const primary +[Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) const primary diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/red-constant.md b/docs/talawa-mobile-docs/apptheme/AppTheme/red-constant.md index 372e2ea7c29..07e251f6169 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/red-constant.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/red-constant.md @@ -9,7 +9,7 @@ -[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const red +[Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) const red diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/secondary-constant.md b/docs/talawa-mobile-docs/apptheme/AppTheme/secondary-constant.md index 1f36d46c990..8b61cc15460 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/secondary-constant.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/secondary-constant.md @@ -9,7 +9,7 @@ -[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const secondary +[Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) const secondary diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/shadow-constant.md b/docs/talawa-mobile-docs/apptheme/AppTheme/shadow-constant.md index 28767a56f97..4e0c0251b97 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/shadow-constant.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/shadow-constant.md @@ -9,7 +9,7 @@ -[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const shadow +[Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) const shadow diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/subtitle1.md b/docs/talawa-mobile-docs/apptheme/AppTheme/subtitle1.md index 7aa5a306dbd..794ebbfcfe3 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/subtitle1.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/subtitle1.md @@ -9,9 +9,9 @@ -[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) subtitle1 +[TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) subtitle1 -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/subtitle2.md b/docs/talawa-mobile-docs/apptheme/AppTheme/subtitle2.md index cb3d34fadcf..40c572ba3e7 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/subtitle2.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/subtitle2.md @@ -9,9 +9,9 @@ -[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) subtitle2 +[TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) subtitle2 -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/tertiary-constant.md b/docs/talawa-mobile-docs/apptheme/AppTheme/tertiary-constant.md index 020d4a1c34d..2652fcc607a 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/tertiary-constant.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/tertiary-constant.md @@ -9,7 +9,7 @@ -[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const tertiary +[Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) const tertiary diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/title.md b/docs/talawa-mobile-docs/apptheme/AppTheme/title.md index 21377023fc4..28333819dd0 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/title.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/title.md @@ -9,9 +9,9 @@ -[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) title +[TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html) title -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/white-constant.md b/docs/talawa-mobile-docs/apptheme/AppTheme/white-constant.md index 40ddf426ab7..8c2a2414a50 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/white-constant.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/white-constant.md @@ -9,7 +9,7 @@ -[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const white +[Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) const white diff --git a/docs/talawa-mobile-docs/apptheme/AppTheme/yellow-constant.md b/docs/talawa-mobile-docs/apptheme/AppTheme/yellow-constant.md index 19aedaf7406..ad286d412f8 100644 --- a/docs/talawa-mobile-docs/apptheme/AppTheme/yellow-constant.md +++ b/docs/talawa-mobile-docs/apptheme/AppTheme/yellow-constant.md @@ -9,7 +9,7 @@ -[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const yellow +[Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) const yellow diff --git a/docs/talawa-mobile-docs/constants_constants/constants_constants-library.md b/docs/talawa-mobile-docs/constants_constants/constants_constants-library.md index 0281be84bb0..49dff904848 100644 --- a/docs/talawa-mobile-docs/constants_constants/constants_constants-library.md +++ b/docs/talawa-mobile-docs/constants_constants/constants_constants-library.md @@ -20,21 +20,21 @@ ## Properties -##### [languages](../constants_constants/languages.md) ↔ [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Language](../models_language_language_model/Language-class.md)> +##### [languages](../constants_constants/languages.md) ↔ [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Language](../models_language_language_model/Language-class.md)\> This file contains the prototypes of all the languages available and supported currencies. -_read / write_ +_\read / write\_ -##### [supportedCurrencies](../constants_constants/supportedCurrencies.md) ↔ [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html)> +##### [supportedCurrencies](../constants_constants/supportedCurrencies.md) ↔ [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html)\> -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/constants_constants/languages.md b/docs/talawa-mobile-docs/constants_constants/languages.md index eb6fa823a8e..8cfe2bcc411 100644 --- a/docs/talawa-mobile-docs/constants_constants/languages.md +++ b/docs/talawa-mobile-docs/constants_constants/languages.md @@ -11,20 +11,20 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Language](../models_language_language_model/Language-class.md)> languages +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Language](../models_language_language_model/Language-class.md)\> languages -_read / write_ +_\read / write\_ -

This file contains the prototypes of all the languages available and supported currencies.

+\This file contains the prototypes of all the languages available and supported currencies.\ ## Implementation ```dart -List languages = [ +List\ languages = [ Language( countryCode: 'US', langCode: 'en', diff --git a/docs/talawa-mobile-docs/constants_constants/supportedCurrencies.md b/docs/talawa-mobile-docs/constants_constants/supportedCurrencies.md index 74339c22441..5b3727bc181 100644 --- a/docs/talawa-mobile-docs/constants_constants/supportedCurrencies.md +++ b/docs/talawa-mobile-docs/constants_constants/supportedCurrencies.md @@ -11,9 +11,9 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html)> supportedCurrencies +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html)\> supportedCurrencies -_read / write_ +_\read / write\_ @@ -23,7 +23,7 @@ _read / write_ ## Implementation ```dart -List supportedCurrencies = [ +List\ supportedCurrencies = [ 'AED', 'ALL', 'AMD', diff --git a/docs/talawa-mobile-docs/constants_custom_theme/TalawaTheme-class.md b/docs/talawa-mobile-docs/constants_custom_theme/TalawaTheme-class.md index 256b879933a..be9b90defaa 100644 --- a/docs/talawa-mobile-docs/constants_custom_theme/TalawaTheme-class.md +++ b/docs/talawa-mobile-docs/constants_custom_theme/TalawaTheme-class.md @@ -11,9 +11,9 @@ -

This file contains various custom themes. +\This file contains various custom themes. For instance, lightTheme, darkTheme, _lightTextTheme, _darkTextTheme, etc. -These are imported to other files/widgets to apply the required themes.

+These are imported to other files/widgets to apply the required themes.\ @@ -27,21 +27,21 @@ These are imported to other files/widgets to apply the required themes.

## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -49,21 +49,21 @@ _read-onlyinherited_ ## Methods -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -71,12 +71,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ @@ -84,21 +84,21 @@ _inherited_ ## Static Properties -##### [darkTheme](../constants_custom_theme/TalawaTheme/darkTheme.md) → [ThemeData](https://api.flutter.dev/flutter/material/ThemeData-class.html) +##### [darkTheme](../constants_custom_theme/TalawaTheme/darkTheme.md) → [ThemeData](https:api.flutter.dev/flutter/material/ThemeData-class.html) -_final_ +_\final\_ -##### [lightTheme](../constants_custom_theme/TalawaTheme/lightTheme.md) → [ThemeData](https://api.flutter.dev/flutter/material/ThemeData-class.html) +##### [lightTheme](../constants_custom_theme/TalawaTheme/lightTheme.md) → [ThemeData](https:api.flutter.dev/flutter/material/ThemeData-class.html) -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/constants_custom_theme/TalawaTheme/darkTheme.md b/docs/talawa-mobile-docs/constants_custom_theme/TalawaTheme/darkTheme.md index dba6e0b1087..50039ea914b 100644 --- a/docs/talawa-mobile-docs/constants_custom_theme/TalawaTheme/darkTheme.md +++ b/docs/talawa-mobile-docs/constants_custom_theme/TalawaTheme/darkTheme.md @@ -9,9 +9,9 @@ -[ThemeData](https://api.flutter.dev/flutter/material/ThemeData-class.html) darkTheme +[ThemeData](https:api.flutter.dev/flutter/material/ThemeData-class.html) darkTheme -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/constants_custom_theme/TalawaTheme/lightTheme.md b/docs/talawa-mobile-docs/constants_custom_theme/TalawaTheme/lightTheme.md index e47787d498f..78a4b868bae 100644 --- a/docs/talawa-mobile-docs/constants_custom_theme/TalawaTheme/lightTheme.md +++ b/docs/talawa-mobile-docs/constants_custom_theme/TalawaTheme/lightTheme.md @@ -9,9 +9,9 @@ -[ThemeData](https://api.flutter.dev/flutter/material/ThemeData-class.html) lightTheme +[ThemeData](https:api.flutter.dev/flutter/material/ThemeData-class.html) lightTheme -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/constants_quick_actions/ShortCutMenu-class.md b/docs/talawa-mobile-docs/constants_quick_actions/ShortCutMenu-class.md index b573a68b76e..1a67a717d45 100644 --- a/docs/talawa-mobile-docs/constants_quick_actions/ShortCutMenu-class.md +++ b/docs/talawa-mobile-docs/constants_quick_actions/ShortCutMenu-class.md @@ -11,8 +11,8 @@ -

This file contains the shortcuts by which user can manage and interact with the -application. quick_actions package is used for this purpose.

+\This file contains the shortcuts by which user can manage and interact with the +application. quick_actions package is used for this purpose.\ @@ -26,21 +26,21 @@ application. quick_actions package is used for this purpose.

## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -48,21 +48,21 @@ _read-onlyinherited_ ## Methods -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -70,12 +70,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ @@ -83,12 +83,12 @@ _inherited_ ## Static Properties -##### [quickActionsList](../constants_quick_actions/ShortCutMenu/quickActionsList.md) → [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[ShortcutItem](https://pub.dev/documentation/quick_actions_platform_interface/1.0.4/types_types/ShortcutItem-class.html)> +##### [quickActionsList](../constants_quick_actions/ShortCutMenu/quickActionsList.md) → [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[ShortcutItem](https:pub.dev/documentation/quick_actions_platform_interface/1.0.4/types_types/ShortcutItem-class.html)\> -_final_ +_\final\_ @@ -99,7 +99,7 @@ _final_ ## Constants -##### [chatAction](../constants_quick_actions/ShortCutMenu/chatAction-constant.md) const [ShortcutItem](https://pub.dev/documentation/quick_actions_platform_interface/1.0.4/types_types/ShortcutItem-class.html) +##### [chatAction](../constants_quick_actions/ShortCutMenu/chatAction-constant.md) const [ShortcutItem](https:pub.dev/documentation/quick_actions_platform_interface/1.0.4/types_types/ShortcutItem-class.html) @@ -108,7 +108,7 @@ _final_ -##### [eventAction](../constants_quick_actions/ShortCutMenu/eventAction-constant.md) const [ShortcutItem](https://pub.dev/documentation/quick_actions_platform_interface/1.0.4/types_types/ShortcutItem-class.html) +##### [eventAction](../constants_quick_actions/ShortCutMenu/eventAction-constant.md) const [ShortcutItem](https:pub.dev/documentation/quick_actions_platform_interface/1.0.4/types_types/ShortcutItem-class.html) @@ -117,7 +117,7 @@ _final_ -##### [feedAction](../constants_quick_actions/ShortCutMenu/feedAction-constant.md) const [ShortcutItem](https://pub.dev/documentation/quick_actions_platform_interface/1.0.4/types_types/ShortcutItem-class.html) +##### [feedAction](../constants_quick_actions/ShortCutMenu/feedAction-constant.md) const [ShortcutItem](https:pub.dev/documentation/quick_actions_platform_interface/1.0.4/types_types/ShortcutItem-class.html) diff --git a/docs/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/chatAction-constant.md b/docs/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/chatAction-constant.md index 2ae5a950695..d3b9b123cd7 100644 --- a/docs/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/chatAction-constant.md +++ b/docs/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/chatAction-constant.md @@ -9,7 +9,7 @@ -[ShortcutItem](https://pub.dev/documentation/quick_actions_platform_interface/1.0.4/types_types/ShortcutItem-class.html) const chatAction +[ShortcutItem](https:pub.dev/documentation/quick_actions_platform_interface/1.0.4/types_types/ShortcutItem-class.html) const chatAction diff --git a/docs/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/eventAction-constant.md b/docs/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/eventAction-constant.md index a01744fc61b..10f70cdf94b 100644 --- a/docs/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/eventAction-constant.md +++ b/docs/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/eventAction-constant.md @@ -9,7 +9,7 @@ -[ShortcutItem](https://pub.dev/documentation/quick_actions_platform_interface/1.0.4/types_types/ShortcutItem-class.html) const eventAction +[ShortcutItem](https:pub.dev/documentation/quick_actions_platform_interface/1.0.4/types_types/ShortcutItem-class.html) const eventAction diff --git a/docs/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/feedAction-constant.md b/docs/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/feedAction-constant.md index e0417a7afad..0f36238d4e3 100644 --- a/docs/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/feedAction-constant.md +++ b/docs/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/feedAction-constant.md @@ -9,7 +9,7 @@ -[ShortcutItem](https://pub.dev/documentation/quick_actions_platform_interface/1.0.4/types_types/ShortcutItem-class.html) const feedAction +[ShortcutItem](https:pub.dev/documentation/quick_actions_platform_interface/1.0.4/types_types/ShortcutItem-class.html) const feedAction diff --git a/docs/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/quickActionsList.md b/docs/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/quickActionsList.md index bc88489487f..6bc7516ac7d 100644 --- a/docs/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/quickActionsList.md +++ b/docs/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/quickActionsList.md @@ -9,9 +9,9 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[ShortcutItem](https://pub.dev/documentation/quick_actions_platform_interface/1.0.4/types_types/ShortcutItem-class.html)> quickActionsList +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[ShortcutItem](https:pub.dev/documentation/quick_actions_platform_interface/1.0.4/types_types/ShortcutItem-class.html)\> quickActionsList -_final_ +_\final\_ @@ -21,7 +21,7 @@ _final_ ## Implementation ```dart -static final quickActionsList = [ +static final quickActionsList = \[ eventAction, feedAction, chatAction diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes-class.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes-class.md index 50814616d70..fd3aa810ec5 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes-class.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes-class.md @@ -11,7 +11,7 @@ -

This file contains the routes. These can be used to make push screen call via Routes.splashScreen to access these string.

+\This file contains the routes. These can be used to make push screen call via Routes.splashScreen to access these string.\ @@ -25,21 +25,21 @@ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -47,21 +47,21 @@ _read-onlyinherited_ ## Methods -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -69,12 +69,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ @@ -87,7 +87,7 @@ _inherited_ ## Constants -##### [addTask](../constants_routing_constants/Routes/addTask-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [addTask](../constants_routing_constants/Routes/addTask-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -96,7 +96,7 @@ static variables. -##### [appSettings](../constants_routing_constants/Routes/appSettings-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [appSettings](../constants_routing_constants/Routes/appSettings-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -105,7 +105,7 @@ static variables. -##### [calendar](../constants_routing_constants/Routes/calendar-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [calendar](../constants_routing_constants/Routes/calendar-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -114,7 +114,7 @@ static variables. -##### [chatMessageScreen](../constants_routing_constants/Routes/chatMessageScreen-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [chatMessageScreen](../constants_routing_constants/Routes/chatMessageScreen-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -123,7 +123,7 @@ static variables. -##### [createEventPage](../constants_routing_constants/Routes/createEventPage-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [createEventPage](../constants_routing_constants/Routes/createEventPage-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -132,7 +132,7 @@ static variables. -##### [demoPageViewRoute](../constants_routing_constants/Routes/demoPageViewRoute-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [demoPageViewRoute](../constants_routing_constants/Routes/demoPageViewRoute-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -141,7 +141,7 @@ static variables. -##### [editEventPage](../constants_routing_constants/Routes/editEventPage-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [editEventPage](../constants_routing_constants/Routes/editEventPage-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -150,7 +150,7 @@ static variables. -##### [editProfilePage](../constants_routing_constants/Routes/editProfilePage-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [editProfilePage](../constants_routing_constants/Routes/editProfilePage-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -159,7 +159,7 @@ static variables. -##### [editTask](../constants_routing_constants/Routes/editTask-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [editTask](../constants_routing_constants/Routes/editTask-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -168,7 +168,7 @@ static variables. -##### [eventInfoPage](../constants_routing_constants/Routes/eventInfoPage-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [eventInfoPage](../constants_routing_constants/Routes/eventInfoPage-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -177,7 +177,7 @@ static variables. -##### [eventTasks](../constants_routing_constants/Routes/eventTasks-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [eventTasks](../constants_routing_constants/Routes/eventTasks-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -186,7 +186,7 @@ static variables. -##### [exploreEventsScreen](../constants_routing_constants/Routes/exploreEventsScreen-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [exploreEventsScreen](../constants_routing_constants/Routes/exploreEventsScreen-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -195,7 +195,7 @@ static variables. -##### [homeScreen](../constants_routing_constants/Routes/homeScreen-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [homeScreen](../constants_routing_constants/Routes/homeScreen-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -204,7 +204,7 @@ static variables. -##### [individualPost](../constants_routing_constants/Routes/individualPost-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [individualPost](../constants_routing_constants/Routes/individualPost-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -213,7 +213,7 @@ static variables. -##### [joinOrg](../constants_routing_constants/Routes/joinOrg-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [joinOrg](../constants_routing_constants/Routes/joinOrg-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -222,7 +222,7 @@ static variables. -##### [languageSelectionRoute](../constants_routing_constants/Routes/languageSelectionRoute-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [languageSelectionRoute](../constants_routing_constants/Routes/languageSelectionRoute-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -231,7 +231,7 @@ static variables. -##### [loginScreen](../constants_routing_constants/Routes/loginScreen-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [loginScreen](../constants_routing_constants/Routes/loginScreen-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -240,7 +240,7 @@ static variables. -##### [mainScreen](../constants_routing_constants/Routes/mainScreen-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [mainScreen](../constants_routing_constants/Routes/mainScreen-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -249,7 +249,7 @@ static variables. -##### [mapScreen](../constants_routing_constants/Routes/mapScreen-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [mapScreen](../constants_routing_constants/Routes/mapScreen-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -258,7 +258,7 @@ static variables. -##### [pinnedPostPage](../constants_routing_constants/Routes/pinnedPostPage-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [pinnedPostPage](../constants_routing_constants/Routes/pinnedPostPage-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -267,7 +267,7 @@ static variables. -##### [profilePage](../constants_routing_constants/Routes/profilePage-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [profilePage](../constants_routing_constants/Routes/profilePage-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -276,7 +276,7 @@ static variables. -##### [progressDialog](../constants_routing_constants/Routes/progressDialog-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [progressDialog](../constants_routing_constants/Routes/progressDialog-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -285,7 +285,7 @@ static variables. -##### [recoverScreen](../constants_routing_constants/Routes/recoverScreen-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [recoverScreen](../constants_routing_constants/Routes/recoverScreen-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -294,7 +294,7 @@ static variables. -##### [requestAccess](../constants_routing_constants/Routes/requestAccess-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [requestAccess](../constants_routing_constants/Routes/requestAccess-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -303,7 +303,7 @@ static variables. -##### [selectContact](../constants_routing_constants/Routes/selectContact-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [selectContact](../constants_routing_constants/Routes/selectContact-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -312,7 +312,7 @@ static variables. -##### [selectOrgScreen](../constants_routing_constants/Routes/selectOrgScreen-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [selectOrgScreen](../constants_routing_constants/Routes/selectOrgScreen-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -321,7 +321,7 @@ static variables. -##### [setUrlScreen](../constants_routing_constants/Routes/setUrlScreen-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [setUrlScreen](../constants_routing_constants/Routes/setUrlScreen-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -330,7 +330,7 @@ static variables. -##### [signupDetailScreen](../constants_routing_constants/Routes/signupDetailScreen-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [signupDetailScreen](../constants_routing_constants/Routes/signupDetailScreen-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -339,7 +339,7 @@ static variables. -##### [splashScreen](../constants_routing_constants/Routes/splashScreen-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [splashScreen](../constants_routing_constants/Routes/splashScreen-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -348,7 +348,7 @@ static variables. -##### [updateScreen](../constants_routing_constants/Routes/updateScreen-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [updateScreen](../constants_routing_constants/Routes/updateScreen-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -357,7 +357,7 @@ static variables. -##### [userTasks](../constants_routing_constants/Routes/userTasks-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [userTasks](../constants_routing_constants/Routes/userTasks-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -366,7 +366,7 @@ static variables. -##### [waitingScreen](../constants_routing_constants/Routes/waitingScreen-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [waitingScreen](../constants_routing_constants/Routes/waitingScreen-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/addTask-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/addTask-constant.md index 76913081540..e433b916162 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/addTask-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/addTask-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const addTask +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const addTask -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/appSettings-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/appSettings-constant.md index 055c9cc619d..39af1f03cf2 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/appSettings-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/appSettings-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const appSettings +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const appSettings -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/calendar-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/calendar-constant.md index e68f3aef8e7..ae01834f36b 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/calendar-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/calendar-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const calendar +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const calendar -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/chatMessageScreen-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/chatMessageScreen-constant.md index 143ffb1c3f5..8ab3ae34260 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/chatMessageScreen-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/chatMessageScreen-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const chatMessageScreen +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const chatMessageScreen -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/createEventPage-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/createEventPage-constant.md index cbc75f3c327..170500de2ab 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/createEventPage-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/createEventPage-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const createEventPage +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const createEventPage -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/demoPageViewRoute-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/demoPageViewRoute-constant.md index 4872c8cc567..0149edfe69f 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/demoPageViewRoute-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/demoPageViewRoute-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const demoPageViewRoute +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const demoPageViewRoute -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/editEventPage-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/editEventPage-constant.md index 37189f5363d..f456af33c89 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/editEventPage-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/editEventPage-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const editEventPage +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const editEventPage -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/editProfilePage-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/editProfilePage-constant.md index eeb2fae2462..8513af122f7 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/editProfilePage-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/editProfilePage-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const editProfilePage +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const editProfilePage -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/editTask-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/editTask-constant.md index 8dce26712c8..498c2556c5f 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/editTask-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/editTask-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const editTask +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const editTask -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/eventInfoPage-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/eventInfoPage-constant.md index d40a818cc5c..7b12e592a26 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/eventInfoPage-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/eventInfoPage-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const eventInfoPage +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const eventInfoPage -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/eventTasks-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/eventTasks-constant.md index 5f1ae456596..029dc892c66 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/eventTasks-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/eventTasks-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const eventTasks +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const eventTasks -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/exploreEventsScreen-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/exploreEventsScreen-constant.md index 49d7f4b781f..a52d051257c 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/exploreEventsScreen-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/exploreEventsScreen-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const exploreEventsScreen +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const exploreEventsScreen -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/homeScreen-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/homeScreen-constant.md index 2e5038d9be6..c54e6b85d6e 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/homeScreen-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/homeScreen-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const homeScreen +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const homeScreen -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/individualPost-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/individualPost-constant.md index 8e90b10afbe..cd628182f7f 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/individualPost-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/individualPost-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const individualPost +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const individualPost -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/joinOrg-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/joinOrg-constant.md index b15ae144311..6ed547598dd 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/joinOrg-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/joinOrg-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const joinOrg +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const joinOrg -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/languageSelectionRoute-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/languageSelectionRoute-constant.md index c44d80fa2ff..8bcaedae1dc 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/languageSelectionRoute-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/languageSelectionRoute-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const languageSelectionRoute +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const languageSelectionRoute -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/loginScreen-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/loginScreen-constant.md index 8fec21cdf15..7e8bfb0c0b0 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/loginScreen-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/loginScreen-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const loginScreen +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const loginScreen -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/mainScreen-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/mainScreen-constant.md index ea0792a531e..83dfa0d5532 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/mainScreen-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/mainScreen-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const mainScreen +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const mainScreen -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/mapScreen-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/mapScreen-constant.md index b4e93a646d1..8425569f008 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/mapScreen-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/mapScreen-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const mapScreen +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const mapScreen -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/pinnedPostPage-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/pinnedPostPage-constant.md index c818d6e26d3..c14211df384 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/pinnedPostPage-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/pinnedPostPage-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const pinnedPostPage +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const pinnedPostPage -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/profilePage-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/profilePage-constant.md index c81e48b5682..8acba0b0629 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/profilePage-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/profilePage-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const profilePage +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const profilePage -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/progressDialog-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/progressDialog-constant.md index 9b8fc0437a4..6ea78bde8fe 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/progressDialog-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/progressDialog-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const progressDialog +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const progressDialog -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/recoverScreen-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/recoverScreen-constant.md index ec709fd3872..1b577ed4131 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/recoverScreen-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/recoverScreen-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const recoverScreen +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const recoverScreen -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/requestAccess-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/requestAccess-constant.md index 1107d1e0b9e..3dc60d75438 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/requestAccess-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/requestAccess-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const requestAccess +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const requestAccess -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/selectContact-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/selectContact-constant.md index 7f8f9c69ec1..c0958991b55 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/selectContact-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/selectContact-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const selectContact +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const selectContact -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/selectOrgScreen-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/selectOrgScreen-constant.md index 23c3b5949a3..e2aa48f12ad 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/selectOrgScreen-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/selectOrgScreen-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const selectOrgScreen +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const selectOrgScreen -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/setUrlScreen-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/setUrlScreen-constant.md index e3231e3acd2..5cd2895af64 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/setUrlScreen-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/setUrlScreen-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const setUrlScreen +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const setUrlScreen -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/signupDetailScreen-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/signupDetailScreen-constant.md index 1d2c8746715..bae6fb71ac0 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/signupDetailScreen-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/signupDetailScreen-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const signupDetailScreen +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const signupDetailScreen -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/splashScreen-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/splashScreen-constant.md index b2fdcfbfadd..770d94e09c1 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/splashScreen-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/splashScreen-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const splashScreen +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const splashScreen -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/updateScreen-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/updateScreen-constant.md index 5264a460fb2..03a205e9001 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/updateScreen-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/updateScreen-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const updateScreen +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const updateScreen -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/userTasks-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/userTasks-constant.md index 13241dbafbc..4f1c2023272 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/userTasks-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/userTasks-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const userTasks +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const userTasks -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_routing_constants/Routes/waitingScreen-constant.md b/docs/talawa-mobile-docs/constants_routing_constants/Routes/waitingScreen-constant.md index 14dea52eb69..ec92c930657 100644 --- a/docs/talawa-mobile-docs/constants_routing_constants/Routes/waitingScreen-constant.md +++ b/docs/talawa-mobile-docs/constants_routing_constants/Routes/waitingScreen-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const waitingScreen +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const waitingScreen -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/constants_timeout/TimeOuts-class.md b/docs/talawa-mobile-docs/constants_timeout/TimeOuts-class.md index b85d9801ee8..cae30c607e4 100644 --- a/docs/talawa-mobile-docs/constants_timeout/TimeOuts-class.md +++ b/docs/talawa-mobile-docs/constants_timeout/TimeOuts-class.md @@ -11,7 +11,7 @@ -

Class to define constant timeout to bring consistency in the code.

+\Class to define constant timeout to bring consistency in the code.\ @@ -25,21 +25,21 @@ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -47,21 +47,21 @@ _read-onlyinherited_ ## Methods -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -69,12 +69,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ @@ -87,7 +87,7 @@ _inherited_ ## Constants -##### [large](../constants_timeout/TimeOuts/large-constant.md) const [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [large](../constants_timeout/TimeOuts/large-constant.md) const [int](https:api.flutter.dev/flutter/dart-core/int-class.html) @@ -96,7 +96,7 @@ For large timeout, used for large data fetch. -##### [mediums](../constants_timeout/TimeOuts/mediums-constant.md) const [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [mediums](../constants_timeout/TimeOuts/mediums-constant.md) const [int](https:api.flutter.dev/flutter/dart-core/int-class.html) @@ -105,7 +105,7 @@ For medium timeout, used for medium data fetch. -##### [small](../constants_timeout/TimeOuts/small-constant.md) const [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [small](../constants_timeout/TimeOuts/small-constant.md) const [int](https:api.flutter.dev/flutter/dart-core/int-class.html) diff --git a/docs/talawa-mobile-docs/constants_timeout/TimeOuts/large-constant.md b/docs/talawa-mobile-docs/constants_timeout/TimeOuts/large-constant.md index 06ea1ae7859..52592f55673 100644 --- a/docs/talawa-mobile-docs/constants_timeout/TimeOuts/large-constant.md +++ b/docs/talawa-mobile-docs/constants_timeout/TimeOuts/large-constant.md @@ -9,13 +9,13 @@ -[int](https://api.flutter.dev/flutter/dart-core/int-class.html) const large +[int](https:api.flutter.dev/flutter/dart-core/int-class.html) const large -

For large timeout, used for large data fetch.

+\For large timeout, used for large data fetch.\ diff --git a/docs/talawa-mobile-docs/constants_timeout/TimeOuts/mediums-constant.md b/docs/talawa-mobile-docs/constants_timeout/TimeOuts/mediums-constant.md index c481d6b877d..d8f6325c64e 100644 --- a/docs/talawa-mobile-docs/constants_timeout/TimeOuts/mediums-constant.md +++ b/docs/talawa-mobile-docs/constants_timeout/TimeOuts/mediums-constant.md @@ -9,13 +9,13 @@ -[int](https://api.flutter.dev/flutter/dart-core/int-class.html) const mediums +[int](https:api.flutter.dev/flutter/dart-core/int-class.html) const mediums -

For medium timeout, used for medium data fetch.

+\For medium timeout, used for medium data fetch.\ diff --git a/docs/talawa-mobile-docs/constants_timeout/TimeOuts/small-constant.md b/docs/talawa-mobile-docs/constants_timeout/TimeOuts/small-constant.md index 3fce2b60683..33383ddf87d 100644 --- a/docs/talawa-mobile-docs/constants_timeout/TimeOuts/small-constant.md +++ b/docs/talawa-mobile-docs/constants_timeout/TimeOuts/small-constant.md @@ -9,13 +9,13 @@ -[int](https://api.flutter.dev/flutter/dart-core/int-class.html) const small +[int](https:api.flutter.dev/flutter/dart-core/int-class.html) const small -

For small timeout, used for small data fetch.

+\For small timeout, used for small data fetch.\ diff --git a/docs/talawa-mobile-docs/custom_painters_language_icon/LanguageIcon-class.md b/docs/talawa-mobile-docs/custom_painters_language_icon/LanguageIcon-class.md index a05ca02ba1e..b6f1e01d5f5 100644 --- a/docs/talawa-mobile-docs/custom_painters_language_icon/LanguageIcon-class.md +++ b/docs/talawa-mobile-docs/custom_painters_language_icon/LanguageIcon-class.md @@ -11,17 +11,17 @@ -

This class draws the language icon using custom paint. +\This class draws the language icon using custom paint. CustomPaint is a widget from the Flutter SDK, which enables -you to use a canvas to draw different shapes.

+you to use a canvas to draw different shapes.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [Listenable](https://api.flutter.dev/flutter/foundation/Listenable-class.html) -- [CustomPainter](https://api.flutter.dev/flutter/rendering/CustomPainter-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [Listenable](https:api.flutter.dev/flutter/foundation/Listenable-class.html) +- [CustomPainter](https:api.flutter.dev/flutter/rendering/CustomPainter-class.html) - LanguageIcon @@ -40,31 +40,31 @@ you to use a canvas to draw different shapes.

## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [semanticsBuilder](https://api.flutter.dev/flutter/rendering/CustomPainter/semanticsBuilder.html) → [SemanticsBuilderCallback](https://api.flutter.dev/flutter/rendering/SemanticsBuilderCallback.html)? +##### [semanticsBuilder](https:api.flutter.dev/flutter/rendering/CustomPainter/semanticsBuilder.html) → [SemanticsBuilderCallback](https:api.flutter.dev/flutter/rendering/SemanticsBuilderCallback.html)? Returns a function that builds semantic information for the picture drawn by this painter. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -72,87 +72,87 @@ _read-onlyinherited_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/rendering/CustomPainter/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/rendering/CustomPainter/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be notified when it is time to repaint. -_inherited_ +_\inherited\_ -##### [hitTest](https://api.flutter.dev/flutter/rendering/CustomPainter/hitTest.html)([Offset](https://api.flutter.dev/flutter/dart-ui/Offset-class.html) position) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? +##### [hitTest](https:api.flutter.dev/flutter/rendering/CustomPainter/hitTest.html)([Offset](https:api.flutter.dev/flutter/dart-ui/Offset-class.html) position) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? Called whenever a hit test is being performed on an object that is using this custom paint delegate. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [paint](../custom_painters_language_icon/LanguageIcon/paint.md)([Canvas](https://api.flutter.dev/flutter/dart-ui/Canvas-class.html) canvas, [Size](https://api.flutter.dev/flutter/dart-ui/Size-class.html) size) void +##### [paint](../custom_painters_language_icon/LanguageIcon/paint.md)([Canvas](https:api.flutter.dev/flutter/dart-ui/Canvas-class.html) canvas, [Size](https:api.flutter.dev/flutter/dart-ui/Size-class.html) size) void -Called whenever the object needs to paint. The given Canvas has its +Called whenever the object needs to paint. The given \Canvas\ has its coordinate space configured such that the origin is at the top left of the -box. The area of the box is the size of the size argument. -_override_ +box. The area of the box is the size of the \size\ argument. +_\override\_ -##### [removeListener](https://api.flutter.dev/flutter/rendering/CustomPainter/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/rendering/CustomPainter/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that the object notifies when it is time to repaint. -_inherited_ +_\inherited\_ -##### [shouldRebuildSemantics](https://api.flutter.dev/flutter/rendering/CustomPainter/shouldRebuildSemantics.html)(covariant [CustomPainter](https://api.flutter.dev/flutter/rendering/CustomPainter-class.html) oldDelegate) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [shouldRebuildSemantics](https:api.flutter.dev/flutter/rendering/CustomPainter/shouldRebuildSemantics.html)(covariant [CustomPainter](https:api.flutter.dev/flutter/rendering/CustomPainter-class.html) oldDelegate) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Called whenever a new instance of the custom painter delegate class is -provided to the RenderCustomPaint object, or any time that a new -CustomPaint object is created with a new instance of the custom painter +provided to the \RenderCustomPaint\ object, or any time that a new +\CustomPaint\ object is created with a new instance of the custom painter delegate class (which amounts to the same thing, because the latter is implemented in terms of the former). -_inherited_ +_\inherited\_ -##### [shouldRepaint](../custom_painters_language_icon/LanguageIcon/shouldRepaint.md)(covariant [CustomPainter](https://api.flutter.dev/flutter/rendering/CustomPainter-class.html) oldDelegate) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [shouldRepaint](../custom_painters_language_icon/LanguageIcon/shouldRepaint.md)(covariant [CustomPainter](https:api.flutter.dev/flutter/rendering/CustomPainter-class.html) oldDelegate) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Called whenever a new instance of the custom painter delegate class is -provided to the RenderCustomPaint object, or any time that a new -CustomPaint object is created with a new instance of the custom painter +provided to the \RenderCustomPaint\ object, or any time that a new +\CustomPaint\ object is created with a new instance of the custom painter delegate class (which amounts to the same thing, because the latter is implemented in terms of the former). -_override_ +_\override\_ -##### [toString](https://api.flutter.dev/flutter/rendering/CustomPainter/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/rendering/CustomPainter/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -160,12 +160,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/custom_painters_language_icon/LanguageIcon/paint.md b/docs/talawa-mobile-docs/custom_painters_language_icon/LanguageIcon/paint.md index ef9042c71cf..8ca828aa458 100644 --- a/docs/talawa-mobile-docs/custom_painters_language_icon/LanguageIcon/paint.md +++ b/docs/talawa-mobile-docs/custom_painters_language_icon/LanguageIcon/paint.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) void paint -([Canvas](https://api.flutter.dev/flutter/dart-ui/Canvas-class.html) canvas, [Size](https://api.flutter.dev/flutter/dart-ui/Size-class.html) size) +([Canvas](https:api.flutter.dev/flutter/dart-ui/Canvas-class.html) canvas, [Size](https:api.flutter.dev/flutter/dart-ui/Size-class.html) size) -_override_ +_\override\_ -

Called whenever the object needs to paint. The given Canvas has its +\Called whenever the object needs to paint. The given \Canvas\ has its coordinate space configured such that the origin is at the top left of the -box. The area of the box is the size of the size argument.

-

Paint operations should remain inside the given area. Graphical +box. The area of the box is the size of the \size\ argument.\ +\Paint operations should remain inside the given area. Graphical operations outside the bounds may be silently ignored, clipped, or not clipped. It may sometimes be difficult to guarantee that a certain operation is inside the bounds (e.g., drawing a rectangle whose size is determined by user inputs). In that case, consider calling -Canvas.clipRect at the beginning of paint so everything that follows -will be guaranteed to only draw within the clipped area.

-

Implementations should be wary of correctly pairing any calls to -Canvas.save/Canvas.saveLayer and Canvas.restore, otherwise all +\Canvas.clipRect\ at the beginning of \paint\ so everything that follows +will be guaranteed to only draw within the clipped area.\ +\Implementations should be wary of correctly pairing any calls to +\Canvas.save\/\Canvas.saveLayer\ and \Canvas.restore\, otherwise all subsequent painting on this canvas may be affected, with potentially -hilarious but confusing results.

-

To paint text on a Canvas, use a TextPainter.

-

To paint an image on a Canvas:

-
    -
  1. -

    Obtain an ImageStream, for example by calling ImageProvider.resolve -on an AssetImage or NetworkImage object.

    -
  2. -
  3. -

    Whenever the ImageStream's underlying ImageInfo object changes -(see ImageStream.addListener), create a new instance of your custom -paint delegate, giving it the new ImageInfo object.

    -
  4. -
  5. -

    In your delegate's paint method, call the Canvas.drawImage, -Canvas.drawImageRect, or Canvas.drawImageNine methods to paint the -ImageInfo.image object, applying the ImageInfo.scale value to -obtain the correct rendering size.

    -
  6. -
+hilarious but confusing results.\ +\To paint text on a \Canvas\, use a \TextPainter\.\ +\To paint an image on a \Canvas\:\ +\ +\ +\Obtain an \ImageStream\, for example by calling \ImageProvider.resolve\ +on an \AssetImage\ or \NetworkImage\ object.\ +\ +\ +\Whenever the \ImageStream\'s underlying \ImageInfo\ object changes +(see \ImageStream.addListener\), create a new instance of your custom +paint delegate, giving it the new \ImageInfo\ object.\ +\ +\ +\In your delegate's \paint\ method, call the \Canvas.drawImage\, +\Canvas.drawImageRect\, or \Canvas.drawImageNine\ methods to paint the +\ImageInfo.image\ object, applying the \ImageInfo.scale\ value to +obtain the correct rendering size.\ +\ +\ @@ -58,7 +58,7 @@ obtain the correct rendering size.

```dart @override -void paint(Canvas canvas, Size size) { +void paint(Canvas canvas, Size size) \{ final Path path_0 = Path(); path_0.moveTo(size.width * 0.2376568, size.height * 0.4381250); path_0.cubicTo( @@ -371,7 +371,7 @@ void paint(Canvas canvas, Size size) { final Paint paint0fill = Paint()..style = PaintingStyle.fill; paint0fill.color = const Color(0xff737373).withOpacity(1.0); canvas.drawPath(path_0, paint0fill); -} +\} ``` diff --git a/docs/talawa-mobile-docs/custom_painters_language_icon/LanguageIcon/shouldRepaint.md b/docs/talawa-mobile-docs/custom_painters_language_icon/LanguageIcon/shouldRepaint.md index a74a9cec459..fd9a0c97124 100644 --- a/docs/talawa-mobile-docs/custom_painters_language_icon/LanguageIcon/shouldRepaint.md +++ b/docs/talawa-mobile-docs/custom_painters_language_icon/LanguageIcon/shouldRepaint.md @@ -9,35 +9,35 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) shouldRepaint -(covariant [CustomPainter](https://api.flutter.dev/flutter/rendering/CustomPainter-class.html) oldDelegate) +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) shouldRepaint +(covariant [CustomPainter](https:api.flutter.dev/flutter/rendering/CustomPainter-class.html) oldDelegate) -_override_ +_\override\_ -

Called whenever a new instance of the custom painter delegate class is -provided to the RenderCustomPaint object, or any time that a new -CustomPaint object is created with a new instance of the custom painter +\Called whenever a new instance of the custom painter delegate class is +provided to the \RenderCustomPaint\ object, or any time that a new +\CustomPaint\ object is created with a new instance of the custom painter delegate class (which amounts to the same thing, because the latter is -implemented in terms of the former).

-

If the new instance represents different information than the old +implemented in terms of the former).\ +\If the new instance represents different information than the old instance, then the method should return true, otherwise it should return -false.

-

If the method returns false, then the paint call might be optimized -away.

-

It's possible that the paint method will get called even if -shouldRepaint returns false (e.g. if an ancestor or descendant needed to -be repainted). It's also possible that the paint method will get called -without shouldRepaint being called at all (e.g. if the box changes -size).

-

If a custom delegate has a particularly expensive paint function such that -repaints should be avoided as much as possible, a RepaintBoundary or -RenderRepaintBoundary (or other render object with -RenderObject.isRepaintBoundary set to true) might be helpful.

-

The oldDelegate argument will never be null.

+false.\ +\If the method returns false, then the \paint\ call might be optimized +away.\ +\It's possible that the \paint\ method will get called even if +\shouldRepaint\ returns false (e.g. if an ancestor or descendant needed to +be repainted). It's also possible that the \paint\ method will get called +without \shouldRepaint\ being called at all (e.g. if the box changes +size).\ +\If a custom delegate has a particularly expensive paint function such that +repaints should be avoided as much as possible, a \RepaintBoundary\ or +\RenderRepaintBoundary\ (or other render object with +\RenderObject.isRepaintBoundary\ set to true) might be helpful.\ +\The \oldDelegate\ argument will never be null.\ @@ -45,9 +45,9 @@ repaints should be avoided as much as possible, a read-only
inherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [semanticsBuilder](https://api.flutter.dev/flutter/rendering/CustomPainter/semanticsBuilder.html) → [SemanticsBuilderCallback](https://api.flutter.dev/flutter/rendering/SemanticsBuilderCallback.html)? +##### [semanticsBuilder](https:api.flutter.dev/flutter/rendering/CustomPainter/semanticsBuilder.html) → [SemanticsBuilderCallback](https:api.flutter.dev/flutter/rendering/SemanticsBuilderCallback.html)? Returns a function that builds semantic information for the picture drawn by this painter. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -72,87 +72,87 @@ _read-onlyinherited_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/rendering/CustomPainter/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/rendering/CustomPainter/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be notified when it is time to repaint. -_inherited_ +_\inherited\_ -##### [hitTest](https://api.flutter.dev/flutter/rendering/CustomPainter/hitTest.html)([Offset](https://api.flutter.dev/flutter/dart-ui/Offset-class.html) position) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? +##### [hitTest](https:api.flutter.dev/flutter/rendering/CustomPainter/hitTest.html)([Offset](https:api.flutter.dev/flutter/dart-ui/Offset-class.html) position) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? Called whenever a hit test is being performed on an object that is using this custom paint delegate. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [paint](../custom_painters_talawa_logo/AppLogo/paint.md)([Canvas](https://api.flutter.dev/flutter/dart-ui/Canvas-class.html) canvas, [Size](https://api.flutter.dev/flutter/dart-ui/Size-class.html) size) void +##### [paint](../custom_painters_talawa_logo/AppLogo/paint.md)([Canvas](https:api.flutter.dev/flutter/dart-ui/Canvas-class.html) canvas, [Size](https:api.flutter.dev/flutter/dart-ui/Size-class.html) size) void -Called whenever the object needs to paint. The given Canvas has its +Called whenever the object needs to paint. The given \Canvas\ has its coordinate space configured such that the origin is at the top left of the -box. The area of the box is the size of the size argument. -_override_ +box. The area of the box is the size of the \size\ argument. +_\override\_ -##### [removeListener](https://api.flutter.dev/flutter/rendering/CustomPainter/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/rendering/CustomPainter/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that the object notifies when it is time to repaint. -_inherited_ +_\inherited\_ -##### [shouldRebuildSemantics](https://api.flutter.dev/flutter/rendering/CustomPainter/shouldRebuildSemantics.html)(covariant [CustomPainter](https://api.flutter.dev/flutter/rendering/CustomPainter-class.html) oldDelegate) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [shouldRebuildSemantics](https:api.flutter.dev/flutter/rendering/CustomPainter/shouldRebuildSemantics.html)(covariant [CustomPainter](https:api.flutter.dev/flutter/rendering/CustomPainter-class.html) oldDelegate) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Called whenever a new instance of the custom painter delegate class is -provided to the RenderCustomPaint object, or any time that a new -CustomPaint object is created with a new instance of the custom painter +provided to the \RenderCustomPaint\ object, or any time that a new +\CustomPaint\ object is created with a new instance of the custom painter delegate class (which amounts to the same thing, because the latter is implemented in terms of the former). -_inherited_ +_\inherited\_ -##### [shouldRepaint](../custom_painters_talawa_logo/AppLogo/shouldRepaint.md)(covariant [CustomPainter](https://api.flutter.dev/flutter/rendering/CustomPainter-class.html) oldDelegate) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [shouldRepaint](../custom_painters_talawa_logo/AppLogo/shouldRepaint.md)(covariant [CustomPainter](https:api.flutter.dev/flutter/rendering/CustomPainter-class.html) oldDelegate) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Called whenever a new instance of the custom painter delegate class is -provided to the RenderCustomPaint object, or any time that a new -CustomPaint object is created with a new instance of the custom painter +provided to the \RenderCustomPaint\ object, or any time that a new +\CustomPaint\ object is created with a new instance of the custom painter delegate class (which amounts to the same thing, because the latter is implemented in terms of the former). -_override_ +_\override\_ -##### [toString](https://api.flutter.dev/flutter/rendering/CustomPainter/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/rendering/CustomPainter/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -160,12 +160,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/custom_painters_talawa_logo/AppLogo/paint.md b/docs/talawa-mobile-docs/custom_painters_talawa_logo/AppLogo/paint.md index 0dc5d605621..72d4fee2d90 100644 --- a/docs/talawa-mobile-docs/custom_painters_talawa_logo/AppLogo/paint.md +++ b/docs/talawa-mobile-docs/custom_painters_talawa_logo/AppLogo/paint.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) void paint -([Canvas](https://api.flutter.dev/flutter/dart-ui/Canvas-class.html) canvas, [Size](https://api.flutter.dev/flutter/dart-ui/Size-class.html) size) +([Canvas](https:api.flutter.dev/flutter/dart-ui/Canvas-class.html) canvas, [Size](https:api.flutter.dev/flutter/dart-ui/Size-class.html) size) -_override_ +_\override\_ -

Called whenever the object needs to paint. The given Canvas has its +\Called whenever the object needs to paint. The given \Canvas\ has its coordinate space configured such that the origin is at the top left of the -box. The area of the box is the size of the size argument.

-

Paint operations should remain inside the given area. Graphical +box. The area of the box is the size of the \size\ argument.\ +\Paint operations should remain inside the given area. Graphical operations outside the bounds may be silently ignored, clipped, or not clipped. It may sometimes be difficult to guarantee that a certain operation is inside the bounds (e.g., drawing a rectangle whose size is determined by user inputs). In that case, consider calling -Canvas.clipRect at the beginning of paint so everything that follows -will be guaranteed to only draw within the clipped area.

-

Implementations should be wary of correctly pairing any calls to -Canvas.save/Canvas.saveLayer and Canvas.restore, otherwise all +\Canvas.clipRect\ at the beginning of \paint\ so everything that follows +will be guaranteed to only draw within the clipped area.\ +\Implementations should be wary of correctly pairing any calls to +\Canvas.save\/\Canvas.saveLayer\ and \Canvas.restore\, otherwise all subsequent painting on this canvas may be affected, with potentially -hilarious but confusing results.

-

To paint text on a Canvas, use a TextPainter.

-

To paint an image on a Canvas:

-
    -
  1. -

    Obtain an ImageStream, for example by calling ImageProvider.resolve -on an AssetImage or NetworkImage object.

    -
  2. -
  3. -

    Whenever the ImageStream's underlying ImageInfo object changes -(see ImageStream.addListener), create a new instance of your custom -paint delegate, giving it the new ImageInfo object.

    -
  4. -
  5. -

    In your delegate's paint method, call the Canvas.drawImage, -Canvas.drawImageRect, or Canvas.drawImageNine methods to paint the -ImageInfo.image object, applying the ImageInfo.scale value to -obtain the correct rendering size.

    -
  6. -
+hilarious but confusing results.\ +\To paint text on a \Canvas\, use a \TextPainter\.\ +\To paint an image on a \Canvas\:\ +\ +\ +\Obtain an \ImageStream\, for example by calling \ImageProvider.resolve\ +on an \AssetImage\ or \NetworkImage\ object.\ +\ +\ +\Whenever the \ImageStream\'s underlying \ImageInfo\ object changes +(see \ImageStream.addListener\), create a new instance of your custom +paint delegate, giving it the new \ImageInfo\ object.\ +\ +\ +\In your delegate's \paint\ method, call the \Canvas.drawImage\, +\Canvas.drawImageRect\, or \Canvas.drawImageNine\ methods to paint the +\ImageInfo.image\ object, applying the \ImageInfo.scale\ value to +obtain the correct rendering size.\ +\ +\ @@ -58,7 +58,7 @@ obtain the correct rendering size.

```dart @override -void paint(Canvas canvas, Size size) { +void paint(Canvas canvas, Size size) \{ final Path path_0 = Path(); path_0.moveTo(size.width * 0.6581984, size.height * 0.6200040); path_0.cubicTo( @@ -474,7 +474,7 @@ void paint(Canvas canvas, Size size) { final Paint paint3fill = Paint()..style = PaintingStyle.fill; paint3fill.color = const Color(0xff737373).withOpacity(1.0); canvas.drawPath(path_3, paint3fill); -} +\} ``` diff --git a/docs/talawa-mobile-docs/custom_painters_talawa_logo/AppLogo/shouldRepaint.md b/docs/talawa-mobile-docs/custom_painters_talawa_logo/AppLogo/shouldRepaint.md index bbd772e40ab..4ca1ff74685 100644 --- a/docs/talawa-mobile-docs/custom_painters_talawa_logo/AppLogo/shouldRepaint.md +++ b/docs/talawa-mobile-docs/custom_painters_talawa_logo/AppLogo/shouldRepaint.md @@ -9,35 +9,35 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) shouldRepaint -(covariant [CustomPainter](https://api.flutter.dev/flutter/rendering/CustomPainter-class.html) oldDelegate) +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) shouldRepaint +(covariant [CustomPainter](https:api.flutter.dev/flutter/rendering/CustomPainter-class.html) oldDelegate) -_override_ +_\override\_ -

Called whenever a new instance of the custom painter delegate class is -provided to the RenderCustomPaint object, or any time that a new -CustomPaint object is created with a new instance of the custom painter +\Called whenever a new instance of the custom painter delegate class is +provided to the \RenderCustomPaint\ object, or any time that a new +\CustomPaint\ object is created with a new instance of the custom painter delegate class (which amounts to the same thing, because the latter is -implemented in terms of the former).

-

If the new instance represents different information than the old +implemented in terms of the former).\ +\If the new instance represents different information than the old instance, then the method should return true, otherwise it should return -false.

-

If the method returns false, then the paint call might be optimized -away.

-

It's possible that the paint method will get called even if -shouldRepaint returns false (e.g. if an ancestor or descendant needed to -be repainted). It's also possible that the paint method will get called -without shouldRepaint being called at all (e.g. if the box changes -size).

-

If a custom delegate has a particularly expensive paint function such that -repaints should be avoided as much as possible, a RepaintBoundary or -RenderRepaintBoundary (or other render object with -RenderObject.isRepaintBoundary set to true) might be helpful.

-

The oldDelegate argument will never be null.

+false.\ +\If the method returns false, then the \paint\ call might be optimized +away.\ +\It's possible that the \paint\ method will get called even if +\shouldRepaint\ returns false (e.g. if an ancestor or descendant needed to +be repainted). It's also possible that the \paint\ method will get called +without \shouldRepaint\ being called at all (e.g. if the box changes +size).\ +\If a custom delegate has a particularly expensive paint function such that +repaints should be avoided as much as possible, a \RepaintBoundary\ or +\RenderRepaintBoundary\ (or other render object with +\RenderObject.isRepaintBoundary\ set to true) might be helpful.\ +\The \oldDelegate\ argument will never be null.\ @@ -45,9 +45,9 @@ repaints should be avoided as much as possible, a read-only
inherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [semanticsBuilder](https://api.flutter.dev/flutter/rendering/CustomPainter/semanticsBuilder.html) → [SemanticsBuilderCallback](https://api.flutter.dev/flutter/rendering/SemanticsBuilderCallback.html)? +##### [semanticsBuilder](https:api.flutter.dev/flutter/rendering/CustomPainter/semanticsBuilder.html) → [SemanticsBuilderCallback](https:api.flutter.dev/flutter/rendering/SemanticsBuilderCallback.html)? Returns a function that builds semantic information for the picture drawn by this painter. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -72,87 +72,87 @@ _read-onlyinherited_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/rendering/CustomPainter/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/rendering/CustomPainter/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be notified when it is time to repaint. -_inherited_ +_\inherited\_ -##### [hitTest](https://api.flutter.dev/flutter/rendering/CustomPainter/hitTest.html)([Offset](https://api.flutter.dev/flutter/dart-ui/Offset-class.html) position) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? +##### [hitTest](https:api.flutter.dev/flutter/rendering/CustomPainter/hitTest.html)([Offset](https:api.flutter.dev/flutter/dart-ui/Offset-class.html) position) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? Called whenever a hit test is being performed on an object that is using this custom paint delegate. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [paint](../custom_painters_telegram_logo/TelegramLogo/paint.md)([Canvas](https://api.flutter.dev/flutter/dart-ui/Canvas-class.html) canvas, [Size](https://api.flutter.dev/flutter/dart-ui/Size-class.html) size) void +##### [paint](../custom_painters_telegram_logo/TelegramLogo/paint.md)([Canvas](https:api.flutter.dev/flutter/dart-ui/Canvas-class.html) canvas, [Size](https:api.flutter.dev/flutter/dart-ui/Size-class.html) size) void -Called whenever the object needs to paint. The given Canvas has its +Called whenever the object needs to paint. The given \Canvas\ has its coordinate space configured such that the origin is at the top left of the -box. The area of the box is the size of the size argument. -_override_ +box. The area of the box is the size of the \size\ argument. +_\override\_ -##### [removeListener](https://api.flutter.dev/flutter/rendering/CustomPainter/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/rendering/CustomPainter/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that the object notifies when it is time to repaint. -_inherited_ +_\inherited\_ -##### [shouldRebuildSemantics](https://api.flutter.dev/flutter/rendering/CustomPainter/shouldRebuildSemantics.html)(covariant [CustomPainter](https://api.flutter.dev/flutter/rendering/CustomPainter-class.html) oldDelegate) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [shouldRebuildSemantics](https:api.flutter.dev/flutter/rendering/CustomPainter/shouldRebuildSemantics.html)(covariant [CustomPainter](https:api.flutter.dev/flutter/rendering/CustomPainter-class.html) oldDelegate) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Called whenever a new instance of the custom painter delegate class is -provided to the RenderCustomPaint object, or any time that a new -CustomPaint object is created with a new instance of the custom painter +provided to the \RenderCustomPaint\ object, or any time that a new +\CustomPaint\ object is created with a new instance of the custom painter delegate class (which amounts to the same thing, because the latter is implemented in terms of the former). -_inherited_ +_\inherited\_ -##### [shouldRepaint](../custom_painters_telegram_logo/TelegramLogo/shouldRepaint.md)(covariant [CustomPainter](https://api.flutter.dev/flutter/rendering/CustomPainter-class.html) oldDelegate) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [shouldRepaint](../custom_painters_telegram_logo/TelegramLogo/shouldRepaint.md)(covariant [CustomPainter](https:api.flutter.dev/flutter/rendering/CustomPainter-class.html) oldDelegate) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Called whenever a new instance of the custom painter delegate class is -provided to the RenderCustomPaint object, or any time that a new -CustomPaint object is created with a new instance of the custom painter +provided to the \RenderCustomPaint\ object, or any time that a new +\CustomPaint\ object is created with a new instance of the custom painter delegate class (which amounts to the same thing, because the latter is implemented in terms of the former). -_override_ +_\override\_ -##### [toString](https://api.flutter.dev/flutter/rendering/CustomPainter/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/rendering/CustomPainter/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -160,12 +160,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/custom_painters_telegram_logo/TelegramLogo/paint.md b/docs/talawa-mobile-docs/custom_painters_telegram_logo/TelegramLogo/paint.md index fdec6895d49..8ef1ed98d58 100644 --- a/docs/talawa-mobile-docs/custom_painters_telegram_logo/TelegramLogo/paint.md +++ b/docs/talawa-mobile-docs/custom_painters_telegram_logo/TelegramLogo/paint.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) void paint -([Canvas](https://api.flutter.dev/flutter/dart-ui/Canvas-class.html) canvas, [Size](https://api.flutter.dev/flutter/dart-ui/Size-class.html) size) +([Canvas](https:api.flutter.dev/flutter/dart-ui/Canvas-class.html) canvas, [Size](https:api.flutter.dev/flutter/dart-ui/Size-class.html) size) -_override_ +_\override\_ -

Called whenever the object needs to paint. The given Canvas has its +\Called whenever the object needs to paint. The given \Canvas\ has its coordinate space configured such that the origin is at the top left of the -box. The area of the box is the size of the size argument.

-

Paint operations should remain inside the given area. Graphical +box. The area of the box is the size of the \size\ argument.\ +\Paint operations should remain inside the given area. Graphical operations outside the bounds may be silently ignored, clipped, or not clipped. It may sometimes be difficult to guarantee that a certain operation is inside the bounds (e.g., drawing a rectangle whose size is determined by user inputs). In that case, consider calling -Canvas.clipRect at the beginning of paint so everything that follows -will be guaranteed to only draw within the clipped area.

-

Implementations should be wary of correctly pairing any calls to -Canvas.save/Canvas.saveLayer and Canvas.restore, otherwise all +\Canvas.clipRect\ at the beginning of \paint\ so everything that follows +will be guaranteed to only draw within the clipped area.\ +\Implementations should be wary of correctly pairing any calls to +\Canvas.save\/\Canvas.saveLayer\ and \Canvas.restore\, otherwise all subsequent painting on this canvas may be affected, with potentially -hilarious but confusing results.

-

To paint text on a Canvas, use a TextPainter.

-

To paint an image on a Canvas:

-
    -
  1. -

    Obtain an ImageStream, for example by calling ImageProvider.resolve -on an AssetImage or NetworkImage object.

    -
  2. -
  3. -

    Whenever the ImageStream's underlying ImageInfo object changes -(see ImageStream.addListener), create a new instance of your custom -paint delegate, giving it the new ImageInfo object.

    -
  4. -
  5. -

    In your delegate's paint method, call the Canvas.drawImage, -Canvas.drawImageRect, or Canvas.drawImageNine methods to paint the -ImageInfo.image object, applying the ImageInfo.scale value to -obtain the correct rendering size.

    -
  6. -
+hilarious but confusing results.\ +\To paint text on a \Canvas\, use a \TextPainter\.\ +\To paint an image on a \Canvas\:\ +\ +\ +\Obtain an \ImageStream\, for example by calling \ImageProvider.resolve\ +on an \AssetImage\ or \NetworkImage\ object.\ +\ +\ +\Whenever the \ImageStream\'s underlying \ImageInfo\ object changes +(see \ImageStream.addListener\), create a new instance of your custom +paint delegate, giving it the new \ImageInfo\ object.\ +\ +\ +\In your delegate's \paint\ method, call the \Canvas.drawImage\, +\Canvas.drawImageRect\, or \Canvas.drawImageNine\ methods to paint the +\ImageInfo.image\ object, applying the \ImageInfo.scale\ value to +obtain the correct rendering size.\ +\ +\ @@ -58,7 +58,7 @@ obtain the correct rendering size.

```dart @override -void paint(Canvas canvas, Size size) { +void paint(Canvas canvas, Size size) \{ final Paint paint0Fill = Paint()..style = PaintingStyle.fill; paint0Fill.shader = ui.Gradient.linear( Offset(size.width * 0.6670000, size.height * 0.1670000), @@ -160,7 +160,7 @@ void paint(Canvas canvas, Size size) { 1 ]); canvas.drawPath(path_3, paint3Fill); -} +\} ``` diff --git a/docs/talawa-mobile-docs/custom_painters_telegram_logo/TelegramLogo/shouldRepaint.md b/docs/talawa-mobile-docs/custom_painters_telegram_logo/TelegramLogo/shouldRepaint.md index 255d4828a65..1a7b602caab 100644 --- a/docs/talawa-mobile-docs/custom_painters_telegram_logo/TelegramLogo/shouldRepaint.md +++ b/docs/talawa-mobile-docs/custom_painters_telegram_logo/TelegramLogo/shouldRepaint.md @@ -9,35 +9,35 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) shouldRepaint -(covariant [CustomPainter](https://api.flutter.dev/flutter/rendering/CustomPainter-class.html) oldDelegate) +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) shouldRepaint +(covariant [CustomPainter](https:api.flutter.dev/flutter/rendering/CustomPainter-class.html) oldDelegate) -_override_ +_\override\_ -

Called whenever a new instance of the custom painter delegate class is -provided to the RenderCustomPaint object, or any time that a new -CustomPaint object is created with a new instance of the custom painter +\Called whenever a new instance of the custom painter delegate class is +provided to the \RenderCustomPaint\ object, or any time that a new +\CustomPaint\ object is created with a new instance of the custom painter delegate class (which amounts to the same thing, because the latter is -implemented in terms of the former).

-

If the new instance represents different information than the old +implemented in terms of the former).\ +\If the new instance represents different information than the old instance, then the method should return true, otherwise it should return -false.

-

If the method returns false, then the paint call might be optimized -away.

-

It's possible that the paint method will get called even if -shouldRepaint returns false (e.g. if an ancestor or descendant needed to -be repainted). It's also possible that the paint method will get called -without shouldRepaint being called at all (e.g. if the box changes -size).

-

If a custom delegate has a particularly expensive paint function such that -repaints should be avoided as much as possible, a RepaintBoundary or -RenderRepaintBoundary (or other render object with -RenderObject.isRepaintBoundary set to true) might be helpful.

-

The oldDelegate argument will never be null.

+false.\ +\If the method returns false, then the \paint\ call might be optimized +away.\ +\It's possible that the \paint\ method will get called even if +\shouldRepaint\ returns false (e.g. if an ancestor or descendant needed to +be repainted). It's also possible that the \paint\ method will get called +without \shouldRepaint\ being called at all (e.g. if the box changes +size).\ +\If a custom delegate has a particularly expensive paint function such that +repaints should be avoided as much as possible, a \RepaintBoundary\ or +\RenderRepaintBoundary\ (or other render object with +\RenderObject.isRepaintBoundary\ set to true) might be helpful.\ +\The \oldDelegate\ argument will never be null.\ @@ -45,9 +45,9 @@ repaints should be avoided as much as possible, a read-only
inherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [semanticsBuilder](https://api.flutter.dev/flutter/rendering/CustomPainter/semanticsBuilder.html) → [SemanticsBuilderCallback](https://api.flutter.dev/flutter/rendering/SemanticsBuilderCallback.html)? +##### [semanticsBuilder](https:api.flutter.dev/flutter/rendering/CustomPainter/semanticsBuilder.html) → [SemanticsBuilderCallback](https:api.flutter.dev/flutter/rendering/SemanticsBuilderCallback.html)? Returns a function that builds semantic information for the picture drawn by this painter. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -72,87 +72,87 @@ _read-onlyinherited_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/rendering/CustomPainter/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/rendering/CustomPainter/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be notified when it is time to repaint. -_inherited_ +_\inherited\_ -##### [hitTest](https://api.flutter.dev/flutter/rendering/CustomPainter/hitTest.html)([Offset](https://api.flutter.dev/flutter/dart-ui/Offset-class.html) position) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? +##### [hitTest](https:api.flutter.dev/flutter/rendering/CustomPainter/hitTest.html)([Offset](https:api.flutter.dev/flutter/dart-ui/Offset-class.html) position) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? Called whenever a hit test is being performed on an object that is using this custom paint delegate. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [paint](../custom_painters_whatsapp_logo/WhatsappLogo/paint.md)([Canvas](https://api.flutter.dev/flutter/dart-ui/Canvas-class.html) canvas, [Size](https://api.flutter.dev/flutter/dart-ui/Size-class.html) size) void +##### [paint](../custom_painters_whatsapp_logo/WhatsappLogo/paint.md)([Canvas](https:api.flutter.dev/flutter/dart-ui/Canvas-class.html) canvas, [Size](https:api.flutter.dev/flutter/dart-ui/Size-class.html) size) void -Called whenever the object needs to paint. The given Canvas has its +Called whenever the object needs to paint. The given \Canvas\ has its coordinate space configured such that the origin is at the top left of the -box. The area of the box is the size of the size argument. -_override_ +box. The area of the box is the size of the \size\ argument. +_\override\_ -##### [removeListener](https://api.flutter.dev/flutter/rendering/CustomPainter/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/rendering/CustomPainter/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that the object notifies when it is time to repaint. -_inherited_ +_\inherited\_ -##### [shouldRebuildSemantics](https://api.flutter.dev/flutter/rendering/CustomPainter/shouldRebuildSemantics.html)(covariant [CustomPainter](https://api.flutter.dev/flutter/rendering/CustomPainter-class.html) oldDelegate) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [shouldRebuildSemantics](https:api.flutter.dev/flutter/rendering/CustomPainter/shouldRebuildSemantics.html)(covariant [CustomPainter](https:api.flutter.dev/flutter/rendering/CustomPainter-class.html) oldDelegate) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Called whenever a new instance of the custom painter delegate class is -provided to the RenderCustomPaint object, or any time that a new -CustomPaint object is created with a new instance of the custom painter +provided to the \RenderCustomPaint\ object, or any time that a new +\CustomPaint\ object is created with a new instance of the custom painter delegate class (which amounts to the same thing, because the latter is implemented in terms of the former). -_inherited_ +_\inherited\_ -##### [shouldRepaint](../custom_painters_whatsapp_logo/WhatsappLogo/shouldRepaint.md)(covariant [CustomPainter](https://api.flutter.dev/flutter/rendering/CustomPainter-class.html) oldDelegate) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [shouldRepaint](../custom_painters_whatsapp_logo/WhatsappLogo/shouldRepaint.md)(covariant [CustomPainter](https:api.flutter.dev/flutter/rendering/CustomPainter-class.html) oldDelegate) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Called whenever a new instance of the custom painter delegate class is -provided to the RenderCustomPaint object, or any time that a new -CustomPaint object is created with a new instance of the custom painter +provided to the \RenderCustomPaint\ object, or any time that a new +\CustomPaint\ object is created with a new instance of the custom painter delegate class (which amounts to the same thing, because the latter is implemented in terms of the former). -_override_ +_\override\_ -##### [toString](https://api.flutter.dev/flutter/rendering/CustomPainter/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/rendering/CustomPainter/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -160,12 +160,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/custom_painters_whatsapp_logo/WhatsappLogo/paint.md b/docs/talawa-mobile-docs/custom_painters_whatsapp_logo/WhatsappLogo/paint.md index ff1a5a712d7..74858231e29 100644 --- a/docs/talawa-mobile-docs/custom_painters_whatsapp_logo/WhatsappLogo/paint.md +++ b/docs/talawa-mobile-docs/custom_painters_whatsapp_logo/WhatsappLogo/paint.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) void paint -([Canvas](https://api.flutter.dev/flutter/dart-ui/Canvas-class.html) canvas, [Size](https://api.flutter.dev/flutter/dart-ui/Size-class.html) size) +([Canvas](https:api.flutter.dev/flutter/dart-ui/Canvas-class.html) canvas, [Size](https:api.flutter.dev/flutter/dart-ui/Size-class.html) size) -_override_ +_\override\_ -

Called whenever the object needs to paint. The given Canvas has its +\Called whenever the object needs to paint. The given \Canvas\ has its coordinate space configured such that the origin is at the top left of the -box. The area of the box is the size of the size argument.

-

Paint operations should remain inside the given area. Graphical +box. The area of the box is the size of the \size\ argument.\ +\Paint operations should remain inside the given area. Graphical operations outside the bounds may be silently ignored, clipped, or not clipped. It may sometimes be difficult to guarantee that a certain operation is inside the bounds (e.g., drawing a rectangle whose size is determined by user inputs). In that case, consider calling -Canvas.clipRect at the beginning of paint so everything that follows -will be guaranteed to only draw within the clipped area.

-

Implementations should be wary of correctly pairing any calls to -Canvas.save/Canvas.saveLayer and Canvas.restore, otherwise all +\Canvas.clipRect\ at the beginning of \paint\ so everything that follows +will be guaranteed to only draw within the clipped area.\ +\Implementations should be wary of correctly pairing any calls to +\Canvas.save\/\Canvas.saveLayer\ and \Canvas.restore\, otherwise all subsequent painting on this canvas may be affected, with potentially -hilarious but confusing results.

-

To paint text on a Canvas, use a TextPainter.

-

To paint an image on a Canvas:

-
    -
  1. -

    Obtain an ImageStream, for example by calling ImageProvider.resolve -on an AssetImage or NetworkImage object.

    -
  2. -
  3. -

    Whenever the ImageStream's underlying ImageInfo object changes -(see ImageStream.addListener), create a new instance of your custom -paint delegate, giving it the new ImageInfo object.

    -
  4. -
  5. -

    In your delegate's paint method, call the Canvas.drawImage, -Canvas.drawImageRect, or Canvas.drawImageNine methods to paint the -ImageInfo.image object, applying the ImageInfo.scale value to -obtain the correct rendering size.

    -
  6. -
+hilarious but confusing results.\ +\To paint text on a \Canvas\, use a \TextPainter\.\ +\To paint an image on a \Canvas\:\ +\ +\ +\Obtain an \ImageStream\, for example by calling \ImageProvider.resolve\ +on an \AssetImage\ or \NetworkImage\ object.\ +\ +\ +\Whenever the \ImageStream\'s underlying \ImageInfo\ object changes +(see \ImageStream.addListener\), create a new instance of your custom +paint delegate, giving it the new \ImageInfo\ object.\ +\ +\ +\In your delegate's \paint\ method, call the \Canvas.drawImage\, +\Canvas.drawImageRect\, or \Canvas.drawImageNine\ methods to paint the +\ImageInfo.image\ object, applying the \ImageInfo.scale\ value to +obtain the correct rendering size.\ +\ +\ @@ -58,7 +58,7 @@ obtain the correct rendering size.

```dart @override -void paint(Canvas canvas, Size size) { +void paint(Canvas canvas, Size size) \{ final Path path_0 = Path(); path_0.moveTo(size.width * 0.3580000, size.height * 0.1673307); path_0.cubicTo( @@ -474,7 +474,7 @@ void paint(Canvas canvas, Size size) { final Paint paint1fill = Paint()..style = PaintingStyle.fill; paint1fill.color = const Color(0xfffcfcfc).withOpacity(1.0); canvas.drawPath(path_1, paint1fill); -} +\} ``` diff --git a/docs/talawa-mobile-docs/custom_painters_whatsapp_logo/WhatsappLogo/shouldRepaint.md b/docs/talawa-mobile-docs/custom_painters_whatsapp_logo/WhatsappLogo/shouldRepaint.md index 886f0bbbba7..cfe3e8f7edd 100644 --- a/docs/talawa-mobile-docs/custom_painters_whatsapp_logo/WhatsappLogo/shouldRepaint.md +++ b/docs/talawa-mobile-docs/custom_painters_whatsapp_logo/WhatsappLogo/shouldRepaint.md @@ -9,35 +9,35 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) shouldRepaint -(covariant [CustomPainter](https://api.flutter.dev/flutter/rendering/CustomPainter-class.html) oldDelegate) +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) shouldRepaint +(covariant [CustomPainter](https:api.flutter.dev/flutter/rendering/CustomPainter-class.html) oldDelegate) -_override_ +_\override\_ -

Called whenever a new instance of the custom painter delegate class is -provided to the RenderCustomPaint object, or any time that a new -CustomPaint object is created with a new instance of the custom painter +\Called whenever a new instance of the custom painter delegate class is +provided to the \RenderCustomPaint\ object, or any time that a new +\CustomPaint\ object is created with a new instance of the custom painter delegate class (which amounts to the same thing, because the latter is -implemented in terms of the former).

-

If the new instance represents different information than the old +implemented in terms of the former).\ +\If the new instance represents different information than the old instance, then the method should return true, otherwise it should return -false.

-

If the method returns false, then the paint call might be optimized -away.

-

It's possible that the paint method will get called even if -shouldRepaint returns false (e.g. if an ancestor or descendant needed to -be repainted). It's also possible that the paint method will get called -without shouldRepaint being called at all (e.g. if the box changes -size).

-

If a custom delegate has a particularly expensive paint function such that -repaints should be avoided as much as possible, a RepaintBoundary or -RenderRepaintBoundary (or other render object with -RenderObject.isRepaintBoundary set to true) might be helpful.

-

The oldDelegate argument will never be null.

+false.\ +\If the method returns false, then the \paint\ call might be optimized +away.\ +\It's possible that the \paint\ method will get called even if +\shouldRepaint\ returns false (e.g. if an ancestor or descendant needed to +be repainted). It's also possible that the \paint\ method will get called +without \shouldRepaint\ being called at all (e.g. if the box changes +size).\ +\If a custom delegate has a particularly expensive paint function such that +repaints should be avoided as much as possible, a \RepaintBoundary\ or +\RenderRepaintBoundary\ (or other render object with +\RenderObject.isRepaintBoundary\ set to true) might be helpful.\ +\The \oldDelegate\ argument will never be null.\ @@ -45,9 +45,9 @@ repaints should be avoided as much as possible, a > +##### [eventsDemoData](../demo_server_data_events_demo_data/eventsDemoData-constant.md) const [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html)\>\> diff --git a/docs/talawa-mobile-docs/demo_server_data_events_demo_data/eventsDemoData-constant.md b/docs/talawa-mobile-docs/demo_server_data_events_demo_data/eventsDemoData-constant.md index 72455cde722..003956be32a 100644 --- a/docs/talawa-mobile-docs/demo_server_data_events_demo_data/eventsDemoData-constant.md +++ b/docs/talawa-mobile-docs/demo_server_data_events_demo_data/eventsDemoData-constant.md @@ -11,14 +11,14 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html)>> const eventsDemoData +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html)\>\> const eventsDemoData -

This file contains demo data. It contains a list of type Map<String, Object> -and sample data of events.

+\This file contains demo data. It contains a list of type Map<String, Object> +and sample data of events.\ @@ -26,7 +26,7 @@ and sample data of events.

```dart const eventsDemoData = [ - { + \{ "title": "Calculus", "description": "This course introduces calculus using analytic geometry functions. Topics include limits and continuity, derivatives, optimization, related rates, graphing and other applications of derivatives, definite and indefinite integrals, and numerical integration.", @@ -42,38 +42,38 @@ const eventsDemoData = [ "isPublic": "true", "isSubscribed": "false", "isRegisterable": "true", - "creator": { + "creator": \{ "firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd" - }, + \}, "registrants": [ - {"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"}, - {"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"}, - {"firstName": "Warren", "lastName": "Buff", "_id": "asdasdasd"}, - {"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"}, - {"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"}, - {"firstName": "Warren", "lastName": "Buff", "_id": "asdasdasd"}, - {"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"}, - {"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"}, - {"firstName": "Warren", "lastName": "Buff", "_id": "asdasdasd"}, - {"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"}, + \{"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"\}, + \{"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"\}, + \{"firstName": "Warren", "lastName": "Buff", "_id": "asdasdasd"\}, + \{"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"\}, + \{"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"\}, + \{"firstName": "Warren", "lastName": "Buff", "_id": "asdasdasd"\}, + \{"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"\}, + \{"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"\}, + \{"firstName": "Warren", "lastName": "Buff", "_id": "asdasdasd"\}, + \{"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"\}, ], "admins": [ - {"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"}, + \{"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"\}, ], - "organization": { + "organization": \{ "_id": '1', "name": 'Mathematicians', "image": ' ', - "creator": { + "creator": \{ "firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd" - } - }, - }, - { + \} + \}, + \}, + \{ "title": "UI/UX", "description": "UX design refers to the term “user experience design”, while UI stands for “user interface design”. Both elements are crucial to a product and work closely together.", @@ -89,38 +89,38 @@ const eventsDemoData = [ "isPublic": "true", "isSubscribed": "true", "isRegisterable": "true", - "creator": { + "creator": \{ "firstName": "Rutvik", "lastName": "Chandla", "_id": "asdasdasd" - }, + \}, "registrants": [ - {"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"}, - {"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"}, - {"firstName": "Warren", "lastName": "Buff", "_id": "asdasdasd"}, - {"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"}, - {"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"}, - {"firstName": "Warren", "lastName": "Buff", "_id": "asdasdasd"}, - {"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"}, - {"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"}, - {"firstName": "Warren", "lastName": "Buff", "_id": "asdasdasd"}, - {"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"}, + \{"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"\}, + \{"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"\}, + \{"firstName": "Warren", "lastName": "Buff", "_id": "asdasdasd"\}, + \{"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"\}, + \{"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"\}, + \{"firstName": "Warren", "lastName": "Buff", "_id": "asdasdasd"\}, + \{"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"\}, + \{"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"\}, + \{"firstName": "Warren", "lastName": "Buff", "_id": "asdasdasd"\}, + \{"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"\}, ], "admins": [ - {"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"}, + \{"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"\}, ], - "organization": { + "organization": \{ "_id": '1', "name": 'Courses', "image": ' ', - "creator": { + "creator": \{ "firstName": "Rutvik", "lastName": "Chandla", "_id": "asdasdasd" - } - }, - }, - { + \} + \}, + \}, + \{ "title": "System Design", "description": "Systems design is the process of defining the architecture, product design, modules, interfaces, and data for a system to satisfy specified requirements. Systems design could be seen as the application of systems theory to product development.", @@ -136,40 +136,40 @@ const eventsDemoData = [ "isPublic": "false", "isSubscribed": "false", "isRegisterable": "true", - "creator": { + "creator": \{ "firstName": "Ritik", "lastName": "Srivastav", "_id": "asdasdasd" - }, + \}, "registrants": [ - {"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"}, - {"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"}, - {"firstName": "Warren", "lastName": "Buff", "_id": "asdasdasd"}, - {"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"}, - {"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"}, - {"firstName": "Warren", "lastName": "Buff", "_id": "asdasdasd"}, - {"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"}, - {"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"}, - {"firstName": "Warren", "lastName": "Buff", "_id": "asdasdasd"}, - {"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"}, + \{"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"\}, + \{"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"\}, + \{"firstName": "Warren", "lastName": "Buff", "_id": "asdasdasd"\}, + \{"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"\}, + \{"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"\}, + \{"firstName": "Warren", "lastName": "Buff", "_id": "asdasdasd"\}, + \{"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"\}, + \{"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"\}, + \{"firstName": "Warren", "lastName": "Buff", "_id": "asdasdasd"\}, + \{"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"\}, ], "admins": [ - {"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"}, + \{"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"\}, ], - "organization": { + "organization": \{ "_id": '1', "image": ' ', "name": 'Computer Science', - "creator": { + "creator": \{ "firstName": "Ritik", "lastName": "Srivastav", "_id": "asdasdasd" - } - }, - }, - { + \} + \}, + \}, + \{ "title": "Gaming", - // ignore: missing_whitespace_between_adjacent_strings + ignore: missing_whitespace_between_adjacent_strings "description": "Cyberpunk 2077 is a 2020 action role-playing v_ideo game developed and published by CD Projekt. The story takes place in Night City, an open world set in the Cyberpunk universe.", @@ -186,37 +186,37 @@ const eventsDemoData = [ "isSubscribed": "true", "isRegisterable": "true", - "creator": { + "creator": \{ "firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd" - }, + \}, "registrants": [ - {"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"}, - {"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"}, - {"firstName": "Warren", "lastName": "Buff", "_id": "asdasdasd"}, - {"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"}, - {"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"}, - {"firstName": "Warren", "lastName": "Buff", "_id": "asdasdasd"}, - {"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"}, - {"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"}, - {"firstName": "Warren", "lastName": "Buff", "_id": "asdasdasd"}, - {"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"}, + \{"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"\}, + \{"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"\}, + \{"firstName": "Warren", "lastName": "Buff", "_id": "asdasdasd"\}, + \{"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"\}, + \{"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"\}, + \{"firstName": "Warren", "lastName": "Buff", "_id": "asdasdasd"\}, + \{"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"\}, + \{"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"\}, + \{"firstName": "Warren", "lastName": "Buff", "_id": "asdasdasd"\}, + \{"firstName": "Bustin", "lastName": "Jiber", "_id": "asdasdasd"\}, ], "admins": [ - {"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"}, + \{"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"\}, ], - "organization": { + "organization": \{ "_id": '1', "image": ' ', "name": 'Cyclone', - "creator": { + "creator": \{ "firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd" - } - }, - } + \} + \}, + \} ]; ``` diff --git a/docs/talawa-mobile-docs/demo_server_data_pinned_post_demo_data/demo_server_data_pinned_post_demo_data-library.md b/docs/talawa-mobile-docs/demo_server_data_pinned_post_demo_data/demo_server_data_pinned_post_demo_data-library.md index 90c5b02d05b..eae1cf32ed6 100644 --- a/docs/talawa-mobile-docs/demo_server_data_pinned_post_demo_data/demo_server_data_pinned_post_demo_data-library.md +++ b/docs/talawa-mobile-docs/demo_server_data_pinned_post_demo_data/demo_server_data_pinned_post_demo_data-library.md @@ -19,7 +19,7 @@ ## Constants -##### [pinnedPostsDemoData](../demo_server_data_pinned_post_demo_data/pinnedPostsDemoData-constant.md) const [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html)>> +##### [pinnedPostsDemoData](../demo_server_data_pinned_post_demo_data/pinnedPostsDemoData-constant.md) const [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html)\>\> diff --git a/docs/talawa-mobile-docs/demo_server_data_pinned_post_demo_data/pinnedPostsDemoData-constant.md b/docs/talawa-mobile-docs/demo_server_data_pinned_post_demo_data/pinnedPostsDemoData-constant.md index e932c9d7e68..d140f7bc1e6 100644 --- a/docs/talawa-mobile-docs/demo_server_data_pinned_post_demo_data/pinnedPostsDemoData-constant.md +++ b/docs/talawa-mobile-docs/demo_server_data_pinned_post_demo_data/pinnedPostsDemoData-constant.md @@ -11,13 +11,13 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html)>> const pinnedPostsDemoData +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html)\>\> const pinnedPostsDemoData -

This file contains demo data for pinned posts. It contains a list of type Map<String, Object> and sample data.

+\This file contains demo data for pinned posts. It contains a list of type Map<String, Object> and sample data.\ @@ -25,162 +25,162 @@ ```dart const pinnedPostsDemoData = [ - { + \{ "_id": "1", "text": "Flutter is Google’s mobile UI framework for crafting high-quality native interfaces on iOS and Android in record time. Flutter works with existing code, is used by developers and organizations around the world, and is free and open source.", "createdAt": "2023-03-15T15:28:52.122Z", "imageUrl": "image url string", - "creator": { + "creator": \{ "firstName": "Rutvik", "lastName": "Chandla", "id": "asdasdasd" - }, + \}, "likedBy": [ - {"firstName": "User", "lastName": "1", "id": "asdasdasdas"}, - {"firstName": "User", "lastName": "2", "id": "asdasdasdas"}, - {"firstName": "User", "lastName": "3", "id": "asdasdasdas"} + \{"firstName": "User", "lastName": "1", "id": "asdasdasdas"\}, + \{"firstName": "User", "lastName": "2", "id": "asdasdasdas"\}, + \{"firstName": "User", "lastName": "3", "id": "asdasdasdas"\} ], "comments": [ - { + \{ "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "id": "asdasdasdas"\} + \}, + \{ "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "id": "asdasdasdas"\} + \}, + \{ "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "id": "asdasdasdas"\} + \}, + \{ "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "id": "asdasdasdas"\} + \}, + \{ "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} - }, + "creator": \{"firstName": "User", "lastName": "4", "id": "asdasdasdas"\} + \}, ] - }, - { + \}, + \{ "_id": "2", "text": "Flutter is Google’s mobile UI framework for crafting high-quality native interfaces on iOS and Android in record time. Flutter works with existing code, is used by developers and organizations around the world, and is free and open source.", "createdAt": "2023-03-15T15:28:52.122Z", "imageUrl": "image url string", - "creator": { + "creator": \{ "firstName": "Ranchhod Das", "lastName": "Chanchad", "id": "asdasdasd" - }, + \}, "likedBy": [ - {"firstName": "User", "lastName": "1", "id": "asdasdasdas"}, - {"firstName": "User", "lastName": "2", "id": "asdasdasdas"}, - {"firstName": "User", "lastName": "3", "id": "asdasdasdas"} + \{"firstName": "User", "lastName": "1", "id": "asdasdasdas"\}, + \{"firstName": "User", "lastName": "2", "id": "asdasdasdas"\}, + \{"firstName": "User", "lastName": "3", "id": "asdasdasdas"\} ], "comments": [ - { + \{ "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "id": "asdasdasdas"\} + \}, + \{ "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "id": "asdasdasdas"\} + \}, + \{ "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "id": "asdasdasdas"\} + \}, + \{ "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "id": "asdasdasdas"\} + \}, + \{ "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} - }, + "creator": \{"firstName": "User", "lastName": "4", "id": "asdasdasdas"\} + \}, ] - }, - { + \}, + \{ "_id": "3", "text": "Flutter is Google’s mobile UI framework for crafting high-quality native interfaces on iOS and Android in record time. Flutter works with existing code, is used by developers and organizations around the world, and is free and open source.", "createdAt": "2023-03-15T15:28:52.122Z", "imageUrl": "image url string", - "creator": { + "creator": \{ "firstName": "Ritik", "lastName": "Srivastav", "id": "asdasdasd" - }, + \}, "likedBy": [ - {"firstName": "User", "lastName": "1", "id": "asdasdasdas"}, - {"firstName": "User", "lastName": "2", "id": "asdasdasdas"}, - {"firstName": "User", "lastName": "3", "id": "asdasdasdas"} + \{"firstName": "User", "lastName": "1", "id": "asdasdasdas"\}, + \{"firstName": "User", "lastName": "2", "id": "asdasdasdas"\}, + \{"firstName": "User", "lastName": "3", "id": "asdasdasdas"\} ], "comments": [ - { + \{ "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "id": "asdasdasdas"\} + \}, + \{ "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "id": "asdasdasdas"\} + \}, + \{ "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "id": "asdasdasdas"\} + \}, + \{ "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "id": "asdasdasdas"\} + \}, + \{ "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} - }, + "creator": \{"firstName": "User", "lastName": "4", "id": "asdasdasdas"\} + \}, ] - }, - { + \}, + \{ "_id": "4", "text": "Flutter is Google’s mobile UI framework for crafting high-quality native interfaces on iOS and Android in record time. Flutter works with existing code, is used by developers and organizations around the world, and is free and open source.", "createdAt": "2023-03-15T15:28:52.122Z", "imageUrl": "image url string", - "creator": { + "creator": \{ "firstName": "Utkarsh", "lastName": "Shendge", "id": "asdasdasd" - }, + \}, "likedBy": [ - {"firstName": "User", "lastName": "1", "id": "asdasdasdas"}, - {"firstName": "User", "lastName": "2", "id": "asdasdasdas"}, - {"firstName": "User", "lastName": "3", "id": "asdasdasdas"} + \{"firstName": "User", "lastName": "1", "id": "asdasdasdas"\}, + \{"firstName": "User", "lastName": "2", "id": "asdasdasdas"\}, + \{"firstName": "User", "lastName": "3", "id": "asdasdasdas"\} ], "comments": [ - { + \{ "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "id": "asdasdasdas"\} + \}, + \{ "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "id": "asdasdasdas"\} + \}, + \{ "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "id": "asdasdasdas"\} + \}, + \{ "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "id": "asdasdasdas"\} + \}, + \{ "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} - }, + "creator": \{"firstName": "User", "lastName": "4", "id": "asdasdasdas"\} + \}, ] - }, + \}, ]; ``` diff --git a/docs/talawa-mobile-docs/demo_server_data_post_demo_data/demo_server_data_post_demo_data-library.md b/docs/talawa-mobile-docs/demo_server_data_post_demo_data/demo_server_data_post_demo_data-library.md index 2e26a035aee..0b8e7a74525 100644 --- a/docs/talawa-mobile-docs/demo_server_data_post_demo_data/demo_server_data_post_demo_data-library.md +++ b/docs/talawa-mobile-docs/demo_server_data_post_demo_data/demo_server_data_post_demo_data-library.md @@ -19,7 +19,7 @@ ## Constants -##### [postsDemoData](../demo_server_data_post_demo_data/postsDemoData-constant.md) const [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html)>> +##### [postsDemoData](../demo_server_data_post_demo_data/postsDemoData-constant.md) const [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html)\>\> diff --git a/docs/talawa-mobile-docs/demo_server_data_post_demo_data/postsDemoData-constant.md b/docs/talawa-mobile-docs/demo_server_data_post_demo_data/postsDemoData-constant.md index aa96891f798..b66caeb0765 100644 --- a/docs/talawa-mobile-docs/demo_server_data_post_demo_data/postsDemoData-constant.md +++ b/docs/talawa-mobile-docs/demo_server_data_post_demo_data/postsDemoData-constant.md @@ -11,14 +11,14 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html)>> const postsDemoData +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html)\>\> const postsDemoData -

This file contains demo data for posts. It contains a list of type Map<String, Object> -and sample data of posts.

+\This file contains demo data for posts. It contains a list of type Map<String, Object> +and sample data of posts.\ @@ -26,182 +26,182 @@ and sample data of posts.

```dart const postsDemoData = [ - { + \{ "_id": "asdasdasd", "text": "Flutter is Google’s mobile UI framework for crafting high-quality native interfaces on iOS and Android in record time. Flutter works with existing code, is used by developers and organizations around the world, and is free and open source.", "createdAt": "created at string", "imageUrl": "image url string", - "creator": { + "creator": \{ "firstName": "Rutvik", "lastName": "Chandla", "_id": "asdasdasd" - }, + \}, "likedBy": [ - {"firstName": "User", "lastName": "1", "_id": "asdasdasdas"}, - {"firstName": "User", "lastName": "2", "_id": "asdasdasdas"}, - {"firstName": "User", "lastName": "3", "_id": "asdasdasdas"} + \{"firstName": "User", "lastName": "1", "_id": "asdasdasdas"\}, + \{"firstName": "User", "lastName": "2", "_id": "asdasdasdas"\}, + \{"firstName": "User", "lastName": "3", "_id": "asdasdasdas"\} ], "comments": [ - { + \{ "_id": "commentID", "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "1", "_id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "1", "_id": "asdasdasdas"\} + \}, + \{ "_id": "commentID", "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "2", "_id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "2", "_id": "asdasdasdas"\} + \}, + \{ "_id": "commentID", "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "3", "_id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "3", "_id": "asdasdasdas"\} + \}, + \{ "_id": "commentID", "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "_id": "asdasdasdas"\} + \}, + \{ "_id": "commentID", "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "5", "_id": "asdasdasdas"} - }, + "creator": \{"firstName": "User", "lastName": "5", "_id": "asdasdasdas"\} + \}, ] - }, - { + \}, + \{ "_id": "asdasdasd", "text": "Flutter is Google’s mobile UI framework for crafting high-quality native interfaces on iOS and Andro_id in record time. Flutter works with existing code, is used by developers and organizations around the world, and is free and open source.", "createdAt": "created at string", "imageUrl": "image url string", - "creator": { + "creator": \{ "firstName": "Ranchhod Das Chhanchad", "lastName": "Chandla", "_id": "asdasdasd" - }, + \}, "likedBy": [ - {"firstName": "User", "lastName": "1", "_id": "asdasdasdas"}, - {"firstName": "User", "lastName": "2", "_id": "asdasdasdas"}, - {"firstName": "User", "lastName": "3", "_id": "asdasdasdas"} + \{"firstName": "User", "lastName": "1", "_id": "asdasdasdas"\}, + \{"firstName": "User", "lastName": "2", "_id": "asdasdasdas"\}, + \{"firstName": "User", "lastName": "3", "_id": "asdasdasdas"\} ], "comments": [ - { + \{ "_id": "commentID", "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "_id": "asdasdasdas"\} + \}, + \{ "_id": "commentID", "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "_id": "asdasdasdas"\} + \}, + \{ "_id": "commentID", "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "_id": "asdasdasdas"\} + \}, + \{ "_id": "commentID", "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "_id": "asdasdasdas"\} + \}, + \{ "_id": "commentID", "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} - }, + "creator": \{"firstName": "User", "lastName": "4", "_id": "asdasdasdas"\} + \}, ] - }, - { + \}, + \{ "_id": "asdasdasd", "text": "Flutter is Google’s mobile UI framework for crafting high-quality native interfaces on iOS and Andro_id in record time. Flutter works with existing code, is used by developers and organizations around the world, and is free and open source.", "createdAt": "created at string", "imageUrl": "image url string", - "creator": { + "creator": \{ "firstName": "Ritik", "lastName": "Srivastav", "_id": "asdasdasd" - }, + \}, "likedBy": [ - {"firstName": "User", "lastName": "1", "_id": "asdasdasdas"}, - {"firstName": "User", "lastName": "2", "_id": "asdasdasdas"}, - {"firstName": "User", "lastName": "3", "_id": "asdasdasdas"} + \{"firstName": "User", "lastName": "1", "_id": "asdasdasdas"\}, + \{"firstName": "User", "lastName": "2", "_id": "asdasdasdas"\}, + \{"firstName": "User", "lastName": "3", "_id": "asdasdasdas"\} ], "comments": [ - { + \{ "_id": "commentID", "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "_id": "asdasdasdas"\} + \}, + \{ "_id": "commentID", "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "_id": "asdasdasdas"\} + \}, + \{ "_id": "commentID", "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "_id": "asdasdasdas"\} + \}, + \{ "_id": "commentID", "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "_id": "asdasdasdas"\} + \}, + \{ "_id": "commentID", "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} - }, + "creator": \{"firstName": "User", "lastName": "4", "_id": "asdasdasdas"\} + \}, ] - }, - { + \}, + \{ "_id": "asdasdasd", "text": "Flutter is Google’s mobile UI framework for crafting high-quality native interfaces on iOS and Andro_id in record time. Flutter works with existing code, is used by developers and organizations around the world, and is free and open source.", "createdAt": "created at string", "imageUrl": "image url string", - "creator": { + "creator": \{ "firstName": "Utkarsh", "lastName": "Shengde", "_id": "asdasdasd" - }, + \}, "likedBy": [ - {"firstName": "User", "lastName": "1", "_id": "asdasdasdas"}, - {"firstName": "User", "lastName": "2", "_id": "asdasdasdas"}, - {"firstName": "User", "lastName": "3", "_id": "asdasdasdas"} + \{"firstName": "User", "lastName": "1", "_id": "asdasdasdas"\}, + \{"firstName": "User", "lastName": "2", "_id": "asdasdasdas"\}, + \{"firstName": "User", "lastName": "3", "_id": "asdasdasdas"\} ], "comments": [ - { + \{ "_id": "commentID", "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "_id": "asdasdasdas"\} + \}, + \{ "_id": "commentID", "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "_id": "asdasdasdas"\} + \}, + \{ "_id": "commentID", "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "_id": "asdasdasdas"\} + \}, + \{ "_id": "commentID", "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} - }, - { + "creator": \{"firstName": "User", "lastName": "4", "_id": "asdasdasdas"\} + \}, + \{ "_id": "commentID", "text": "This is the posted comment", - "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} - }, + "creator": \{"firstName": "User", "lastName": "4", "_id": "asdasdasdas"\} + \}, ] - }, + \}, ]; ``` diff --git a/docs/talawa-mobile-docs/enums_enums/CallFor.md b/docs/talawa-mobile-docs/enums_enums/CallFor.md index c508c611084..b12ceb03dba 100644 --- a/docs/talawa-mobile-docs/enums_enums/CallFor.md +++ b/docs/talawa-mobile-docs/enums_enums/CallFor.md @@ -14,8 +14,8 @@ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [Enum](https://api.flutter.dev/flutter/dart-core/Enum-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [Enum](https:api.flutter.dev/flutter/dart-core/Enum-class.html) - CallFor @@ -62,30 +62,30 @@ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [index](https://api.flutter.dev/flutter/dart-core/Enum/index.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [index](https:api.flutter.dev/flutter/dart-core/Enum/index.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) A numeric identifier for the enumerated value. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -93,21 +93,21 @@ _read-onlyinherited_ ## Methods -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -115,12 +115,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ @@ -133,7 +133,7 @@ _inherited_ ## Constants -##### [values](../enums_enums/CallFor/values-constant.md) const [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[CallFor](../enums_enums/CallFor.md)> +##### [values](../enums_enums/CallFor/values-constant.md) const [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[CallFor](../enums_enums/CallFor.md)\> diff --git a/docs/talawa-mobile-docs/enums_enums/CallFor/values-constant.md b/docs/talawa-mobile-docs/enums_enums/CallFor/values-constant.md index cff3cf6c21c..f432c05cc4c 100644 --- a/docs/talawa-mobile-docs/enums_enums/CallFor/values-constant.md +++ b/docs/talawa-mobile-docs/enums_enums/CallFor/values-constant.md @@ -9,13 +9,13 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[CallFor](../../enums_enums/CallFor.md)> const values +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[CallFor](../../enums_enums/CallFor.md)\> const values -

A constant List of the values in this enum, in order of their declaration.

+\A constant List of the values in this enum, in order of their declaration.\ diff --git a/docs/talawa-mobile-docs/enums_enums/ChatState.md b/docs/talawa-mobile-docs/enums_enums/ChatState.md index 739acc02530..f4d0d58e267 100644 --- a/docs/talawa-mobile-docs/enums_enums/ChatState.md +++ b/docs/talawa-mobile-docs/enums_enums/ChatState.md @@ -9,14 +9,14 @@ -

Represents the state of the chat

+\Represents the state of the chat\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [Enum](https://api.flutter.dev/flutter/dart-core/Enum-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [Enum](https:api.flutter.dev/flutter/dart-core/Enum-class.html) - ChatState @@ -63,30 +63,30 @@ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [index](https://api.flutter.dev/flutter/dart-core/Enum/index.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [index](https:api.flutter.dev/flutter/dart-core/Enum/index.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) A numeric identifier for the enumerated value. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -94,21 +94,21 @@ _read-onlyinherited_ ## Methods -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -116,12 +116,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ @@ -134,7 +134,7 @@ _inherited_ ## Constants -##### [values](../enums_enums/ChatState/values-constant.md) const [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[ChatState](../enums_enums/ChatState.md)> +##### [values](../enums_enums/ChatState/values-constant.md) const [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[ChatState](../enums_enums/ChatState.md)\> diff --git a/docs/talawa-mobile-docs/enums_enums/ChatState/values-constant.md b/docs/talawa-mobile-docs/enums_enums/ChatState/values-constant.md index 8d2ba60b5ca..0ee53286642 100644 --- a/docs/talawa-mobile-docs/enums_enums/ChatState/values-constant.md +++ b/docs/talawa-mobile-docs/enums_enums/ChatState/values-constant.md @@ -9,13 +9,13 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[ChatState](../../enums_enums/ChatState.md)> const values +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[ChatState](../../enums_enums/ChatState.md)\> const values -

A constant List of the values in this enum, in order of their declaration.

+\A constant List of the values in this enum, in order of their declaration.\ diff --git a/docs/talawa-mobile-docs/enums_enums/MessageType.md b/docs/talawa-mobile-docs/enums_enums/MessageType.md index 5bc119ab1b7..9c161d96502 100644 --- a/docs/talawa-mobile-docs/enums_enums/MessageType.md +++ b/docs/talawa-mobile-docs/enums_enums/MessageType.md @@ -9,14 +9,14 @@ -

Represents the type of the Message

+\Represents the type of the Message\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [Enum](https://api.flutter.dev/flutter/dart-core/Enum-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [Enum](https:api.flutter.dev/flutter/dart-core/Enum-class.html) - MessageType @@ -72,30 +72,30 @@ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [index](https://api.flutter.dev/flutter/dart-core/Enum/index.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [index](https:api.flutter.dev/flutter/dart-core/Enum/index.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) A numeric identifier for the enumerated value. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -103,21 +103,21 @@ _read-onlyinherited_ ## Methods -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -125,12 +125,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ @@ -143,7 +143,7 @@ _inherited_ ## Constants -##### [values](../enums_enums/MessageType/values-constant.md) const [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[MessageType](../enums_enums/MessageType.md)> +##### [values](../enums_enums/MessageType/values-constant.md) const [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[MessageType](../enums_enums/MessageType.md)\> diff --git a/docs/talawa-mobile-docs/enums_enums/MessageType/values-constant.md b/docs/talawa-mobile-docs/enums_enums/MessageType/values-constant.md index d6a40b62413..9b44d006a3b 100644 --- a/docs/talawa-mobile-docs/enums_enums/MessageType/values-constant.md +++ b/docs/talawa-mobile-docs/enums_enums/MessageType/values-constant.md @@ -9,13 +9,13 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[MessageType](../../enums_enums/MessageType.md)> const values +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[MessageType](../../enums_enums/MessageType.md)\> const values -

A constant List of the values in this enum, in order of their declaration.

+\A constant List of the values in this enum, in order of their declaration.\ diff --git a/docs/talawa-mobile-docs/enums_enums/ModalSheet.md b/docs/talawa-mobile-docs/enums_enums/ModalSheet.md index ddfe171d2c9..31ee0f93f44 100644 --- a/docs/talawa-mobile-docs/enums_enums/ModalSheet.md +++ b/docs/talawa-mobile-docs/enums_enums/ModalSheet.md @@ -14,8 +14,8 @@ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [Enum](https://api.flutter.dev/flutter/dart-core/Enum-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [Enum](https:api.flutter.dev/flutter/dart-core/Enum-class.html) - ModalSheet @@ -53,30 +53,30 @@ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [index](https://api.flutter.dev/flutter/dart-core/Enum/index.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [index](https:api.flutter.dev/flutter/dart-core/Enum/index.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) A numeric identifier for the enumerated value. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -84,21 +84,21 @@ _read-onlyinherited_ ## Methods -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -106,12 +106,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ @@ -124,7 +124,7 @@ _inherited_ ## Constants -##### [values](../enums_enums/ModalSheet/values-constant.md) const [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[ModalSheet](../enums_enums/ModalSheet.md)> +##### [values](../enums_enums/ModalSheet/values-constant.md) const [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[ModalSheet](../enums_enums/ModalSheet.md)\> diff --git a/docs/talawa-mobile-docs/enums_enums/ModalSheet/values-constant.md b/docs/talawa-mobile-docs/enums_enums/ModalSheet/values-constant.md index b1da27eac85..5a4ec623954 100644 --- a/docs/talawa-mobile-docs/enums_enums/ModalSheet/values-constant.md +++ b/docs/talawa-mobile-docs/enums_enums/ModalSheet/values-constant.md @@ -9,13 +9,13 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[ModalSheet](../../enums_enums/ModalSheet.md)> const values +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[ModalSheet](../../enums_enums/ModalSheet.md)\> const values -

A constant List of the values in this enum, in order of their declaration.

+\A constant List of the values in this enum, in order of their declaration.\ diff --git a/docs/talawa-mobile-docs/enums_enums/TileType.md b/docs/talawa-mobile-docs/enums_enums/TileType.md index 00641286832..f879e7c8a44 100644 --- a/docs/talawa-mobile-docs/enums_enums/TileType.md +++ b/docs/talawa-mobile-docs/enums_enums/TileType.md @@ -9,14 +9,14 @@ -

Represents the type of the tile

+\Represents the type of the tile\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [Enum](https://api.flutter.dev/flutter/dart-core/Enum-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [Enum](https:api.flutter.dev/flutter/dart-core/Enum-class.html) - TileType @@ -63,30 +63,30 @@ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [index](https://api.flutter.dev/flutter/dart-core/Enum/index.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [index](https:api.flutter.dev/flutter/dart-core/Enum/index.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) A numeric identifier for the enumerated value. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -94,21 +94,21 @@ _read-onlyinherited_ ## Methods -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -116,12 +116,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ @@ -134,7 +134,7 @@ _inherited_ ## Constants -##### [values](../enums_enums/TileType/values-constant.md) const [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[TileType](../enums_enums/TileType.md)> +##### [values](../enums_enums/TileType/values-constant.md) const [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[TileType](../enums_enums/TileType.md)\> diff --git a/docs/talawa-mobile-docs/enums_enums/TileType/values-constant.md b/docs/talawa-mobile-docs/enums_enums/TileType/values-constant.md index 383d264e809..77d4bc6ca78 100644 --- a/docs/talawa-mobile-docs/enums_enums/TileType/values-constant.md +++ b/docs/talawa-mobile-docs/enums_enums/TileType/values-constant.md @@ -9,13 +9,13 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[TileType](../../enums_enums/TileType.md)> const values +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[TileType](../../enums_enums/TileType.md)\> const values -

A constant List of the values in this enum, in order of their declaration.

+\A constant List of the values in this enum, in order of their declaration.\ diff --git a/docs/talawa-mobile-docs/enums_enums/ViewState.md b/docs/talawa-mobile-docs/enums_enums/ViewState.md index d0cb942eb70..c402c9c0c0e 100644 --- a/docs/talawa-mobile-docs/enums_enums/ViewState.md +++ b/docs/talawa-mobile-docs/enums_enums/ViewState.md @@ -9,17 +9,17 @@ -

This file contains different enums. +\This file contains different enums. The enum keyword is used to define an enumeration type in Dart. The use case of enumeration is to store finite data members under the same type definition. -Represents the state of the view

+Represents the state of the view\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [Enum](https://api.flutter.dev/flutter/dart-core/Enum-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [Enum](https:api.flutter.dev/flutter/dart-core/Enum-class.html) - ViewState @@ -57,30 +57,30 @@ Represents the state of the view

## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [index](https://api.flutter.dev/flutter/dart-core/Enum/index.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [index](https:api.flutter.dev/flutter/dart-core/Enum/index.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) A numeric identifier for the enumerated value. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -88,21 +88,21 @@ _read-onlyinherited_ ## Methods -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -110,12 +110,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ @@ -128,7 +128,7 @@ _inherited_ ## Constants -##### [values](../enums_enums/ViewState/values-constant.md) const [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[ViewState](../enums_enums/ViewState.md)> +##### [values](../enums_enums/ViewState/values-constant.md) const [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[ViewState](../enums_enums/ViewState.md)\> diff --git a/docs/talawa-mobile-docs/enums_enums/ViewState/values-constant.md b/docs/talawa-mobile-docs/enums_enums/ViewState/values-constant.md index 6360c8b8db3..9276e8f0e27 100644 --- a/docs/talawa-mobile-docs/enums_enums/ViewState/values-constant.md +++ b/docs/talawa-mobile-docs/enums_enums/ViewState/values-constant.md @@ -9,13 +9,13 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[ViewState](../../enums_enums/ViewState.md)> const values +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[ViewState](../../enums_enums/ViewState.md)\> const values -

A constant List of the values in this enum, in order of their declaration.

+\A constant List of the values in this enum, in order of their declaration.\ diff --git a/docs/talawa-mobile-docs/firebase_options/DefaultFirebaseOptions-class.md b/docs/talawa-mobile-docs/firebase_options/DefaultFirebaseOptions-class.md index f8bb745e47f..787aecf0f08 100644 --- a/docs/talawa-mobile-docs/firebase_options/DefaultFirebaseOptions-class.md +++ b/docs/talawa-mobile-docs/firebase_options/DefaultFirebaseOptions-class.md @@ -11,14 +11,14 @@ -

Default FirebaseOptions for use with your Firebase apps.

-

Example:

-
import 'firebase_options.dart';
-// ...
+\Default \FirebaseOptions\ for use with your Firebase apps.\
+\Example:\
+\
\import 'firebase_options.dart';
+...
 await Firebase.initializeApp(
   options: DefaultFirebaseOptions.currentPlatform,
 );
-
+\\ @@ -32,21 +32,21 @@ await Firebase.initializeApp( ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -54,21 +54,21 @@ _read-onlyinherited_ ## Methods -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -76,12 +76,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ @@ -91,7 +91,7 @@ _inherited_ ## Static Methods -##### [android](../firebase_options/DefaultFirebaseOptions/android.md)([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> androidFirebaseOptions) [FirebaseOptions](https://pub.dev/documentation/firebase_core_platform_interface/4.8.0/firebase_core_platform_interface/FirebaseOptions-class.html) +##### [android](../firebase_options/DefaultFirebaseOptions/android.md)([Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> androidFirebaseOptions) [FirebaseOptions](https:pub.dev/documentation/firebase_core_platform_interface/4.8.0/firebase_core_platform_interface/FirebaseOptions-class.html) @@ -100,16 +100,16 @@ Scaffolds androidFirebaseOptions around FirebaseOptions. -##### [currentPlatform](../firebase_options/DefaultFirebaseOptions/currentPlatform.md)([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> androidFirebaseOptions, [Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> iosFirebaseOptions) [FirebaseOptions](https://pub.dev/documentation/firebase_core_platform_interface/4.8.0/firebase_core_platform_interface/FirebaseOptions-class.html) +##### [currentPlatform](../firebase_options/DefaultFirebaseOptions/currentPlatform.md)([Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> androidFirebaseOptions, [Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> iosFirebaseOptions) [FirebaseOptions](https:pub.dev/documentation/firebase_core_platform_interface/4.8.0/firebase_core_platform_interface/FirebaseOptions-class.html) -Builds and returns
FirebaseOptions based on the current platform. +Builds and returns \FirebaseOptions\ based on the current platform. -##### [ios](../firebase_options/DefaultFirebaseOptions/ios.md)([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> iosFirebaseOptions) [FirebaseOptions](https://pub.dev/documentation/firebase_core_platform_interface/4.8.0/firebase_core_platform_interface/FirebaseOptions-class.html) +##### [ios](../firebase_options/DefaultFirebaseOptions/ios.md)([Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> iosFirebaseOptions) [FirebaseOptions](https:pub.dev/documentation/firebase_core_platform_interface/4.8.0/firebase_core_platform_interface/FirebaseOptions-class.html) diff --git a/docs/talawa-mobile-docs/firebase_options/DefaultFirebaseOptions/android.md b/docs/talawa-mobile-docs/firebase_options/DefaultFirebaseOptions/android.md index 8ca0438042d..28da5b9192f 100644 --- a/docs/talawa-mobile-docs/firebase_options/DefaultFirebaseOptions/android.md +++ b/docs/talawa-mobile-docs/firebase_options/DefaultFirebaseOptions/android.md @@ -10,29 +10,29 @@ -[FirebaseOptions](https://pub.dev/documentation/firebase_core_platform_interface/4.8.0/firebase_core_platform_interface/FirebaseOptions-class.html) android -([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> androidFirebaseOptions) +[FirebaseOptions](https:pub.dev/documentation/firebase_core_platform_interface/4.8.0/firebase_core_platform_interface/FirebaseOptions-class.html) android +([Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> androidFirebaseOptions) -

Scaffolds androidFirebaseOptions around FirebaseOptions.

-

params:

-
    -
  • androidFirebaseOptions: The options which we want to scaffold
  • -
-

returns:

-
    -
  • FirebaseOptions: Scaffolded FirebaseOptions
  • -
+\Scaffolds androidFirebaseOptions around FirebaseOptions.\ +\\params\:\ +\ +\\androidFirebaseOptions\: The options which we want to scaffold\ +\ +\\returns\:\ +\ +\\FirebaseOptions\: Scaffolded FirebaseOptions\ +\ ## Implementation ```dart -static FirebaseOptions android(Map androidFirebaseOptions) => +static FirebaseOptions android(Map\ androidFirebaseOptions) =\> FirebaseOptions( apiKey: androidFirebaseOptions['apiKey'] as String, appId: androidFirebaseOptions['appId'] as String, diff --git a/docs/talawa-mobile-docs/firebase_options/DefaultFirebaseOptions/currentPlatform.md b/docs/talawa-mobile-docs/firebase_options/DefaultFirebaseOptions/currentPlatform.md index 29bbbf15d48..b0b1f468725 100644 --- a/docs/talawa-mobile-docs/firebase_options/DefaultFirebaseOptions/currentPlatform.md +++ b/docs/talawa-mobile-docs/firebase_options/DefaultFirebaseOptions/currentPlatform.md @@ -10,26 +10,26 @@ -[FirebaseOptions](https://pub.dev/documentation/firebase_core_platform_interface/4.8.0/firebase_core_platform_interface/FirebaseOptions-class.html) currentPlatform -([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> androidFirebaseOptions, [Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> iosFirebaseOptions) +[FirebaseOptions](https:pub.dev/documentation/firebase_core_platform_interface/4.8.0/firebase_core_platform_interface/FirebaseOptions-class.html) currentPlatform +([Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> androidFirebaseOptions, [Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> iosFirebaseOptions) -

Builds and returns FirebaseOptions based on the current platform.

-

Switches on the current platform and calls android or iOS -methods accordingly to build the FirebaseOptions. Throws -UnsupportedError if the platform is other than these two.

-

params:

-
    -
  • androidFirebaseOptions: Firebase Options for Android
  • -
  • iosFirebaseOptions: Firebase Options for iOS
  • -
-

returns:

- +\Builds and returns \FirebaseOptions\ based on the current platform.\ +\Switches on the current platform and calls \android\ or \iOS\ +methods accordingly to build the \FirebaseOptions\. Throws +\UnsupportedError\ if the platform is other than these two.\ +\\params\:\ +\ +\\androidFirebaseOptions\: Firebase Options for Android\ +\\iosFirebaseOptions\: Firebase Options for iOS\ +\ +\\returns\:\ +\ +\\FirebaseOptions\: The \FirebaseOptions\ built according to the platform.\ +\ @@ -37,16 +37,16 @@ methods accordingly to build the FirebaseOptions for use with your Firebase apps. +Default \FirebaseOptions\ for use with your Firebase apps. diff --git a/docs/talawa-mobile-docs/generated_plugin_registrant/generated_plugin_registrant-library.md b/docs/talawa-mobile-docs/generated_plugin_registrant/generated_plugin_registrant-library.md index 866146259d1..4095f5b8873 100644 --- a/docs/talawa-mobile-docs/generated_plugin_registrant/generated_plugin_registrant-library.md +++ b/docs/talawa-mobile-docs/generated_plugin_registrant/generated_plugin_registrant-library.md @@ -21,7 +21,7 @@ ## Functions -##### [registerPlugins](../generated_plugin_registrant/registerPlugins.md)([Registrar](https://api.flutter.dev/flutter/flutter_web_plugins/Registrar-class.html) registrar) void +##### [registerPlugins](../generated_plugin_registrant/registerPlugins.md)([Registrar](https:api.flutter.dev/flutter/flutter_web_plugins/Registrar-class.html) registrar) void diff --git a/docs/talawa-mobile-docs/generated_plugin_registrant/registerPlugins.md b/docs/talawa-mobile-docs/generated_plugin_registrant/registerPlugins.md index 0614534bcc0..97840ab8afb 100644 --- a/docs/talawa-mobile-docs/generated_plugin_registrant/registerPlugins.md +++ b/docs/talawa-mobile-docs/generated_plugin_registrant/registerPlugins.md @@ -13,7 +13,7 @@ void registerPlugins -([Registrar](https://api.flutter.dev/flutter/flutter_web_plugins/Registrar-class.html) registrar) +([Registrar](https:api.flutter.dev/flutter/flutter_web_plugins/Registrar-class.html) registrar) @@ -25,13 +25,13 @@ void registerPlugins ## Implementation ```dart -void registerPlugins(Registrar registrar) { +void registerPlugins(Registrar registrar) \{ ConnectivityPlusPlugin.registerWith(registrar); SharedPreferencesPlugin.registerWith(registrar); UniLinksPlugin.registerWith(registrar); VibrationWebPlugin.registerWith(registrar); registrar.registerMessageHandler(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/index.md b/docs/talawa-mobile-docs/index.md index a21691b89af..4f6cd6ccccf 100644 --- a/docs/talawa-mobile-docs/index.md +++ b/docs/talawa-mobile-docs/index.md @@ -4,40 +4,40 @@ # talawa - Dart API docs -

Talawa

-

💬 Join the community on Slack

-

talawa-logo-lite-200x200

-

License: GPL v3 -GitHub stars -GitHub forks -codecov

-

Talawa is a comprehensive platform that aims to revolutionize the way organizations manage and interact with their data and content. Talawa empowers administrators to access and manage content with ease through the Talawa Admin interface, ensuring that information remains up-to-date and accessible to the platform's members.

-

With the Talawa API facilitating smooth communication between all parts of the platform, Talawa offers a cohesive and exceptional user experience for both administrators and members, making it a powerful tool for data management and content delivery seamlessly. Talawa is a modular open source project to manage group activities of both non-profit organizations and businesses.

-

Core features include:

-
    -
  1. Membership management
  2. -
  3. Groups management
  4. -
  5. Event registrations
  6. -
  7. Recurring meetings
  8. -
  9. Facilities registrations
  10. -
-

talawa is based on the original quito code created by the Palisadoes Foundation as part of its annual Calico Challenge program. Calico provides paid summer internships for Jamaican university students to work on selected open source projects. They are mentored by software professionals and receive stipends based on the completion of predefined milestones. Calico was started in 2015. Visit The Palisadoes Foundation's website for more details on its origin and activities.

-

Talawa Components

-

talawa has these major software components:

-
    -
  1. talawa: A mobile application with social media features
  2. -
  3. talawa-api: An API providing access to user data and features
  4. -
  5. talawa-admin: A web based administrative portal
  6. -
  7. talawa-docs: The online documentation website
  8. -
-

Documentation

-

Get familiar with talawa:

-
    -
  1. Read our Talawa Mobile App installation guide to get setup quickly.
  2. -
  3. The complete talawa documentation set can be found here.
  4. -
  5. Want to contribute? Look at CONTRIBUTING.md to get started.
  6. -
  7. Visit the Talawa GitHub to see the code.
  8. -
+\

Talawa\ +\\💬 Join the community on Slack\\ +\\talawa-logo-lite-200x200\ +\\\License: GPL v3\ +\\GitHub stars\ +\\GitHub forks\ +\\codecov\\ +\\Talawa\ is a comprehensive platform that aims to revolutionize the way organizations manage and interact with their data and content. Talawa empowers administrators to access and manage content with ease through the Talawa Admin interface, ensuring that information remains up-to-date and accessible to the platform's members.\ +\With the Talawa API facilitating smooth communication between all parts of the platform, Talawa offers a cohesive and exceptional user experience for both administrators and members, making it a powerful tool for data management and content delivery seamlessly. Talawa is a modular open source project to manage group activities of both non-profit organizations and businesses.\ +\Core features include:\ +\ +\Membership management\ +\Groups management\ +\Event registrations\ +\Recurring meetings\ +\Facilities registrations\ +\ +\\talawa\ is based on the original \quito\ code created by the \Palisadoes Foundation\ as part of its annual Calico Challenge program. Calico provides paid summer internships for Jamaican university students to work on selected open source projects. They are mentored by software professionals and receive stipends based on the completion of predefined milestones. Calico was started in 2015. Visit \The Palisadoes Foundation's website\ for more details on its origin and activities.\ +\

Talawa Components\ +\\talawa\ has these major software components:\ +\ +\\talawa\: \A mobile application with social media features\\ +\\talawa-api\: \An API providing access to user data and features\\ +\\talawa-admin\: \A web based administrative portal\\ +\\talawa-docs\: \The online documentation website\\ +\ +\

Documentation\ +\Get familiar with \talawa\:\ +\ +\Read our \Talawa Mobile App installation guide\ to get setup quickly.\ +\The complete talawa documentation set can be found \here\.\ +\Want to contribute? Look at \CONTRIBUTING.md\ to get started.\ +\Visit the \Talawa GitHub\ to see the code.\ +\ ## Libraries diff --git a/docs/talawa-mobile-docs/locator/connectivity.md b/docs/talawa-mobile-docs/locator/connectivity.md index 07e3320df74..eb2d7506fcb 100644 --- a/docs/talawa-mobile-docs/locator/connectivity.md +++ b/docs/talawa-mobile-docs/locator/connectivity.md @@ -11,20 +11,20 @@ -[Connectivity](https://pub.dev/documentation/connectivity_plus/4.0.2/connectivity_plus/Connectivity-class.html) connectivity +[Connectivity](https:pub.dev/documentation/connectivity_plus/4.0.2/connectivity_plus/Connectivity-class.html) connectivity -_final_ +_\final\_ -

creating GetIt for Connectivity.

+\creating GetIt for Connectivity.\ ## Implementation ```dart -final connectivity = locator(); +final connectivity = locator\(); ``` diff --git a/docs/talawa-mobile-docs/locator/databaseFunctions.md b/docs/talawa-mobile-docs/locator/databaseFunctions.md index 0c16f0a3609..21111f6e60e 100644 --- a/docs/talawa-mobile-docs/locator/databaseFunctions.md +++ b/docs/talawa-mobile-docs/locator/databaseFunctions.md @@ -13,18 +13,18 @@ [DataBaseMutationFunctions](../services_database_mutation_functions/DataBaseMutationFunctions-class.md) databaseFunctions -_final_ +_\final\_ -

creating GetIt for DataBaseMutationFunctions.

+\creating GetIt for DataBaseMutationFunctions.\ ## Implementation ```dart -final databaseFunctions = locator(); +final databaseFunctions = locator\(); ``` diff --git a/docs/talawa-mobile-docs/locator/graphqlConfig.md b/docs/talawa-mobile-docs/locator/graphqlConfig.md index 68ae14fd69d..3b1ea301fef 100644 --- a/docs/talawa-mobile-docs/locator/graphqlConfig.md +++ b/docs/talawa-mobile-docs/locator/graphqlConfig.md @@ -13,18 +13,18 @@ [GraphqlConfig](../services_graphql_config/GraphqlConfig-class.md) graphqlConfig -_final_ +_\final\_ -

creating GetIt for GraphqlConfig.

+\creating GetIt for GraphqlConfig.\ ## Implementation ```dart -final graphqlConfig = locator(); +final graphqlConfig = locator\(); ``` diff --git a/docs/talawa-mobile-docs/locator/imageCropper.md b/docs/talawa-mobile-docs/locator/imageCropper.md index 19e98b7bfd8..0104935c348 100644 --- a/docs/talawa-mobile-docs/locator/imageCropper.md +++ b/docs/talawa-mobile-docs/locator/imageCropper.md @@ -11,20 +11,20 @@ -[ImageCropper](https://pub.dev/documentation/image_cropper/4.0.1/image_cropper/ImageCropper-class.html) imageCropper +[ImageCropper](https:pub.dev/documentation/image_cropper/4.0.1/image_cropper/ImageCropper-class.html) imageCropper -_final_ +_\final\_ -

creating GetIt for ImageCropper.

+\creating GetIt for ImageCropper.\ ## Implementation ```dart -final imageCropper = locator(); +final imageCropper = locator\(); ``` diff --git a/docs/talawa-mobile-docs/locator/imagePicker.md b/docs/talawa-mobile-docs/locator/imagePicker.md index a2c8b70a010..34bdf009ab7 100644 --- a/docs/talawa-mobile-docs/locator/imagePicker.md +++ b/docs/talawa-mobile-docs/locator/imagePicker.md @@ -11,20 +11,20 @@ -[ImagePicker](https://pub.dev/documentation/image_picker/1.0.2/image_picker/ImagePicker-class.html) imagePicker +[ImagePicker](https:pub.dev/documentation/image_picker/1.0.2/image_picker/ImagePicker-class.html) imagePicker -_final_ +_\final\_ -

creating GetIt for ImagePicker.

+\creating GetIt for ImagePicker.\ ## Implementation ```dart -final imagePicker = locator(); +final imagePicker = locator\(); ``` diff --git a/docs/talawa-mobile-docs/locator/locator-library.md b/docs/talawa-mobile-docs/locator/locator-library.md index 0df1b4e88b8..f5b4f187883 100644 --- a/docs/talawa-mobile-docs/locator/locator-library.md +++ b/docs/talawa-mobile-docs/locator/locator-library.md @@ -20,12 +20,12 @@ ## Properties -##### [connectivity](../locator/connectivity.md) → [Connectivity](https://pub.dev/documentation/connectivity_plus/4.0.2/connectivity_plus/Connectivity-class.html) +##### [connectivity](../locator/connectivity.md) → [Connectivity](https:pub.dev/documentation/connectivity_plus/4.0.2/connectivity_plus/Connectivity-class.html) creating GetIt for Connectivity. -_final_ +_\final\_ @@ -34,7 +34,7 @@ _final_ creating GetIt for DataBaseMutationFunctions. -_final_ +_\final\_ @@ -43,34 +43,34 @@ _final_ creating GetIt for GraphqlConfig. -_final_ +_\final\_ -##### [imageCropper](../locator/imageCropper.md) → [ImageCropper](https://pub.dev/documentation/image_cropper/4.0.1/image_cropper/ImageCropper-class.html) +##### [imageCropper](../locator/imageCropper.md) → [ImageCropper](https:pub.dev/documentation/image_cropper/4.0.1/image_cropper/ImageCropper-class.html) creating GetIt for ImageCropper. -_final_ +_\final\_ -##### [imagePicker](../locator/imagePicker.md) → [ImagePicker](https://pub.dev/documentation/image_picker/1.0.2/image_picker/ImagePicker-class.html) +##### [imagePicker](../locator/imagePicker.md) → [ImagePicker](https:pub.dev/documentation/image_picker/1.0.2/image_picker/ImagePicker-class.html) creating GetIt for ImagePicker. -_final_ +_\final\_ -##### [locator](../locator/locator.md) ↔ [GetIt](https://pub.dev/documentation/get_it/7.6.0/get_it/GetIt-class.html) +##### [locator](../locator/locator.md) ↔ [GetIt](https:pub.dev/documentation/get_it/7.6.0/get_it/GetIt-class.html) Intializaing the locator. -_read / write_ +_\read / write\_ @@ -79,7 +79,7 @@ _read / write_ creating GetIt for NavigationService. -_final_ +_\final\_ @@ -88,7 +88,7 @@ _final_ creating GetIt for OrganizationService. -_final_ +_\final\_ @@ -97,7 +97,7 @@ _final_ creating GetIt for Queries. -_final_ +_\final\_ @@ -106,7 +106,7 @@ _final_ creating GetIt for SizeConfig. -_final_ +_\final\_ @@ -115,7 +115,7 @@ _final_ creating GetIt for UserConfig. -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/locator/locator.md b/docs/talawa-mobile-docs/locator/locator.md index 80b1db4624b..78e63ac5357 100644 --- a/docs/talawa-mobile-docs/locator/locator.md +++ b/docs/talawa-mobile-docs/locator/locator.md @@ -11,13 +11,13 @@ -[GetIt](https://pub.dev/documentation/get_it/7.6.0/get_it/GetIt-class.html) locator +[GetIt](https:pub.dev/documentation/get_it/7.6.0/get_it/GetIt-class.html) locator -_read / write_ +_\read / write\_ -

Intializaing the locator.

+\Intializaing the locator.\ diff --git a/docs/talawa-mobile-docs/locator/navigationService.md b/docs/talawa-mobile-docs/locator/navigationService.md index 2df4db664a8..ad6ad5d6ef7 100644 --- a/docs/talawa-mobile-docs/locator/navigationService.md +++ b/docs/talawa-mobile-docs/locator/navigationService.md @@ -13,18 +13,18 @@ [NavigationService](../services_navigation_service/NavigationService-class.md) navigationService -_final_ +_\final\_ -

creating GetIt for NavigationService.

+\creating GetIt for NavigationService.\ ## Implementation ```dart -final navigationService = locator(); +final navigationService = locator\(); ``` diff --git a/docs/talawa-mobile-docs/locator/organizationService.md b/docs/talawa-mobile-docs/locator/organizationService.md index 2ed728c6bf2..00463179d5a 100644 --- a/docs/talawa-mobile-docs/locator/organizationService.md +++ b/docs/talawa-mobile-docs/locator/organizationService.md @@ -13,18 +13,18 @@ [OrganizationService](../services_org_service/OrganizationService-class.md) organizationService -_final_ +_\final\_ -

creating GetIt for OrganizationService.

+\creating GetIt for OrganizationService.\ ## Implementation ```dart -final organizationService = locator(); +final organizationService = locator\(); ``` diff --git a/docs/talawa-mobile-docs/locator/queries.md b/docs/talawa-mobile-docs/locator/queries.md index 5c95eaf5809..4c2c666cea8 100644 --- a/docs/talawa-mobile-docs/locator/queries.md +++ b/docs/talawa-mobile-docs/locator/queries.md @@ -13,18 +13,18 @@ [Queries](../utils_queries/Queries-class.md) queries -_final_ +_\final\_ -

creating GetIt for Queries.

+\creating GetIt for Queries.\ ## Implementation ```dart -final queries = locator(); +final queries = locator\(); ``` diff --git a/docs/talawa-mobile-docs/locator/setupLocator.md b/docs/talawa-mobile-docs/locator/setupLocator.md index 9fc6a16ec32..16228829e65 100644 --- a/docs/talawa-mobile-docs/locator/setupLocator.md +++ b/docs/talawa-mobile-docs/locator/setupLocator.md @@ -19,81 +19,81 @@ void setupLocator -

This function registers the widgets/objects in "GetIt".

-

params: - None

-

returns: - None

+\This function registers the widgets/objects in "GetIt".\ +\\params\: + None\ +\\returns\: + None\ ## Implementation ```dart -void setupLocator() { - //services +void setupLocator() \{ + services locator.registerSingleton(NavigationService()); - //sizeConfig + sizeConfig locator.registerSingleton(SizeConfig()); locator.registerSingleton(Validator()); - //userConfig + userConfig locator.registerSingleton(UserConfig()); - //Services - locator.registerLazySingleton(() => PostService()); - locator.registerLazySingleton(() => EventService()); - locator.registerLazySingleton(() => TaskService()); - locator.registerLazySingleton(() => CommentService()); - locator.registerLazySingleton(() => OrganizationService()); - locator.registerLazySingleton(() => MultiMediaPickerService()); - locator.registerLazySingleton(() => Connectivity()); - locator.registerLazySingleton(() => ChatService()); - locator.registerLazySingleton(() => ImageCropper()); - locator.registerLazySingleton(() => ImagePicker()); - - //graphql + Services + locator.registerLazySingleton(() =\> PostService()); + locator.registerLazySingleton(() =\> EventService()); + locator.registerLazySingleton(() =\> TaskService()); + locator.registerLazySingleton(() =\> CommentService()); + locator.registerLazySingleton(() =\> OrganizationService()); + locator.registerLazySingleton(() =\> MultiMediaPickerService()); + locator.registerLazySingleton(() =\> Connectivity()); + locator.registerLazySingleton(() =\> ChatService()); + locator.registerLazySingleton(() =\> ImageCropper()); + locator.registerLazySingleton(() =\> ImagePicker()); + + graphql locator.registerSingleton(GraphqlConfig()); - //databaseMutationFunction + databaseMutationFunction locator.registerSingleton(DataBaseMutationFunctions()); - //queries + queries locator.registerSingleton(Queries()); - //Page viewModels - locator.registerFactory(() => DemoViewModel()); - // locator.registerFactory(() => OrganizationFeedViewModel()); - locator.registerFactory(() => OrganizationFeedViewModel()); - locator.registerFactory(() => SetUrlViewModel()); - locator.registerFactory(() => LoginViewModel()); - - locator.registerFactory(() => SelectOrganizationViewModel()); - locator.registerFactory(() => SignupDetailsViewModel()); - locator.registerFactory(() => WaitingViewModel()); - locator.registerFactory(() => ExploreEventsViewModel()); - locator.registerFactory(() => ExploreTasksViewModel()); - locator.registerFactory(() => CreateTaskViewModel()); - locator.registerFactory(() => MainScreenViewModel()); - locator.registerFactory(() => ProfilePageViewModel()); - locator.registerFactory(() => EditProfilePageViewModel()); - locator.registerFactory(() => CreateEventViewModel()); - locator.registerFactory(() => EditEventViewModel()); - locator.registerFactory(() => AddPostViewModel()); - locator.registerFactory(() => EventInfoViewModel()); - - //Widgets viewModels - locator.registerFactory(() => ProgressDialogViewModel()); - locator.registerFactory(() => CustomDrawerViewModel()); - locator.registerFactory(() => LikeButtonViewModel()); - locator.registerFactory(() => AppLanguage()); - locator.registerFactory(() => CommentsViewModel()); - locator.registerFactory(() => AppTheme()); - locator.registerFactory(() => DirectChatViewModel()); - locator.registerFactory(() => AccessScreenViewModel()); -} + Page viewModels + locator.registerFactory(() =\> DemoViewModel()); + locator.registerFactory(() =\> OrganizationFeedViewModel()); + locator.registerFactory(() =\> OrganizationFeedViewModel()); + locator.registerFactory(() =\> SetUrlViewModel()); + locator.registerFactory(() =\> LoginViewModel()); + + locator.registerFactory(() =\> SelectOrganizationViewModel()); + locator.registerFactory(() =\> SignupDetailsViewModel()); + locator.registerFactory(() =\> WaitingViewModel()); + locator.registerFactory(() =\> ExploreEventsViewModel()); + locator.registerFactory(() =\> ExploreTasksViewModel()); + locator.registerFactory(() =\> CreateTaskViewModel()); + locator.registerFactory(() =\> MainScreenViewModel()); + locator.registerFactory(() =\> ProfilePageViewModel()); + locator.registerFactory(() =\> EditProfilePageViewModel()); + locator.registerFactory(() =\> CreateEventViewModel()); + locator.registerFactory(() =\> EditEventViewModel()); + locator.registerFactory(() =\> AddPostViewModel()); + locator.registerFactory(() =\> EventInfoViewModel()); + + Widgets viewModels + locator.registerFactory(() =\> ProgressDialogViewModel()); + locator.registerFactory(() =\> CustomDrawerViewModel()); + locator.registerFactory(() =\> LikeButtonViewModel()); + locator.registerFactory(() =\> AppLanguage()); + locator.registerFactory(() =\> CommentsViewModel()); + locator.registerFactory(() =\> AppTheme()); + locator.registerFactory(() =\> DirectChatViewModel()); + locator.registerFactory(() =\> AccessScreenViewModel()); +\} ``` diff --git a/docs/talawa-mobile-docs/locator/sizeConfig.md b/docs/talawa-mobile-docs/locator/sizeConfig.md index 413c9f786e0..d5da8aab249 100644 --- a/docs/talawa-mobile-docs/locator/sizeConfig.md +++ b/docs/talawa-mobile-docs/locator/sizeConfig.md @@ -13,18 +13,18 @@ [SizeConfig](../services_size_config/SizeConfig-class.md) sizeConfig -_final_ +_\final\_ -

creating GetIt for SizeConfig.

+\creating GetIt for SizeConfig.\ ## Implementation ```dart -final sizeConfig = locator(); +final sizeConfig = locator\(); ``` diff --git a/docs/talawa-mobile-docs/locator/userConfig.md b/docs/talawa-mobile-docs/locator/userConfig.md index cb96aca5480..c69e3959dc3 100644 --- a/docs/talawa-mobile-docs/locator/userConfig.md +++ b/docs/talawa-mobile-docs/locator/userConfig.md @@ -13,18 +13,18 @@ [UserConfig](../services_user_config/UserConfig-class.md) userConfig -_final_ +_\final\_ -

creating GetIt for UserConfig.

+\creating GetIt for UserConfig.\ ## Implementation ```dart -final userConfig = locator(); +final userConfig = locator\(); ``` diff --git a/docs/talawa-mobile-docs/main/DemoPageView-class.md b/docs/talawa-mobile-docs/main/DemoPageView-class.md index 08b2e0d15a7..2aed12ae2dc 100644 --- a/docs/talawa-mobile-docs/main/DemoPageView-class.md +++ b/docs/talawa-mobile-docs/main/DemoPageView-class.md @@ -11,17 +11,17 @@ -

PageView is a scrollable list that works page by page.

-

DemoPageView is demo PageView of Talawa Mobile App.

+\PageView is a scrollable list that works page by page.\ +\DemoPageView is demo PageView of Talawa Mobile App.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - DemoPageView @@ -33,37 +33,37 @@ ## Constructors -[DemoPageView](../main/DemoPageView/DemoPageView.md) ({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key}) +[DemoPageView](../main/DemoPageView/DemoPageView.md) (\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -71,95 +71,95 @@ _read-onlyinherited_ ## Methods -##### [build](../main/DemoPageView/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../main/DemoPageView/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -167,12 +167,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/main/DemoPageView/DemoPageView.md b/docs/talawa-mobile-docs/main/DemoPageView/DemoPageView.md index dbddcb13aea..3fdcbe25305 100644 --- a/docs/talawa-mobile-docs/main/DemoPageView/DemoPageView.md +++ b/docs/talawa-mobile-docs/main/DemoPageView/DemoPageView.md @@ -9,7 +9,7 @@ const -DemoPageView({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key}) +DemoPageView(\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key\}) @@ -18,7 +18,7 @@ DemoPageView({required [Key](https://api.flutter.dev/flutter/foundation/Key-clas ## Implementation ```dart -const DemoPageView({required Key key}) : super(key: key); +const DemoPageView(\{required Key key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/main/DemoPageView/build.md b/docs/talawa-mobile-docs/main/DemoPageView/build.md index 9fd20f7759e..a57eb2b1de1 100644 --- a/docs/talawa-mobile-docs/main/DemoPageView/build.md +++ b/docs/talawa-mobile-docs/main/DemoPageView/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,10 +58,10 @@ and ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ FetchPluginList(); - return BaseView( - builder: (context, model, child) => Scaffold( + return BaseView\( + builder: (context, model, child) =\> Scaffold( appBar: AppBar( title: Text(AppLocalizations.of(context)!.strictTranslate('Demo Page')), @@ -71,7 +71,7 @@ Widget build(BuildContext context) { ), ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/main/DemoViewModel-class.md b/docs/talawa-mobile-docs/main/DemoViewModel-class.md index 3c395e0ad86..88176d554cd 100644 --- a/docs/talawa-mobile-docs/main/DemoViewModel-class.md +++ b/docs/talawa-mobile-docs/main/DemoViewModel-class.md @@ -11,16 +11,16 @@ -

ViewModel uses property-based data binding to establish a connection.

-

between the ViewModel and the View, and drives the View changes -through the ViewModel. DemoViewModel is the ViewModel for DemoPageView.

+\ViewModel uses property-based data binding to establish a connection.\ +\between the ViewModel and the View, and drives the View changes +through the ViewModel. DemoViewModel is the ViewModel for DemoPageView.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) - [BaseModel](../view_model_base_view_model/BaseModel-class.md) - DemoViewModel @@ -40,39 +40,39 @@ through the ViewModel. DemoViewModel is the ViewModel for DemoPageView.

## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hasListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hasListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether any listeners are currently registered. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -81,16 +81,16 @@ _read-onlyinherited_ -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [title](../main/DemoViewModel/title.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [title](../main/DemoViewModel/title.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Getter function of the title. -_read-only_ +_\read-only\_ @@ -98,51 +98,51 @@ _read-only_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be called when the object changes. -_inherited_ +_\inherited\_ -##### [dispose](https://api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void +##### [dispose](https:api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -
addListener will throw after the object is disposed). -_inherited_ +\addListener\ will throw after the object is disposed). +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void +##### [notifyListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void Call all the registered listeners. -_inherited_ +_\inherited\_ -##### [removeListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that are notified when the object changes. -_inherited_ +_\inherited\_ @@ -151,16 +151,16 @@ _inherited_ -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -168,12 +168,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/main/DemoViewModel/title.md b/docs/talawa-mobile-docs/main/DemoViewModel/title.md index 0e557780134..44d79afdb65 100644 --- a/docs/talawa-mobile-docs/main/DemoViewModel/title.md +++ b/docs/talawa-mobile-docs/main/DemoViewModel/title.md @@ -11,26 +11,26 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) title +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) title -

Getter function of the title.

-

params: +\Getter function of the title.\ +\params: None -returns:

-
    -
  • String: title of the model
  • -
+returns:\ +\ +\\String\: title of the model\ +\ ## Implementation ```dart -String get title => _title; +String get title =\> _title; ``` diff --git a/docs/talawa-mobile-docs/main/MyApp-class.md b/docs/talawa-mobile-docs/main/MyApp-class.md index c76b3c6a3b6..1870e0ff8c6 100644 --- a/docs/talawa-mobile-docs/main/MyApp-class.md +++ b/docs/talawa-mobile-docs/main/MyApp-class.md @@ -11,16 +11,16 @@ -

Main widget that sets up the quick actions, internationalization, routing , notifications.

+\Main widget that sets up the quick actions, internationalization, routing , notifications.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html) - MyApp @@ -39,30 +39,30 @@ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -70,12 +70,12 @@ _read-onlyinherited_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a
StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ @@ -84,81 +84,81 @@ _inherited_ Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -166,12 +166,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/main/MyApp/createState.md b/docs/talawa-mobile-docs/main/MyApp/createState.md index b001fadad16..89f8515c6b4 100644 --- a/docs/talawa-mobile-docs/main/MyApp/createState.md +++ b/docs/talawa-mobile-docs/main/MyApp/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) _MyAppState createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh read / write_ +_\read / write\_ -

HashMap of Firebase options for android.

+\HashMap of Firebase options for android.\ ## Implementation ```dart -late Map androidFirebaseOptions; +late Map\ androidFirebaseOptions; ``` diff --git a/docs/talawa-mobile-docs/main/channel.md b/docs/talawa-mobile-docs/main/channel.md index 5f4cada3f97..31de5b52d3d 100644 --- a/docs/talawa-mobile-docs/main/channel.md +++ b/docs/talawa-mobile-docs/main/channel.md @@ -11,13 +11,13 @@ -[AndroidNotificationChannel](https://pub.dev/documentation/flutter_local_notifications/15.1.0+1/flutter_local_notifications/AndroidNotificationChannel-class.html) channel +[AndroidNotificationChannel](https:pub.dev/documentation/flutter_local_notifications/15.1.0+1/flutter_local_notifications/AndroidNotificationChannel-class.html) channel -_read / write_ +_\read / write\_ -

Create a AndroidNotificationChannel for heads up notifications.

+\Create a \AndroidNotificationChannel\ for heads up notifications.\ diff --git a/docs/talawa-mobile-docs/main/flutterLocalNotificationsPlugin.md b/docs/talawa-mobile-docs/main/flutterLocalNotificationsPlugin.md index fb311aba4f1..f92a74d4703 100644 --- a/docs/talawa-mobile-docs/main/flutterLocalNotificationsPlugin.md +++ b/docs/talawa-mobile-docs/main/flutterLocalNotificationsPlugin.md @@ -11,13 +11,13 @@ -[FlutterLocalNotificationsPlugin](https://pub.dev/documentation/flutter_local_notifications/15.1.0+1/flutter_local_notifications/FlutterLocalNotificationsPlugin-class.html) flutterLocalNotificationsPlugin +[FlutterLocalNotificationsPlugin](https:pub.dev/documentation/flutter_local_notifications/15.1.0+1/flutter_local_notifications/FlutterLocalNotificationsPlugin-class.html) flutterLocalNotificationsPlugin -_read / write_ +_\read / write\_ -

Initialize the FlutterLocalNotificationsPlugin package.

+\Initialize the \FlutterLocalNotificationsPlugin\ package.\ diff --git a/docs/talawa-mobile-docs/main/iosFirebaseOptions.md b/docs/talawa-mobile-docs/main/iosFirebaseOptions.md index a92e5f8da77..4dffbe8f80c 100644 --- a/docs/talawa-mobile-docs/main/iosFirebaseOptions.md +++ b/docs/talawa-mobile-docs/main/iosFirebaseOptions.md @@ -11,20 +11,20 @@ -[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> iosFirebaseOptions +[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> iosFirebaseOptions -_read / write_ +_\read / write\_ -

HashMap of Firebase options for android.

+\HashMap of Firebase options for android.\ ## Implementation ```dart -late Map iosFirebaseOptions; +late Map\ iosFirebaseOptions; ``` diff --git a/docs/talawa-mobile-docs/main/main-library.md b/docs/talawa-mobile-docs/main/main-library.md index 1041a7965d4..2d34de43b40 100644 --- a/docs/talawa-mobile-docs/main/main-library.md +++ b/docs/talawa-mobile-docs/main/main-library.md @@ -43,46 +43,46 @@ Main widget that sets up the quick actions, internationalization, routing , noti ## Properties -##### [androidFirebaseOptions](../main/androidFirebaseOptions.md) ↔ [Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> +##### [androidFirebaseOptions](../main/androidFirebaseOptions.md) ↔ [Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> HashMap of Firebase options for android. -_read / write_ +_\read / write\_ -##### [channel](../main/channel.md) ↔ [AndroidNotificationChannel](https://pub.dev/documentation/flutter_local_notifications/15.1.0+1/flutter_local_notifications/AndroidNotificationChannel-class.html) +##### [channel](../main/channel.md) ↔ [AndroidNotificationChannel](https:pub.dev/documentation/flutter_local_notifications/15.1.0+1/flutter_local_notifications/AndroidNotificationChannel-class.html) -Create a
AndroidNotificationChannel for heads up notifications. -_read / write_ +Create a \AndroidNotificationChannel\ for heads up notifications. +_\read / write\_ -##### [flutterLocalNotificationsPlugin](../main/flutterLocalNotificationsPlugin.md) ↔ [FlutterLocalNotificationsPlugin](https://pub.dev/documentation/flutter_local_notifications/15.1.0+1/flutter_local_notifications/FlutterLocalNotificationsPlugin-class.html) +##### [flutterLocalNotificationsPlugin](../main/flutterLocalNotificationsPlugin.md) ↔ [FlutterLocalNotificationsPlugin](https:pub.dev/documentation/flutter_local_notifications/15.1.0+1/flutter_local_notifications/FlutterLocalNotificationsPlugin-class.html) -Initialize the FlutterLocalNotificationsPlugin package. -_read / write_ +Initialize the \FlutterLocalNotificationsPlugin\ package. +_\read / write\_ -##### [iosFirebaseOptions](../main/iosFirebaseOptions.md) ↔ [Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> +##### [iosFirebaseOptions](../main/iosFirebaseOptions.md) ↔ [Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> HashMap of Firebase options for android. -_read / write_ +_\read / write\_ ## Functions -##### [main](../main/main.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [main](../main/main.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -91,7 +91,7 @@ First function to initialize the application, invoked automatically. -##### [setUpFirebase](../main/setUpFirebase.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [setUpFirebase](../main/setUpFirebase.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -100,7 +100,7 @@ Initializes the firebase in the app according to the userplatform (android/iOS). -##### [setUpFirebaseKeys](../main/setUpFirebaseKeys.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [setUpFirebaseKeys](../main/setUpFirebaseKeys.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -109,7 +109,7 @@ Initializes the firebase keys in the app according to the userplatform (android/ -##### [setUpFirebaseMessaging](../main/setUpFirebaseMessaging.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [setUpFirebaseMessaging](../main/setUpFirebaseMessaging.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> diff --git a/docs/talawa-mobile-docs/main/main.md b/docs/talawa-mobile-docs/main/main.md index 4572429104d..76e699d1627 100644 --- a/docs/talawa-mobile-docs/main/main.md +++ b/docs/talawa-mobile-docs/main/main.md @@ -12,49 +12,49 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> main +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> main () -

First function to initialize the application, invoked automatically.

-

params: - None

-

returns:

-
    -
  • Future<void>: resolves if the application was successfully initialized.
  • -
+\First function to initialize the application, invoked automatically.\ +\\params\: + None\ +\\returns\:\ +\ +\\Future<void>\: resolves if the application was successfully initialized.\ +\ ## Implementation ```dart -Future main() async { - // Returns an instance of the binding that implements WidgetsBinding. +Future\ main() async \{ + Returns an instance of the binding that implements WidgetsBinding. WidgetsFlutterBinding.ensureInitialized(); - if (!kIsWeb) { + if (!kIsWeb) \{ channel = const AndroidNotificationChannel( - 'high_importance_channel', // id - 'High Importance Notifications', // title + 'high_importance_channel', id + 'High Importance Notifications', title description: - 'This channel is used for important notifications.', // description + 'This channel is used for important notifications.', description importance: Importance.high, ); flutterLocalNotificationsPlugin = FlutterLocalNotificationsPlugin(); - // Create an Android Notification Channel. - // We use this channel in the `AndroidManifest.xml` file to override the - // default FCM channel to enable heads up notifications. + Create an Android Notification Channel. + We use this channel in the `AndroidManifest.xml` file to override the + default FCM channel to enable heads up notifications. await flutterLocalNotificationsPlugin - .resolvePlatformSpecificImplementation< - AndroidFlutterLocalNotificationsPlugin>() + .resolvePlatformSpecificImplementation\< + AndroidFlutterLocalNotificationsPlugin\>() ?.createNotificationChannel(channel); - } + \} final Directory dir = await path.getApplicationDocumentsDirectory(); Hive @@ -62,29 +62,29 @@ Future main() async { ..registerAdapter(UserAdapter()) ..registerAdapter(OrgInfoAdapter()); - await Hive.openBox('currentUser'); - await Hive.openBox('currentOrg'); + await Hive.openBox\('currentUser'); + await Hive.openBox\('currentOrg'); await Hive.openBox('pluginBox'); await Hive.openBox('url'); final urlBox = await Hive.openBox('url'); - try { - if (urlBox.get('url') != null) { + try \{ + if (urlBox.get('url') != null) \{ await setUpFirebaseKeys(); await setUpFirebase(); await setUpFirebaseMessaging(); - } - } catch (e) { + \} + \} catch (e) \{ print("Firebase not working"); - } + \} setupLocator(); - // The runApp() function takes the given Widget and makes it the root of the widget tree. + The runApp() function takes the given Widget and makes it the root of the widget tree. runApp(MyApp()); -} +\} ``` diff --git a/docs/talawa-mobile-docs/main/setUpFirebase.md b/docs/talawa-mobile-docs/main/setUpFirebase.md index 91557e294a3..b49597e4eaa 100644 --- a/docs/talawa-mobile-docs/main/setUpFirebase.md +++ b/docs/talawa-mobile-docs/main/setUpFirebase.md @@ -12,34 +12,34 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> setUpFirebase +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> setUpFirebase () -

Initializes the firebase in the app according to the userplatform (android/iOS).

-

params: - None

-

returns:

-
    -
  • Future<void>: promise that will be fulfilled Firebase is setted up in app.
  • -
+\Initializes the firebase in the app according to the userplatform (android/iOS).\ +\\params\: + None\ +\\returns\:\ +\ +\\Future<void>\: promise that will be fulfilled Firebase is setted up in app.\ +\ ## Implementation ```dart -Future setUpFirebase() async { +Future\ setUpFirebase() async \{ await Firebase.initializeApp( options: DefaultFirebaseOptions.currentPlatform( androidFirebaseOptions, iosFirebaseOptions, ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/main/setUpFirebaseKeys.md b/docs/talawa-mobile-docs/main/setUpFirebaseKeys.md index ca716d0d641..324908a8ce4 100644 --- a/docs/talawa-mobile-docs/main/setUpFirebaseKeys.md +++ b/docs/talawa-mobile-docs/main/setUpFirebaseKeys.md @@ -12,46 +12,46 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> setUpFirebaseKeys +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> setUpFirebaseKeys () -

Initializes the firebase keys in the app according to the userplatform (android/iOS).

-

params: - None

-

returns:

-
    -
  • Future<void>: promise that will be fulfilled Firebase keys are setted up.
  • -
+\Initializes the firebase keys in the app according to the userplatform (android/iOS).\ +\\params\: + None\ +\\returns\:\ +\ +\\Future<void>\: promise that will be fulfilled Firebase keys are setted up.\ +\ ## Implementation ```dart -Future setUpFirebaseKeys() async { +Future\ setUpFirebaseKeys() async \{ final androidFirebaseOptionsBox = await Hive.openBox('androidFirebaseOptions'); final androidFirebaseOptionsMap = androidFirebaseOptionsBox - .get('androidFirebaseOptions') as Map?; + .get('androidFirebaseOptions') as Map\?; final iosFirebaseOptionsBox = await Hive.openBox('iosFirebaseOptions'); final iosFirebaseOptionsMap = - iosFirebaseOptionsBox.get('iosFirebaseOptions') as Map?; - if (androidFirebaseOptionsMap != null) { - androidFirebaseOptions = androidFirebaseOptionsMap.map((key, value) { + iosFirebaseOptionsBox.get('iosFirebaseOptions') as Map\?; + if (androidFirebaseOptionsMap != null) \{ + androidFirebaseOptions = androidFirebaseOptionsMap.map((key, value) \{ return MapEntry(key.toString(), value); - }); - } - if (iosFirebaseOptionsMap != null) { - iosFirebaseOptions = iosFirebaseOptionsMap.map((key, value) { + \}); + \} + if (iosFirebaseOptionsMap != null) \{ + iosFirebaseOptions = iosFirebaseOptionsMap.map((key, value) \{ return MapEntry(key.toString(), value); - }); - } -} + \}); + \} +\} ``` diff --git a/docs/talawa-mobile-docs/main/setUpFirebaseMessaging.md b/docs/talawa-mobile-docs/main/setUpFirebaseMessaging.md index d28c01b84ca..3e061f3bf4f 100644 --- a/docs/talawa-mobile-docs/main/setUpFirebaseMessaging.md +++ b/docs/talawa-mobile-docs/main/setUpFirebaseMessaging.md @@ -12,31 +12,31 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> setUpFirebaseMessaging +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> setUpFirebaseMessaging () -

Set up firebase instance, enbables messaging,listens to icoming messages.

-

params: - None

-

returns:

-
    -
  • Future<void>: promise that will be fulfilled Firebase is setted up.
  • -
+\Set up firebase instance, enbables messaging,listens to icoming messages.\ +\\params\: + None\ +\\returns\:\ +\ +\\Future<void>\: promise that will be fulfilled Firebase is setted up.\ +\ ## Implementation ```dart -Future setUpFirebaseMessaging() async { - /// Set the background messaging handler early on, as a named top-level function +Future\ setUpFirebaseMessaging() async \{ + Set the background messaging handler early on, as a named top-level function FirebaseMessaging.onBackgroundMessage(_firebaseMessagingBackgroundHandler); - // Update the iOS foreground notification presentation options to allow heads up notifications. + Update the iOS foreground notification presentation options to allow heads up notifications. await FirebaseMessaging.instance.setForegroundNotificationPresentationOptions( alert: true, badge: true, @@ -45,12 +45,12 @@ Future setUpFirebaseMessaging() async { FirebaseMessaging.instance .getInitialMessage() - .then((RemoteMessage? message) {}); + .then((RemoteMessage? message) \{\}); - FirebaseMessaging.onMessage.listen((RemoteMessage message) { + FirebaseMessaging.onMessage.listen((RemoteMessage message) \{ final RemoteNotification? notification = message.notification; final AndroidNotification? android = message.notification?.android; - if (notification != null && android != null && !kIsWeb) { + if (notification != null && android != null && !kIsWeb) \{ flutterLocalNotificationsPlugin.show( notification.hashCode, notification.title, @@ -64,11 +64,11 @@ Future setUpFirebaseMessaging() async { ), ), ); - } - }); + \} + \}); - FirebaseMessaging.onMessageOpenedApp.listen((RemoteMessage message) {}); -} + FirebaseMessaging.onMessageOpenedApp.listen((RemoteMessage message) \{\}); +\} ``` diff --git a/docs/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md b/docs/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md index 7a107b7674d..2ceda8660a3 100644 --- a/docs/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md +++ b/docs/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md @@ -11,7 +11,7 @@ -

This class creates JSON code using the JsonSerializable package.

+\This class creates JSON code using the JsonSerializable package.\ @@ -23,55 +23,55 @@ **Annotations** -- @[JsonSerializable](https://pub.dev/documentation/json_annotation/4.8.1/json_annotation/JsonSerializable-class.html)() +- @[JsonSerializable](https:pub.dev/documentation/json_annotation/4.8.1/json_annotation/JsonSerializable-class.html)() ## Constructors -[ChatListTileDataModel](../models_chats_chat_list_tile_data_model/ChatListTileDataModel/ChatListTileDataModel.md) ([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[ChatUser](../models_chats_chat_user/ChatUser-class.md)>? users, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? id) +[ChatListTileDataModel](../models_chats_chat_list_tile_data_model/ChatListTileDataModel/ChatListTileDataModel.md) ([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[ChatUser](../models_chats_chat_user/ChatUser-class.md)\>? users, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? id) -[ChatListTileDataModel.fromJson](../models_chats_chat_list_tile_data_model/ChatListTileDataModel/ChatListTileDataModel.fromJson.md) ([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> json) +[ChatListTileDataModel.fromJson](../models_chats_chat_list_tile_data_model/ChatListTileDataModel/ChatListTileDataModel.fromJson.md) ([Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> json) _factory_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [id](../models_chats_chat_list_tile_data_model/ChatListTileDataModel/id.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [id](../models_chats_chat_list_tile_data_model/ChatListTileDataModel/id.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [users](../models_chats_chat_list_tile_data_model/ChatListTileDataModel/users.md) ↔ [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[ChatUser](../models_chats_chat_user/ChatUser-class.md)>? +##### [users](../models_chats_chat_list_tile_data_model/ChatListTileDataModel/users.md) ↔ [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[ChatUser](../models_chats_chat_user/ChatUser-class.md)\>? -_read / write_ +_\read / write\_ @@ -79,16 +79,16 @@ _read / write_ ## Methods -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toJson](../models_chats_chat_list_tile_data_model/ChatListTileDataModel/toJson.md)() [Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> +##### [toJson](../models_chats_chat_list_tile_data_model/ChatListTileDataModel/toJson.md)() [Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> @@ -97,12 +97,12 @@ _inherited_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -110,12 +110,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/ChatListTileDataModel.fromJson.md b/docs/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/ChatListTileDataModel.fromJson.md index c969f9259f2..bc6955a260b 100644 --- a/docs/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/ChatListTileDataModel.fromJson.md +++ b/docs/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/ChatListTileDataModel.fromJson.md @@ -9,7 +9,7 @@ -ChatListTileDataModel.fromJson([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> json) +ChatListTileDataModel.fromJson([Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> json) @@ -18,7 +18,7 @@ ChatListTileDataModel.fromJson([Map](https://api.flutter.dev/flutter/dart-core/M ## Implementation ```dart -factory ChatListTileDataModel.fromJson(Map json) => +factory ChatListTileDataModel.fromJson(Map\ json) =\> _$ChatListTileDataModelFromJson(json); ``` diff --git a/docs/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/ChatListTileDataModel.md b/docs/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/ChatListTileDataModel.md index ee3832b3723..37f26e1d8df 100644 --- a/docs/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/ChatListTileDataModel.md +++ b/docs/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/ChatListTileDataModel.md @@ -9,7 +9,7 @@ -ChatListTileDataModel([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[ChatUser](../../models_chats_chat_user/ChatUser-class.md)>? users, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? id) +ChatListTileDataModel([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[ChatUser](../../models_chats_chat_user/ChatUser-class.md)\>? users, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? id) diff --git a/docs/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/id.md b/docs/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/id.md index 833ed271b41..4d29a2dd9d4 100644 --- a/docs/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/id.md +++ b/docs/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/id.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? id +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? id -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/toJson.md b/docs/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/toJson.md index 8b766cc4e61..1939f2f0164 100644 --- a/docs/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/toJson.md +++ b/docs/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/toJson.md @@ -10,7 +10,7 @@ -[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> toJson +[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> toJson () @@ -23,7 +23,7 @@ ## Implementation ```dart -Map toJson() => _$ChatListTileDataModelToJson(this); +Map\ toJson() =\> _$ChatListTileDataModelToJson(this); ``` diff --git a/docs/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/users.md b/docs/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/users.md index 58ed251cb7e..5c4972b1817 100644 --- a/docs/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/users.md +++ b/docs/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/users.md @@ -9,9 +9,9 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[ChatUser](../../models_chats_chat_user/ChatUser-class.md)>? users +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[ChatUser](../../models_chats_chat_user/ChatUser-class.md)\>? users -_read / write_ +_\read / write\_ @@ -21,7 +21,7 @@ _read / write_ ## Implementation ```dart -List? users; +List\? users; ``` diff --git a/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage-class.md b/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage-class.md index 4c38ab4232d..7c53b3c7596 100644 --- a/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage-class.md +++ b/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage-class.md @@ -11,7 +11,7 @@ -

This class creates JSON code for chat message using the JsonSerializable package.

+\This class creates JSON code for chat message using the JsonSerializable package.\ @@ -23,46 +23,46 @@ **Annotations** -- @[JsonSerializable](https://pub.dev/documentation/json_annotation/4.8.1/json_annotation/JsonSerializable-class.html)(explicitToJson: true) +- @[JsonSerializable](https:pub.dev/documentation/json_annotation/4.8.1/json_annotation/JsonSerializable-class.html)(explicitToJson: true) ## Constructors -[ChatMessage](../models_chats_chat_message/ChatMessage/ChatMessage.md) ([String](https://api.flutter.dev/flutter/dart-core/String-class.html)? id, [ChatUser](../models_chats_chat_user/ChatUser-class.md)? sender, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? messageContent, [ChatUser](../models_chats_chat_user/ChatUser-class.md)? receiver) +[ChatMessage](../models_chats_chat_message/ChatMessage/ChatMessage.md) ([String](https:api.flutter.dev/flutter/dart-core/String-class.html)? id, [ChatUser](../models_chats_chat_user/ChatUser-class.md)? sender, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? messageContent, [ChatUser](../models_chats_chat_user/ChatUser-class.md)? receiver) -[ChatMessage.fromJson](../models_chats_chat_message/ChatMessage/ChatMessage.fromJson.md) ([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> json) +[ChatMessage.fromJson](../models_chats_chat_message/ChatMessage/ChatMessage.fromJson.md) ([Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> json) _factory_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [id](../models_chats_chat_message/ChatMessage/id.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [id](../models_chats_chat_message/ChatMessage/id.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [messageContent](../models_chats_chat_message/ChatMessage/messageContent.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [messageContent](../models_chats_chat_message/ChatMessage/messageContent.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ @@ -71,16 +71,16 @@ _read / write_ -_read / write_ +_\read / write\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -89,7 +89,7 @@ _read-onlyinherited_ -_read / write_ +_\read / write\_ @@ -97,16 +97,16 @@ _read / write_ ## Methods -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toJson](../models_chats_chat_message/ChatMessage/toJson.md)() [Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> +##### [toJson](../models_chats_chat_message/ChatMessage/toJson.md)() [Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> @@ -115,12 +115,12 @@ _inherited_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -128,12 +128,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/ChatMessage.fromJson.md b/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/ChatMessage.fromJson.md index 514060af9f5..a49c646e701 100644 --- a/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/ChatMessage.fromJson.md +++ b/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/ChatMessage.fromJson.md @@ -9,7 +9,7 @@ -ChatMessage.fromJson([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> json) +ChatMessage.fromJson([Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> json) @@ -18,7 +18,7 @@ ChatMessage.fromJson([Map](https://api.flutter.dev/flutter/dart-core/Map-class.h ## Implementation ```dart -factory ChatMessage.fromJson(Map json) => +factory ChatMessage.fromJson(Map\ json) =\> _$ChatMessageFromJson(json); ``` diff --git a/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/ChatMessage.md b/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/ChatMessage.md index 78e85c05dad..ba805451227 100644 --- a/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/ChatMessage.md +++ b/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/ChatMessage.md @@ -9,7 +9,7 @@ -ChatMessage([String](https://api.flutter.dev/flutter/dart-core/String-class.html)? id, [ChatUser](../../models_chats_chat_user/ChatUser-class.md)? sender, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? messageContent, [ChatUser](../../models_chats_chat_user/ChatUser-class.md)? receiver) +ChatMessage([String](https:api.flutter.dev/flutter/dart-core/String-class.html)? id, [ChatUser](../../models_chats_chat_user/ChatUser-class.md)? sender, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? messageContent, [ChatUser](../../models_chats_chat_user/ChatUser-class.md)? receiver) diff --git a/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/id.md b/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/id.md index 833ed271b41..4d29a2dd9d4 100644 --- a/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/id.md +++ b/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/id.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? id +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? id -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/messageContent.md b/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/messageContent.md index 372a20d7ae0..bf2e2e0cf5d 100644 --- a/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/messageContent.md +++ b/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/messageContent.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? messageContent +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? messageContent -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/receiver.md b/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/receiver.md index 7887b8cf45f..a2d988e8e1a 100644 --- a/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/receiver.md +++ b/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/receiver.md @@ -11,7 +11,7 @@ [ChatUser](../../models_chats_chat_user/ChatUser-class.md)? receiver -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/sender.md b/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/sender.md index 4b8806efbe5..89c0ae400ef 100644 --- a/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/sender.md +++ b/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/sender.md @@ -11,7 +11,7 @@ [ChatUser](../../models_chats_chat_user/ChatUser-class.md)? sender -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/toJson.md b/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/toJson.md index 0f7c47e942b..2d23522fd2b 100644 --- a/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/toJson.md +++ b/docs/talawa-mobile-docs/models_chats_chat_message/ChatMessage/toJson.md @@ -10,7 +10,7 @@ -[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> toJson +[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> toJson () @@ -23,7 +23,7 @@ ## Implementation ```dart -Map toJson() => _$ChatMessageToJson(this); +Map\ toJson() =\> _$ChatMessageToJson(this); ``` diff --git a/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser-class.md b/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser-class.md index 18020e727c3..b551539c745 100644 --- a/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser-class.md +++ b/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser-class.md @@ -11,7 +11,7 @@ -

This class creates JSON code for chat user using the JsonSerializable package.

+\This class creates JSON code for chat user using the JsonSerializable package.\ @@ -23,64 +23,64 @@ **Annotations** -- @[JsonSerializable](https://pub.dev/documentation/json_annotation/4.8.1/json_annotation/JsonSerializable-class.html)() +- @[JsonSerializable](https:pub.dev/documentation/json_annotation/4.8.1/json_annotation/JsonSerializable-class.html)() ## Constructors -[ChatUser](../models_chats_chat_user/ChatUser/ChatUser.md) ({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? firstName, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? id, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? image}) +[ChatUser](../models_chats_chat_user/ChatUser/ChatUser.md) (\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? firstName, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? id, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? image\}) -[ChatUser.fromJson](../models_chats_chat_user/ChatUser/ChatUser.fromJson.md) ([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> json) +[ChatUser.fromJson](../models_chats_chat_user/ChatUser/ChatUser.fromJson.md) ([Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> json) _factory_ ## Properties -##### [firstName](../models_chats_chat_user/ChatUser/firstName.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [firstName](../models_chats_chat_user/ChatUser/firstName.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [id](../models_chats_chat_user/ChatUser/id.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [id](../models_chats_chat_user/ChatUser/id.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [image](../models_chats_chat_user/ChatUser/image.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [image](../models_chats_chat_user/ChatUser/image.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -88,16 +88,16 @@ _read-onlyinherited_ ## Methods -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toJson](../models_chats_chat_user/ChatUser/toJson.md)() [Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> +##### [toJson](../models_chats_chat_user/ChatUser/toJson.md)() [Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> @@ -106,12 +106,12 @@ _inherited_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -119,12 +119,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser/ChatUser.fromJson.md b/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser/ChatUser.fromJson.md index 4283c825f6e..b30e5a73341 100644 --- a/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser/ChatUser.fromJson.md +++ b/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser/ChatUser.fromJson.md @@ -9,7 +9,7 @@ -ChatUser.fromJson([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> json) +ChatUser.fromJson([Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> json) @@ -18,7 +18,7 @@ ChatUser.fromJson([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html ## Implementation ```dart -factory ChatUser.fromJson(Map json) => +factory ChatUser.fromJson(Map\ json) =\> _$ChatUserFromJson(json); ``` diff --git a/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser/ChatUser.md b/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser/ChatUser.md index 5b6db09b4ff..e70184a28ea 100644 --- a/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser/ChatUser.md +++ b/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser/ChatUser.md @@ -9,7 +9,7 @@ -ChatUser({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? firstName, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? id, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? image}) +ChatUser(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? firstName, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? id, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? image\}) @@ -18,7 +18,7 @@ ChatUser({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? ## Implementation ```dart -ChatUser({this.firstName, this.id, this.image}); +ChatUser(\{this.firstName, this.id, this.image\}); ``` diff --git a/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser/firstName.md b/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser/firstName.md index 0fbc847279c..8f91ac32586 100644 --- a/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser/firstName.md +++ b/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser/firstName.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? firstName +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? firstName -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser/id.md b/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser/id.md index 833ed271b41..4d29a2dd9d4 100644 --- a/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser/id.md +++ b/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser/id.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? id +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? id -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser/image.md b/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser/image.md index db1007542ee..0c3ae6314ed 100644 --- a/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser/image.md +++ b/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser/image.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? image +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? image -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser/toJson.md b/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser/toJson.md index 8c0124f88f4..744561e28ee 100644 --- a/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser/toJson.md +++ b/docs/talawa-mobile-docs/models_chats_chat_user/ChatUser/toJson.md @@ -10,7 +10,7 @@ -[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> toJson +[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> toJson () @@ -23,7 +23,7 @@ ## Implementation ```dart -Map toJson() => _$ChatUserToJson(this); +Map\ toJson() =\> _$ChatUserToJson(this); ``` diff --git a/docs/talawa-mobile-docs/models_comment_comment_model/Comment-class.md b/docs/talawa-mobile-docs/models_comment_comment_model/Comment-class.md index e00460d307f..6d167e9672b 100644 --- a/docs/talawa-mobile-docs/models_comment_comment_model/Comment-class.md +++ b/docs/talawa-mobile-docs/models_comment_comment_model/Comment-class.md @@ -11,30 +11,30 @@ -

This class returns a Comment instance.

+\This class returns a Comment instance.\ ## Constructors -[Comment](../models_comment_comment_model/Comment/Comment.md) ({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? text, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? createdAt, [User](../models_user_user_info/User-class.md)? creator, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? post, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? likeCount}) +[Comment](../models_comment_comment_model/Comment/Comment.md) (\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? text, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? createdAt, [User](../models_user_user_info/User-class.md)? creator, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? post, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? likeCount\}) -[Comment.fromJson](../models_comment_comment_model/Comment/Comment.fromJson.md) ([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> json) +[Comment.fromJson](../models_comment_comment_model/Comment/Comment.fromJson.md) ([Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> json) _factory_ ## Properties -##### [createdAt](../models_comment_comment_model/Comment/createdAt.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [createdAt](../models_comment_comment_model/Comment/createdAt.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ @@ -43,52 +43,52 @@ _read / write_ -_read / write_ +_\read / write\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [likeCount](../models_comment_comment_model/Comment/likeCount.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [likeCount](../models_comment_comment_model/Comment/likeCount.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [post](../models_comment_comment_model/Comment/post.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [post](../models_comment_comment_model/Comment/post.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [text](../models_comment_comment_model/Comment/text.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [text](../models_comment_comment_model/Comment/text.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ @@ -96,21 +96,21 @@ _read / write_ ## Methods -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -118,12 +118,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/models_comment_comment_model/Comment/Comment.fromJson.md b/docs/talawa-mobile-docs/models_comment_comment_model/Comment/Comment.fromJson.md index 15a90217083..f5481d08c25 100644 --- a/docs/talawa-mobile-docs/models_comment_comment_model/Comment/Comment.fromJson.md +++ b/docs/talawa-mobile-docs/models_comment_comment_model/Comment/Comment.fromJson.md @@ -9,7 +9,7 @@ -Comment.fromJson([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> json) +Comment.fromJson([Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> json) @@ -18,21 +18,21 @@ Comment.fromJson([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html) ## Implementation ```dart -factory Comment.fromJson(Map json) { +factory Comment.fromJson(Map\ json) \{ return Comment( text: json['text'] as String?, createdAt: json['createdAt'] as String?, creator: json['creator'] == null ? null - //Creating a new User instance from a map structure. + Creating a new User instance from a map structure. : User.fromJson( - json['creator'] as Map, + json['creator'] as Map\, fromOrg: true, ), post: json['post'] as String?, likeCount: json['likeCount'] as String?, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/models_comment_comment_model/Comment/Comment.md b/docs/talawa-mobile-docs/models_comment_comment_model/Comment/Comment.md index 120962bcc88..85bcf99ca37 100644 --- a/docs/talawa-mobile-docs/models_comment_comment_model/Comment/Comment.md +++ b/docs/talawa-mobile-docs/models_comment_comment_model/Comment/Comment.md @@ -9,7 +9,7 @@ -Comment({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? text, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? createdAt, [User](../../models_user_user_info/User-class.md)? creator, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? post, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? likeCount}) +Comment(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? text, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? createdAt, [User](../../models_user_user_info/User-class.md)? creator, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? post, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? likeCount\}) @@ -18,7 +18,7 @@ Comment({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? ## Implementation ```dart -Comment({this.text, this.createdAt, this.creator, this.post, this.likeCount}); +Comment(\{this.text, this.createdAt, this.creator, this.post, this.likeCount\}); ``` diff --git a/docs/talawa-mobile-docs/models_comment_comment_model/Comment/createdAt.md b/docs/talawa-mobile-docs/models_comment_comment_model/Comment/createdAt.md index 6f4a3a12ef8..323b3dad79f 100644 --- a/docs/talawa-mobile-docs/models_comment_comment_model/Comment/createdAt.md +++ b/docs/talawa-mobile-docs/models_comment_comment_model/Comment/createdAt.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? createdAt +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? createdAt -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_comment_comment_model/Comment/creator.md b/docs/talawa-mobile-docs/models_comment_comment_model/Comment/creator.md index 8dcdc334b5b..e087168fe22 100644 --- a/docs/talawa-mobile-docs/models_comment_comment_model/Comment/creator.md +++ b/docs/talawa-mobile-docs/models_comment_comment_model/Comment/creator.md @@ -11,7 +11,7 @@ [User](../../models_user_user_info/User-class.md)? creator -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_comment_comment_model/Comment/likeCount.md b/docs/talawa-mobile-docs/models_comment_comment_model/Comment/likeCount.md index d4ba33db567..1f24de05bfa 100644 --- a/docs/talawa-mobile-docs/models_comment_comment_model/Comment/likeCount.md +++ b/docs/talawa-mobile-docs/models_comment_comment_model/Comment/likeCount.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? likeCount +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? likeCount -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_comment_comment_model/Comment/post.md b/docs/talawa-mobile-docs/models_comment_comment_model/Comment/post.md index 60ba62c8067..7e8f5a9957b 100644 --- a/docs/talawa-mobile-docs/models_comment_comment_model/Comment/post.md +++ b/docs/talawa-mobile-docs/models_comment_comment_model/Comment/post.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? post +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? post -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_comment_comment_model/Comment/text.md b/docs/talawa-mobile-docs/models_comment_comment_model/Comment/text.md index 3e3c81333af..835dc9336b4 100644 --- a/docs/talawa-mobile-docs/models_comment_comment_model/Comment/text.md +++ b/docs/talawa-mobile-docs/models_comment_comment_model/Comment/text.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? text +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? text -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_events_event_model/Event-class.md b/docs/talawa-mobile-docs/models_events_event_model/Event-class.md index 0ab22c2ff64..ef4a61bfb75 100644 --- a/docs/talawa-mobile-docs/models_events_event_model/Event-class.md +++ b/docs/talawa-mobile-docs/models_events_event_model/Event-class.md @@ -11,48 +11,48 @@ -

This class creates an event model and returns an Event instance.

+\This class creates an event model and returns an Event instance.\ ## Constructors -[Event](../models_events_event_model/Event/Event.md) ({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? id, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? title, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? description, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? attendees, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? location, [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? latitude, [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? longitude, [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? recurring, [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? allDay, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? startDate, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? endDate, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? startTime, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? endTime, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? recurrence, [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? isPublic, [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? isRegistered, [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? isRegisterable, [User](../models_user_user_info/User-class.md)? creator, [OrgInfo](../models_organization_org_info/OrgInfo-class.md)? organization, [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)>? admins, [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)>? registrants}) +[Event](../models_events_event_model/Event/Event.md) (\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? id, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? title, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? description, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? attendees, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? location, [double](https:api.flutter.dev/flutter/dart-core/double-class.html)? latitude, [double](https:api.flutter.dev/flutter/dart-core/double-class.html)? longitude, [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? recurring, [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? allDay, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? startDate, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? endDate, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? startTime, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? endTime, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? recurrence, [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? isPublic, [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? isRegistered, [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? isRegisterable, [User](../models_user_user_info/User-class.md)? creator, [OrgInfo](../models_organization_org_info/OrgInfo-class.md)? organization, [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)\>? admins, [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)\>? registrants\}) -[Event.fromJson](../models_events_event_model/Event/Event.fromJson.md) ([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> json) +[Event.fromJson](../models_events_event_model/Event/Event.fromJson.md) ([Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> json) _factory_ ## Properties -##### [admins](../models_events_event_model/Event/admins.md) ↔ [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)>? +##### [admins](../models_events_event_model/Event/admins.md) ↔ [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)\>? -_read / write_ +_\read / write\_ -##### [allDay](../models_events_event_model/Event/allDay.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? +##### [allDay](../models_events_event_model/Event/allDay.md) ↔ [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? -_read / write_ +_\read / write\_ -##### [attendees](../models_events_event_model/Event/attendees.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [attendees](../models_events_event_model/Event/attendees.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ @@ -61,106 +61,106 @@ _read / write_ -_read / write_ +_\read / write\_ -##### [description](../models_events_event_model/Event/description.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [description](../models_events_event_model/Event/description.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [endDate](../models_events_event_model/Event/endDate.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [endDate](../models_events_event_model/Event/endDate.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [endTime](../models_events_event_model/Event/endTime.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [endTime](../models_events_event_model/Event/endTime.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [id](../models_events_event_model/Event/id.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [id](../models_events_event_model/Event/id.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [isPublic](../models_events_event_model/Event/isPublic.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? +##### [isPublic](../models_events_event_model/Event/isPublic.md) ↔ [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? -_read / write_ +_\read / write\_ -##### [isRegisterable](../models_events_event_model/Event/isRegisterable.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? +##### [isRegisterable](../models_events_event_model/Event/isRegisterable.md) ↔ [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? -_read / write_ +_\read / write\_ -##### [isRegistered](../models_events_event_model/Event/isRegistered.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? +##### [isRegistered](../models_events_event_model/Event/isRegistered.md) ↔ [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? -_read / write_ +_\read / write\_ -##### [latitude](../models_events_event_model/Event/latitude.md) ↔ [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? +##### [latitude](../models_events_event_model/Event/latitude.md) ↔ [double](https:api.flutter.dev/flutter/dart-core/double-class.html)? -_read / write_ +_\read / write\_ -##### [location](../models_events_event_model/Event/location.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [location](../models_events_event_model/Event/location.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [longitude](../models_events_event_model/Event/longitude.md) ↔ [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? +##### [longitude](../models_events_event_model/Event/longitude.md) ↔ [double](https:api.flutter.dev/flutter/dart-core/double-class.html)? -_read / write_ +_\read / write\_ @@ -169,70 +169,70 @@ _read / write_ -_read / write_ +_\read / write\_ -##### [recurrence](../models_events_event_model/Event/recurrence.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [recurrence](../models_events_event_model/Event/recurrence.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [recurring](../models_events_event_model/Event/recurring.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? +##### [recurring](../models_events_event_model/Event/recurring.md) ↔ [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? -_read / write_ +_\read / write\_ -##### [registrants](../models_events_event_model/Event/registrants.md) ↔ [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)>? +##### [registrants](../models_events_event_model/Event/registrants.md) ↔ [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)\>? -_read / write_ +_\read / write\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [startDate](../models_events_event_model/Event/startDate.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [startDate](../models_events_event_model/Event/startDate.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [startTime](../models_events_event_model/Event/startTime.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [startTime](../models_events_event_model/Event/startTime.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [title](../models_events_event_model/Event/title.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [title](../models_events_event_model/Event/title.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ @@ -240,21 +240,21 @@ _read / write_ ## Methods -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -262,12 +262,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/models_events_event_model/Event/Event.fromJson.md b/docs/talawa-mobile-docs/models_events_event_model/Event/Event.fromJson.md index 9a7ea61a0cf..2e3feb494fc 100644 --- a/docs/talawa-mobile-docs/models_events_event_model/Event/Event.fromJson.md +++ b/docs/talawa-mobile-docs/models_events_event_model/Event/Event.fromJson.md @@ -9,7 +9,7 @@ -Event.fromJson([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> json) +Event.fromJson([Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> json) @@ -19,8 +19,8 @@ Event.fromJson([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)&l ```dart factory Event.fromJson( - Map json, -) { + Map\ json, +) \{ return Event( id: json['_id'] as String, title: json['title'] as String?, @@ -41,27 +41,27 @@ factory Event.fromJson( isRegisterable: json['isRegisterable'] as bool?, creator: json['creator'] == null ? null - //Creating a new User instance from a map structure. + Creating a new User instance from a map structure. : User.fromJson( - json['creator'] as Map, + json['creator'] as Map\, fromOrg: true, ), organization: json['organization'] == null ? null - //Creating a new OrgInfo instance from a map structure. - : OrgInfo.fromJson(json['organization'] as Map), + Creating a new OrgInfo instance from a map structure. + : OrgInfo.fromJson(json['organization'] as Map\), admins: json['admins'] == null ? null - : (json['admins'] as List?) + : (json['admins'] as List\?) ?.map( - (e) => User.fromJson(e as Map, fromOrg: true), + (e) =\> User.fromJson(e as Map\, fromOrg: true), ) .toList(), - registrants: (json['registrants'] as List?) - ?.map((e) => User.fromJson(e as Map, fromOrg: false)) + registrants: (json['registrants'] as List\?) + ?.map((e) =\> User.fromJson(e as Map\, fromOrg: false)) .toList(), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/models_events_event_model/Event/Event.md b/docs/talawa-mobile-docs/models_events_event_model/Event/Event.md index 399d73b8993..1ed095510b9 100644 --- a/docs/talawa-mobile-docs/models_events_event_model/Event/Event.md +++ b/docs/talawa-mobile-docs/models_events_event_model/Event/Event.md @@ -9,7 +9,7 @@ -Event({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? id, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? title, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? description, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? attendees, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? location, [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? latitude, [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? longitude, [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? recurring, [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? allDay, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? startDate, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? endDate, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? startTime, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? endTime, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? recurrence, [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? isPublic, [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? isRegistered, [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? isRegisterable, [User](../../models_user_user_info/User-class.md)? creator, [OrgInfo](../../models_organization_org_info/OrgInfo-class.md)? organization, [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)>? admins, [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)>? registrants}) +Event(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? id, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? title, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? description, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? attendees, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? location, [double](https:api.flutter.dev/flutter/dart-core/double-class.html)? latitude, [double](https:api.flutter.dev/flutter/dart-core/double-class.html)? longitude, [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? recurring, [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? allDay, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? startDate, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? endDate, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? startTime, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? endTime, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? recurrence, [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? isPublic, [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? isRegistered, [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? isRegisterable, [User](../../models_user_user_info/User-class.md)? creator, [OrgInfo](../../models_organization_org_info/OrgInfo-class.md)? organization, [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)\>? admins, [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)\>? registrants\}) @@ -18,7 +18,7 @@ Event({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? id ## Implementation ```dart -Event({ +Event(\{ this.id, this.title, this.description, @@ -40,7 +40,7 @@ Event({ this.organization, this.admins, this.registrants, -}); +\}); ``` diff --git a/docs/talawa-mobile-docs/models_events_event_model/Event/admins.md b/docs/talawa-mobile-docs/models_events_event_model/Event/admins.md index d97a3be09ab..34ba0fb4aa2 100644 --- a/docs/talawa-mobile-docs/models_events_event_model/Event/admins.md +++ b/docs/talawa-mobile-docs/models_events_event_model/Event/admins.md @@ -9,9 +9,9 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)>? admins +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)\>? admins -_read / write_ +_\read / write\_ @@ -21,7 +21,7 @@ _read / write_ ## Implementation ```dart -List? admins; +List\? admins; ``` diff --git a/docs/talawa-mobile-docs/models_events_event_model/Event/allDay.md b/docs/talawa-mobile-docs/models_events_event_model/Event/allDay.md index 630774560d6..f3ba5f18d5d 100644 --- a/docs/talawa-mobile-docs/models_events_event_model/Event/allDay.md +++ b/docs/talawa-mobile-docs/models_events_event_model/Event/allDay.md @@ -9,9 +9,9 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? allDay +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? allDay -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_events_event_model/Event/attendees.md b/docs/talawa-mobile-docs/models_events_event_model/Event/attendees.md index 203b6c667c0..a10a6e03838 100644 --- a/docs/talawa-mobile-docs/models_events_event_model/Event/attendees.md +++ b/docs/talawa-mobile-docs/models_events_event_model/Event/attendees.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? attendees +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? attendees -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_events_event_model/Event/creator.md b/docs/talawa-mobile-docs/models_events_event_model/Event/creator.md index 8dcdc334b5b..e087168fe22 100644 --- a/docs/talawa-mobile-docs/models_events_event_model/Event/creator.md +++ b/docs/talawa-mobile-docs/models_events_event_model/Event/creator.md @@ -11,7 +11,7 @@ [User](../../models_user_user_info/User-class.md)? creator -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_events_event_model/Event/description.md b/docs/talawa-mobile-docs/models_events_event_model/Event/description.md index 274483eb8f4..b4d7649272c 100644 --- a/docs/talawa-mobile-docs/models_events_event_model/Event/description.md +++ b/docs/talawa-mobile-docs/models_events_event_model/Event/description.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? description +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? description -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_events_event_model/Event/endDate.md b/docs/talawa-mobile-docs/models_events_event_model/Event/endDate.md index 71cdad30e2a..14a4ee15181 100644 --- a/docs/talawa-mobile-docs/models_events_event_model/Event/endDate.md +++ b/docs/talawa-mobile-docs/models_events_event_model/Event/endDate.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? endDate +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? endDate -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_events_event_model/Event/endTime.md b/docs/talawa-mobile-docs/models_events_event_model/Event/endTime.md index b494d8a6128..00befe1687b 100644 --- a/docs/talawa-mobile-docs/models_events_event_model/Event/endTime.md +++ b/docs/talawa-mobile-docs/models_events_event_model/Event/endTime.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? endTime +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? endTime -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_events_event_model/Event/id.md b/docs/talawa-mobile-docs/models_events_event_model/Event/id.md index 833ed271b41..4d29a2dd9d4 100644 --- a/docs/talawa-mobile-docs/models_events_event_model/Event/id.md +++ b/docs/talawa-mobile-docs/models_events_event_model/Event/id.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? id +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? id -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_events_event_model/Event/isPublic.md b/docs/talawa-mobile-docs/models_events_event_model/Event/isPublic.md index 115e149ff61..6bd90119393 100644 --- a/docs/talawa-mobile-docs/models_events_event_model/Event/isPublic.md +++ b/docs/talawa-mobile-docs/models_events_event_model/Event/isPublic.md @@ -9,9 +9,9 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? isPublic +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? isPublic -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_events_event_model/Event/isRegisterable.md b/docs/talawa-mobile-docs/models_events_event_model/Event/isRegisterable.md index 80a87ac5df0..9ea4c3acbf6 100644 --- a/docs/talawa-mobile-docs/models_events_event_model/Event/isRegisterable.md +++ b/docs/talawa-mobile-docs/models_events_event_model/Event/isRegisterable.md @@ -9,9 +9,9 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? isRegisterable +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? isRegisterable -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_events_event_model/Event/isRegistered.md b/docs/talawa-mobile-docs/models_events_event_model/Event/isRegistered.md index 0b7abce174f..7df259aac3f 100644 --- a/docs/talawa-mobile-docs/models_events_event_model/Event/isRegistered.md +++ b/docs/talawa-mobile-docs/models_events_event_model/Event/isRegistered.md @@ -9,9 +9,9 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? isRegistered +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? isRegistered -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_events_event_model/Event/latitude.md b/docs/talawa-mobile-docs/models_events_event_model/Event/latitude.md index 0f6aa819fa8..dfcd74b7c4c 100644 --- a/docs/talawa-mobile-docs/models_events_event_model/Event/latitude.md +++ b/docs/talawa-mobile-docs/models_events_event_model/Event/latitude.md @@ -9,9 +9,9 @@ -[double](https://api.flutter.dev/flutter/dart-core/double-class.html)? latitude +[double](https:api.flutter.dev/flutter/dart-core/double-class.html)? latitude -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_events_event_model/Event/location.md b/docs/talawa-mobile-docs/models_events_event_model/Event/location.md index d2fde269069..66c1530d719 100644 --- a/docs/talawa-mobile-docs/models_events_event_model/Event/location.md +++ b/docs/talawa-mobile-docs/models_events_event_model/Event/location.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? location +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? location -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_events_event_model/Event/longitude.md b/docs/talawa-mobile-docs/models_events_event_model/Event/longitude.md index 0b3b0066085..31a50807039 100644 --- a/docs/talawa-mobile-docs/models_events_event_model/Event/longitude.md +++ b/docs/talawa-mobile-docs/models_events_event_model/Event/longitude.md @@ -9,9 +9,9 @@ -[double](https://api.flutter.dev/flutter/dart-core/double-class.html)? longitude +[double](https:api.flutter.dev/flutter/dart-core/double-class.html)? longitude -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_events_event_model/Event/organization.md b/docs/talawa-mobile-docs/models_events_event_model/Event/organization.md index 8138745eccd..636507b4286 100644 --- a/docs/talawa-mobile-docs/models_events_event_model/Event/organization.md +++ b/docs/talawa-mobile-docs/models_events_event_model/Event/organization.md @@ -11,7 +11,7 @@ [OrgInfo](../../models_organization_org_info/OrgInfo-class.md)? organization -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_events_event_model/Event/recurrence.md b/docs/talawa-mobile-docs/models_events_event_model/Event/recurrence.md index 95763e6de59..81996a4adcc 100644 --- a/docs/talawa-mobile-docs/models_events_event_model/Event/recurrence.md +++ b/docs/talawa-mobile-docs/models_events_event_model/Event/recurrence.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? recurrence +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? recurrence -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_events_event_model/Event/recurring.md b/docs/talawa-mobile-docs/models_events_event_model/Event/recurring.md index b9223bf40e9..9ca14ab8396 100644 --- a/docs/talawa-mobile-docs/models_events_event_model/Event/recurring.md +++ b/docs/talawa-mobile-docs/models_events_event_model/Event/recurring.md @@ -9,9 +9,9 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? recurring +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? recurring -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_events_event_model/Event/registrants.md b/docs/talawa-mobile-docs/models_events_event_model/Event/registrants.md index 77c0d2342c7..dc54aaf2249 100644 --- a/docs/talawa-mobile-docs/models_events_event_model/Event/registrants.md +++ b/docs/talawa-mobile-docs/models_events_event_model/Event/registrants.md @@ -9,9 +9,9 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)>? registrants +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)\>? registrants -_read / write_ +_\read / write\_ @@ -21,7 +21,7 @@ _read / write_ ## Implementation ```dart -List? registrants; +List\? registrants; ``` diff --git a/docs/talawa-mobile-docs/models_events_event_model/Event/startDate.md b/docs/talawa-mobile-docs/models_events_event_model/Event/startDate.md index a3a26836889..16c159494c8 100644 --- a/docs/talawa-mobile-docs/models_events_event_model/Event/startDate.md +++ b/docs/talawa-mobile-docs/models_events_event_model/Event/startDate.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? startDate +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? startDate -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_events_event_model/Event/startTime.md b/docs/talawa-mobile-docs/models_events_event_model/Event/startTime.md index 45d78625a0e..f5b4b64a8d0 100644 --- a/docs/talawa-mobile-docs/models_events_event_model/Event/startTime.md +++ b/docs/talawa-mobile-docs/models_events_event_model/Event/startTime.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? startTime +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? startTime -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_events_event_model/Event/title.md b/docs/talawa-mobile-docs/models_events_event_model/Event/title.md index 79dd02590fd..1377cde37a8 100644 --- a/docs/talawa-mobile-docs/models_events_event_model/Event/title.md +++ b/docs/talawa-mobile-docs/models_events_event_model/Event/title.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? title +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? title -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_language_language_model/Language-class.md b/docs/talawa-mobile-docs/models_language_language_model/Language-class.md index b17705b6bb7..42cbcdeba7a 100644 --- a/docs/talawa-mobile-docs/models_language_language_model/Language-class.md +++ b/docs/talawa-mobile-docs/models_language_language_model/Language-class.md @@ -11,71 +11,71 @@ -

This class creates an langauge model.

+\This class creates an langauge model.\ ## Constructors -[Language](../models_language_language_model/Language/Language.md) ({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) countryCode, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) langCode, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) langName, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) langSample}) +[Language](../models_language_language_model/Language/Language.md) (\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) countryCode, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) langCode, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) langName, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) langSample\}) ## Properties -##### [countryCode](../models_language_language_model/Language/countryCode.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [countryCode](../models_language_language_model/Language/countryCode.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [langCode](../models_language_language_model/Language/langCode.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [langCode](../models_language_language_model/Language/langCode.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_final_ +_\final\_ -##### [langName](../models_language_language_model/Language/langName.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [langName](../models_language_language_model/Language/langName.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_final_ +_\final\_ -##### [langSample](../models_language_language_model/Language/langSample.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [langSample](../models_language_language_model/Language/langSample.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -83,21 +83,21 @@ _read-onlyinherited_ ## Methods -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -105,12 +105,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/models_language_language_model/Language/Language.md b/docs/talawa-mobile-docs/models_language_language_model/Language/Language.md index 04c52d10b25..065cd00e647 100644 --- a/docs/talawa-mobile-docs/models_language_language_model/Language/Language.md +++ b/docs/talawa-mobile-docs/models_language_language_model/Language/Language.md @@ -9,7 +9,7 @@ -Language({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) countryCode, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) langCode, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) langName, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) langSample}) +Language(\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) countryCode, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) langCode, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) langName, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) langSample\}) @@ -18,12 +18,12 @@ Language({required [String](https://api.flutter.dev/flutter/dart-core/String-cla ## Implementation ```dart -Language({ +Language(\{ required this.countryCode, required this.langCode, required this.langName, required this.langSample, -}); +\}); ``` diff --git a/docs/talawa-mobile-docs/models_language_language_model/Language/countryCode.md b/docs/talawa-mobile-docs/models_language_language_model/Language/countryCode.md index c832d751b50..f98d372ac8f 100644 --- a/docs/talawa-mobile-docs/models_language_language_model/Language/countryCode.md +++ b/docs/talawa-mobile-docs/models_language_language_model/Language/countryCode.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) countryCode +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) countryCode -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/models_language_language_model/Language/langCode.md b/docs/talawa-mobile-docs/models_language_language_model/Language/langCode.md index e6ca157cff0..058b95ae530 100644 --- a/docs/talawa-mobile-docs/models_language_language_model/Language/langCode.md +++ b/docs/talawa-mobile-docs/models_language_language_model/Language/langCode.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) langCode +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) langCode -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/models_language_language_model/Language/langName.md b/docs/talawa-mobile-docs/models_language_language_model/Language/langName.md index 95636992c94..7079725fce8 100644 --- a/docs/talawa-mobile-docs/models_language_language_model/Language/langName.md +++ b/docs/talawa-mobile-docs/models_language_language_model/Language/langName.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) langName +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) langName -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/models_language_language_model/Language/langSample.md b/docs/talawa-mobile-docs/models_language_language_model/Language/langSample.md index 0dbe17a121b..c6e2c67b28a 100644 --- a/docs/talawa-mobile-docs/models_language_language_model/Language/langSample.md +++ b/docs/talawa-mobile-docs/models_language_language_model/Language/langSample.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) langSample +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) langSample -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs-class.md b/docs/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs-class.md index f6a0d3d7423..b9450e91249 100644 --- a/docs/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs-class.md +++ b/docs/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs-class.md @@ -17,46 +17,46 @@ ## Constructors -[MainScreenArgs](../models_mainscreen_navigation_args/MainScreenArgs/MainScreenArgs.md) ({[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) fromSignUp = false, required [int](https://api.flutter.dev/flutter/dart-core/int-class.html) mainScreenIndex}) +[MainScreenArgs](../models_mainscreen_navigation_args/MainScreenArgs/MainScreenArgs.md) (\{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) fromSignUp = false, required [int](https:api.flutter.dev/flutter/dart-core/int-class.html) mainScreenIndex\}) ## Properties -##### [fromSignUp](../models_mainscreen_navigation_args/MainScreenArgs/fromSignUp.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [fromSignUp](../models_mainscreen_navigation_args/MainScreenArgs/fromSignUp.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [mainScreenIndex](../models_mainscreen_navigation_args/MainScreenArgs/mainScreenIndex.md) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [mainScreenIndex](../models_mainscreen_navigation_args/MainScreenArgs/mainScreenIndex.md) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -64,21 +64,21 @@ _read-onlyinherited_ ## Methods -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -86,12 +86,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs/MainScreenArgs.md b/docs/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs/MainScreenArgs.md index 7e83ed6f2f5..e768b4284c8 100644 --- a/docs/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs/MainScreenArgs.md +++ b/docs/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs/MainScreenArgs.md @@ -9,7 +9,7 @@ -MainScreenArgs({[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) fromSignUp = false, required [int](https://api.flutter.dev/flutter/dart-core/int-class.html) mainScreenIndex}) +MainScreenArgs(\{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) fromSignUp = false, required [int](https:api.flutter.dev/flutter/dart-core/int-class.html) mainScreenIndex\}) @@ -18,7 +18,7 @@ MainScreenArgs({[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html ## Implementation ```dart -MainScreenArgs({this.fromSignUp = false, required this.mainScreenIndex}); +MainScreenArgs(\{this.fromSignUp = false, required this.mainScreenIndex\}); ``` diff --git a/docs/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs/fromSignUp.md b/docs/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs/fromSignUp.md index 65dbae94ca7..711947f96c7 100644 --- a/docs/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs/fromSignUp.md +++ b/docs/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs/fromSignUp.md @@ -9,9 +9,9 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) fromSignUp +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) fromSignUp -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs/mainScreenIndex.md b/docs/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs/mainScreenIndex.md index 570058a349c..e3fa1182d9e 100644 --- a/docs/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs/mainScreenIndex.md +++ b/docs/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs/mainScreenIndex.md @@ -9,9 +9,9 @@ -[int](https://api.flutter.dev/flutter/dart-core/int-class.html) mainScreenIndex +[int](https:api.flutter.dev/flutter/dart-core/int-class.html) mainScreenIndex -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/models_options_options/Options-class.md b/docs/talawa-mobile-docs/models_options_options/Options-class.md index f5c9eabca0e..0dfc32a8f9b 100644 --- a/docs/talawa-mobile-docs/models_options_options/Options-class.md +++ b/docs/talawa-mobile-docs/models_options_options/Options-class.md @@ -11,71 +11,71 @@ -

This class creates a Option model.

+\This class creates a Option model.\ ## Constructors -[Options](../models_options_options/Options/Options.md) ({required [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) icon, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) title, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) subtitle, [IconButton](https://api.flutter.dev/flutter/material/IconButton-class.html)? trailingIconButton}) +[Options](../models_options_options/Options/Options.md) (\{required [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) icon, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) title, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) subtitle, [IconButton](https:api.flutter.dev/flutter/material/IconButton-class.html)? trailingIconButton\}) ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [icon](../models_options_options/Options/icon.md) ↔ [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [icon](../models_options_options/Options/icon.md) ↔ [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) -_read / write_ +_\read / write\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [subtitle](../models_options_options/Options/subtitle.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [subtitle](../models_options_options/Options/subtitle.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_read / write_ +_\read / write\_ -##### [title](../models_options_options/Options/title.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [title](../models_options_options/Options/title.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_read / write_ +_\read / write\_ -##### [trailingIconButton](../models_options_options/Options/trailingIconButton.md) ↔ [IconButton](https://api.flutter.dev/flutter/material/IconButton-class.html)? +##### [trailingIconButton](../models_options_options/Options/trailingIconButton.md) ↔ [IconButton](https:api.flutter.dev/flutter/material/IconButton-class.html)? -_read / write_ +_\read / write\_ @@ -83,21 +83,21 @@ _read / write_ ## Methods -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -105,12 +105,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/models_options_options/Options/Options.md b/docs/talawa-mobile-docs/models_options_options/Options/Options.md index ec36ee551fa..49b8d52e03f 100644 --- a/docs/talawa-mobile-docs/models_options_options/Options/Options.md +++ b/docs/talawa-mobile-docs/models_options_options/Options/Options.md @@ -9,7 +9,7 @@ -Options({required [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) icon, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) title, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) subtitle, [IconButton](https://api.flutter.dev/flutter/material/IconButton-class.html)? trailingIconButton}) +Options(\{required [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) icon, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) title, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) subtitle, [IconButton](https:api.flutter.dev/flutter/material/IconButton-class.html)? trailingIconButton\}) @@ -18,12 +18,12 @@ Options({required [Widget](https://api.flutter.dev/flutter/widgets/Widget-class. ## Implementation ```dart -Options({ +Options(\{ required this.icon, required this.title, required this.subtitle, this.trailingIconButton, -}); +\}); ``` diff --git a/docs/talawa-mobile-docs/models_options_options/Options/icon.md b/docs/talawa-mobile-docs/models_options_options/Options/icon.md index 4e90354722b..882be559ef7 100644 --- a/docs/talawa-mobile-docs/models_options_options/Options/icon.md +++ b/docs/talawa-mobile-docs/models_options_options/Options/icon.md @@ -9,9 +9,9 @@ -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) icon +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) icon -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_options_options/Options/subtitle.md b/docs/talawa-mobile-docs/models_options_options/Options/subtitle.md index 49c653f7ef2..e9f8eb0b8d9 100644 --- a/docs/talawa-mobile-docs/models_options_options/Options/subtitle.md +++ b/docs/talawa-mobile-docs/models_options_options/Options/subtitle.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) subtitle +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) subtitle -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_options_options/Options/title.md b/docs/talawa-mobile-docs/models_options_options/Options/title.md index 7f3fec8c9e5..b25031d3616 100644 --- a/docs/talawa-mobile-docs/models_options_options/Options/title.md +++ b/docs/talawa-mobile-docs/models_options_options/Options/title.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) title +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) title -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_options_options/Options/trailingIconButton.md b/docs/talawa-mobile-docs/models_options_options/Options/trailingIconButton.md index d9b9f553f10..aa4342444a8 100644 --- a/docs/talawa-mobile-docs/models_options_options/Options/trailingIconButton.md +++ b/docs/talawa-mobile-docs/models_options_options/Options/trailingIconButton.md @@ -9,9 +9,9 @@ -[IconButton](https://api.flutter.dev/flutter/material/IconButton-class.html)? trailingIconButton +[IconButton](https:api.flutter.dev/flutter/material/IconButton-class.html)? trailingIconButton -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo-class.md b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo-class.md index 2be8742b9f3..70a97cbe04c 100644 --- a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo-class.md +++ b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo-class.md @@ -11,7 +11,7 @@ -

This class creates an organization-information model and returns an OrgInfo instance.

+\This class creates an organization-information model and returns an OrgInfo instance.\ @@ -23,28 +23,28 @@ **Annotations** -- @[HiveType](https://pub.dev/documentation/hive/2.2.3/hive/HiveType-class.html)(typeId: 2) +- @[HiveType](https:pub.dev/documentation/hive/2.2.3/hive/HiveType-class.html)(typeId: 2) ## Constructors -[OrgInfo](../models_organization_org_info/OrgInfo/OrgInfo.md) ({[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)>? admins, [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)>? members, [User](../models_user_user_info/User-class.md)? creatorInfo, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? description, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? id, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? image, [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? isPublic, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name}) +[OrgInfo](../models_organization_org_info/OrgInfo/OrgInfo.md) (\{[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)\>? admins, [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)\>? members, [User](../models_user_user_info/User-class.md)? creatorInfo, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? description, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? id, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? image, [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? isPublic, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name\}) -[OrgInfo.fromJson](../models_organization_org_info/OrgInfo/OrgInfo.fromJson.md) ([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> json1, {[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) memberRequest = false}) +[OrgInfo.fromJson](../models_organization_org_info/OrgInfo/OrgInfo.fromJson.md) ([Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> json1, \{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) memberRequest = false\}) _factory_ ## Properties -##### [admins](../models_organization_org_info/OrgInfo/admins.md) ↔ [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)>? +##### [admins](../models_organization_org_info/OrgInfo/admins.md) ↔ [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)\>? -_read / write_ +_\read / write\_ @@ -53,79 +53,79 @@ _read / write_ -_read / write_ +_\read / write\_ -##### [description](../models_organization_org_info/OrgInfo/description.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [description](../models_organization_org_info/OrgInfo/description.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [id](../models_organization_org_info/OrgInfo/id.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [id](../models_organization_org_info/OrgInfo/id.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [image](../models_organization_org_info/OrgInfo/image.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [image](../models_organization_org_info/OrgInfo/image.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [isPublic](../models_organization_org_info/OrgInfo/isPublic.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? +##### [isPublic](../models_organization_org_info/OrgInfo/isPublic.md) ↔ [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? -_read / write_ +_\read / write\_ -##### [members](../models_organization_org_info/OrgInfo/members.md) ↔ [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)>? +##### [members](../models_organization_org_info/OrgInfo/members.md) ↔ [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)\>? -_read / write_ +_\read / write\_ -##### [name](../models_organization_org_info/OrgInfo/name.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [name](../models_organization_org_info/OrgInfo/name.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -133,7 +133,7 @@ _read-onlyinherited_ ## Methods -##### [fromJsonToList](../models_organization_org_info/OrgInfo/fromJsonToList.md)([List](https://api.flutter.dev/flutter/dart-core/List-class.html) json) [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)> +##### [fromJsonToList](../models_organization_org_info/OrgInfo/fromJsonToList.md)([List](https:api.flutter.dev/flutter/dart-core/List-class.html) json) [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)\> @@ -142,21 +142,21 @@ _read-onlyinherited_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -164,12 +164,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/OrgInfo.fromJson.md b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/OrgInfo.fromJson.md index 45cbc5eaebe..ac3dd3cfc35 100644 --- a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/OrgInfo.fromJson.md +++ b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/OrgInfo.fromJson.md @@ -9,7 +9,7 @@ -OrgInfo.fromJson([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> json1, {[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) memberRequest = false}) +OrgInfo.fromJson([Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> json1, \{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) memberRequest = false\}) @@ -19,15 +19,15 @@ OrgInfo.fromJson([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html) ```dart factory OrgInfo.fromJson( - Map json1, { + Map\ json1, \{ bool memberRequest = false, -}) { - Map json; - if (memberRequest) { - json = json1['organization'] as Map; - } else { +\}) \{ + Map\ json; + if (memberRequest) \{ + json = json1['organization'] as Map\; + \} else \{ json = json1; - } + \} return OrgInfo( id: json['_id'] != null ? json['_id'] as String : null, image: json['image'] != null ? json['image'] as String? : null, @@ -37,26 +37,26 @@ factory OrgInfo.fromJson( isPublic: json['isPublic'] != null ? json['isPublic'] as bool? : null, creatorInfo: json['creator'] != null ? User.fromJson( - json['creator'] as Map, + json['creator'] as Map\, fromOrg: true, ) : null, members: json['members'] != null - ? (json['members'] as List?) + ? (json['members'] as List\?) ?.map( - (e) => User.fromJson(e as Map, fromOrg: true), + (e) =\> User.fromJson(e as Map\, fromOrg: true), ) .toList() : null, admins: json['admins'] != null - ? (json['admins'] as List?) + ? (json['admins'] as List\?) ?.map( - (e) => User.fromJson(e as Map, fromOrg: true), + (e) =\> User.fromJson(e as Map\, fromOrg: true), ) .toList() : null, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/OrgInfo.md b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/OrgInfo.md index ec3cdccb2ba..c9520921656 100644 --- a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/OrgInfo.md +++ b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/OrgInfo.md @@ -9,7 +9,7 @@ -OrgInfo({[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)>? admins, [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)>? members, [User](../../models_user_user_info/User-class.md)? creatorInfo, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? description, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? id, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? image, [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? isPublic, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name}) +OrgInfo(\{[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)\>? admins, [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)\>? members, [User](../../models_user_user_info/User-class.md)? creatorInfo, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? description, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? id, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? image, [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? isPublic, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name\}) @@ -18,7 +18,7 @@ OrgInfo({[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[U ## Implementation ```dart -OrgInfo({ +OrgInfo(\{ this.admins, this.members, this.creatorInfo, @@ -27,7 +27,7 @@ OrgInfo({ this.image, this.isPublic, this.name, -}); +\}); ``` diff --git a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/admins.md b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/admins.md index ed855ec72f7..c9d302883f1 100644 --- a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/admins.md +++ b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/admins.md @@ -11,10 +11,10 @@ **Annotations** -- @[HiveField](https://pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(3) -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)>? admins +- @[HiveField](https:pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(3) +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)\>? admins -_read / write_ +_\read / write\_ @@ -25,7 +25,7 @@ _read / write_ ```dart @HiveField(3) -List? admins; +List\? admins; ``` diff --git a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/creatorInfo.md b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/creatorInfo.md index 96f58903321..ab951acbafc 100644 --- a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/creatorInfo.md +++ b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/creatorInfo.md @@ -11,10 +11,10 @@ **Annotations** -- @[HiveField](https://pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(7) +- @[HiveField](https:pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(7) [User](../../models_user_user_info/User-class.md)? creatorInfo -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/description.md b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/description.md index 0dd524bef7e..c55a4257aba 100644 --- a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/description.md +++ b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/description.md @@ -11,10 +11,10 @@ **Annotations** -- @[HiveField](https://pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(5) -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? description +- @[HiveField](https:pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(5) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? description -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/fromJsonToList.md b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/fromJsonToList.md index f675364e67b..0452e4104c0 100644 --- a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/fromJsonToList.md +++ b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/fromJsonToList.md @@ -10,8 +10,8 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)> fromJsonToList -([List](https://api.flutter.dev/flutter/dart-core/List-class.html) json) +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)\> fromJsonToList +([List](https:api.flutter.dev/flutter/dart-core/List-class.html) json) @@ -23,14 +23,14 @@ ## Implementation ```dart -List fromJsonToList(List json) { - final List orgList = []; - json.forEach((element) { - final OrgInfo org = OrgInfo.fromJson(element as Map); +List\ fromJsonToList(List\ json) \{ + final List\ orgList = []; + json.forEach((element) \{ + final OrgInfo org = OrgInfo.fromJson(element as Map\); orgList.add(org); - }); + \}); return orgList; -} +\} ``` diff --git a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/id.md b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/id.md index 41593eb6c9f..3de227caee3 100644 --- a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/id.md +++ b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/id.md @@ -11,10 +11,10 @@ **Annotations** -- @[HiveField](https://pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(1) -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? id +- @[HiveField](https:pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(1) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? id -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/image.md b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/image.md index 307a6d89403..d425b6f5083 100644 --- a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/image.md +++ b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/image.md @@ -11,10 +11,10 @@ **Annotations** -- @[HiveField](https://pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(0) -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? image +- @[HiveField](https:pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(0) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? image -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/isPublic.md b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/isPublic.md index 2ab544f2ae5..78ec139ac8b 100644 --- a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/isPublic.md +++ b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/isPublic.md @@ -11,10 +11,10 @@ **Annotations** -- @[HiveField](https://pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(6) -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? isPublic +- @[HiveField](https:pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(6) +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? isPublic -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/members.md b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/members.md index 0613169d667..5691a63c4fd 100644 --- a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/members.md +++ b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/members.md @@ -11,10 +11,10 @@ **Annotations** -- @[HiveField](https://pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(4) -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)>? members +- @[HiveField](https:pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(4) +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)\>? members -_read / write_ +_\read / write\_ @@ -25,7 +25,7 @@ _read / write_ ```dart @HiveField(4) -List? members; +List\? members; ``` diff --git a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/name.md b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/name.md index e69ccaed407..9a45c6b7d97 100644 --- a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/name.md +++ b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfo/name.md @@ -11,10 +11,10 @@ **Annotations** -- @[HiveField](https://pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(2) -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name +- @[HiveField](https:pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(2) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter-class.md b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter-class.md index 15935102284..aaf4b49de3a 100644 --- a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter-class.md +++ b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter-class.md @@ -16,8 +16,8 @@ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [TypeAdapter](https://pub.dev/documentation/hive/2.2.3/hive/TypeAdapter-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)> +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [TypeAdapter](https:pub.dev/documentation/hive/2.2.3/hive/TypeAdapter-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)\> - OrgInfoAdapter @@ -36,30 +36,30 @@ ## Properties -##### [hashCode](../models_organization_org_info/OrgInfoAdapter/hashCode.md) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](../models_organization_org_info/OrgInfoAdapter/hashCode.md) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyoverride_ +_\read-only\\override\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [typeId](../models_organization_org_info/OrgInfoAdapter/typeId.md) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [typeId](../models_organization_org_info/OrgInfoAdapter/typeId.md) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) Called for type registration -_final_ +_\final\_ @@ -67,39 +67,39 @@ _final_ ## Methods -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [read](../models_organization_org_info/OrgInfoAdapter/read.md)([BinaryReader](https://pub.dev/documentation/hive/2.2.3/hive/BinaryReader-class.html) reader) [OrgInfo](../models_organization_org_info/OrgInfo-class.md) +##### [read](../models_organization_org_info/OrgInfoAdapter/read.md)([BinaryReader](https:pub.dev/documentation/hive/2.2.3/hive/BinaryReader-class.html) reader) [OrgInfo](../models_organization_org_info/OrgInfo-class.md) Is called when a value has to be decoded. -_override_ +_\override\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [write](../models_organization_org_info/OrgInfoAdapter/write.md)([BinaryWriter](https://pub.dev/documentation/hive/2.2.3/hive/BinaryWriter-class.html) writer, [OrgInfo](../models_organization_org_info/OrgInfo-class.md) obj) void +##### [write](../models_organization_org_info/OrgInfoAdapter/write.md)([BinaryWriter](https:pub.dev/documentation/hive/2.2.3/hive/BinaryWriter-class.html) writer, [OrgInfo](../models_organization_org_info/OrgInfo-class.md) obj) void Is called when a value has to be encoded. -_override_ +_\override\_ @@ -107,12 +107,12 @@ _override_ ## Operators -##### [operator ==](../models_organization_org_info/OrgInfoAdapter/operator_equals.md)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](../models_organization_org_info/OrgInfoAdapter/operator_equals.md)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_override_ +_\override\_ diff --git a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/hashCode.md b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/hashCode.md index 3f59c03a5c0..391acc7aba2 100644 --- a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/hashCode.md +++ b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/hashCode.md @@ -13,39 +13,39 @@ **Annotations** -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) -[int](https://api.flutter.dev/flutter/dart-core/int-class.html) hashCode +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) +[int](https:api.flutter.dev/flutter/dart-core/int-class.html) hashCode -_override_ +_\override\_ -

The hash code for this object.

-

A hash code is a single integer which represents the state of the object -that affects operator == comparisons.

-

All objects have hash codes. -The default hash code implemented by Object +\The hash code for this object.\ +\A hash code is a single integer which represents the state of the object +that affects \operator ==\ comparisons.\ +\All objects have hash codes. +The default hash code implemented by \Object\ represents only the identity of the object, -the same way as the default operator == implementation only considers objects -equal if they are identical (see identityHashCode).

-

If operator == is overridden to use the object state instead, +the same way as the default \operator ==\ implementation only considers objects +equal if they are identical (see \identityHashCode\).\ +\If \operator ==\ is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures -like the default Set and Map implementations.

-

Hash codes must be the same for objects that are equal to each other -according to operator ==. +like the default \Set\ and \Map\ implementations.\ +\Hash codes must be the same for objects that are equal to each other +according to \operator ==\. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program -and there are no distribution guarantees.

-

Objects that are not equal are allowed to have the same hash code. +and there are no distribution guarantees.\ +\Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures -like HashSet or HashMap.

-

If a subclass overrides hashCode, it should override the -operator == operator as well to maintain consistency.

+like \HashSet\ or \HashMap\.\ +\If a subclass overrides \hashCode\, it should override the +\operator ==\ operator as well to maintain consistency.\ @@ -53,7 +53,7 @@ like override_ +_\override\_ -

The equality operator.

-

The default behavior for all Objects is to return true if and -only if this object and other are the same object.

-

Override this method to specify a different equality relation on +\The equality operator.\ +\The default behavior for all \Object\s is to return true if and +only if this object and \other\ are the same object.\ +\Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. -That is, it must be:

-
    -
  • -

    Total: It must return a boolean for all arguments. It should never throw.

    -
  • -
  • -

    Reflexive: For all objects o, o == o must be true.

    -
  • -
  • -

    Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must -either both be true, or both be false.

    -
  • -
  • -

    Transitive: For all objects o1, o2, and o3, if o1 == o2 and -o2 == o3 are true, then o1 == o3 must be true.

    -
  • -
-

The method should also be consistent over time, +That is, it must be:\ +\ +\ +\Total: It must return a boolean for all arguments. It should never throw.\ +\ +\ +\Reflexive: For all objects \o\, \o == o\ must be true.\ +\ +\ +\Symmetric: For all objects \o1\ and \o2\, \o1 == o2\ and \o2 == o1\ must +either both be true, or both be false.\ +\ +\ +\Transitive: For all objects \o1\, \o2\, and \o3\, if \o1 == o2\ and +\o2 == o3\ are true, then \o1 == o3\ must be true.\ +\ +\ +\The method should also be consistent over time, so whether two objects are equal should only change -if at least one of the objects was modified.

-

If a subclass overrides the equality operator, it should override -the hashCode method as well to maintain consistency.

+if at least one of the objects was modified.\ +\If a subclass overrides the equality operator, it should override +the \hashCode\ method as well to maintain consistency.\ @@ -52,7 +52,7 @@ the hash ```dart @override -bool operator ==(Object other) => +bool operator ==(Object other) =\> identical(this, other) || other is OrgInfoAdapter && runtimeType == other.runtimeType && diff --git a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/read.md b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/read.md index 730b1101e20..5953e765e27 100644 --- a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/read.md +++ b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/read.md @@ -9,16 +9,16 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) [OrgInfo](../../models_organization_org_info/OrgInfo-class.md) read -([BinaryReader](https://pub.dev/documentation/hive/2.2.3/hive/BinaryReader-class.html) reader) +([BinaryReader](https:pub.dev/documentation/hive/2.2.3/hive/BinaryReader-class.html) reader) -_override_ +_\override\_ -

Is called when a value has to be decoded.

+\Is called when a value has to be decoded.\ @@ -26,14 +26,14 @@ _override_ ```dart @override -OrgInfo read(BinaryReader reader) { +OrgInfo read(BinaryReader reader) \{ final numOfFields = reader.readByte(); - final fields = { - for (int i = 0; i < numOfFields; i++) reader.readByte(): reader.read(), - }; + final fields = \\{ + for (int i = 0; i \< numOfFields; i++) reader.readByte(): reader.read(), + \}; return OrgInfo( - admins: (fields[3] as List?)?.cast(), - members: (fields[4] as List?)?.cast(), + admins: (fields[3] as List?)?.cast\(), + members: (fields[4] as List?)?.cast\(), creatorInfo: fields[7] as User?, description: fields[5] as String?, id: fields[1] as String?, @@ -41,7 +41,7 @@ OrgInfo read(BinaryReader reader) { isPublic: fields[6] as bool?, name: fields[2] as String?, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/typeId.md b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/typeId.md index 185e25a2c0a..0d815f1140a 100644 --- a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/typeId.md +++ b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/typeId.md @@ -11,14 +11,14 @@ **Annotations** -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) -[int](https://api.flutter.dev/flutter/dart-core/int-class.html) typeId +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) +[int](https:api.flutter.dev/flutter/dart-core/int-class.html) typeId -_final_ +_\final\_ -

Called for type registration

+\Called for type registration\ diff --git a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/write.md b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/write.md index 65e6d9ac020..1b08687beff 100644 --- a/docs/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/write.md +++ b/docs/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/write.md @@ -9,16 +9,16 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) void write -([BinaryWriter](https://pub.dev/documentation/hive/2.2.3/hive/BinaryWriter-class.html) writer, [OrgInfo](../../models_organization_org_info/OrgInfo-class.md) obj) +([BinaryWriter](https:pub.dev/documentation/hive/2.2.3/hive/BinaryWriter-class.html) writer, [OrgInfo](../../models_organization_org_info/OrgInfo-class.md) obj) -_override_ +_\override\_ -

Is called when a value has to be encoded.

+\Is called when a value has to be encoded.\ @@ -26,7 +26,7 @@ _override_ ```dart @override -void write(BinaryWriter writer, OrgInfo obj) { +void write(BinaryWriter writer, OrgInfo obj) \{ writer ..writeByte(8) ..writeByte(0) @@ -45,7 +45,7 @@ void write(BinaryWriter writer, OrgInfo obj) { ..write(obj.isPublic) ..writeByte(7) ..write(obj.creatorInfo); -} +\} ``` diff --git a/docs/talawa-mobile-docs/models_post_post_model/Comments-class.md b/docs/talawa-mobile-docs/models_post_post_model/Comments-class.md index d239109404f..c2f53da6f20 100644 --- a/docs/talawa-mobile-docs/models_post_post_model/Comments-class.md +++ b/docs/talawa-mobile-docs/models_post_post_model/Comments-class.md @@ -11,48 +11,48 @@ -

This class convert between json and object for comments.

+\This class convert between json and object for comments.\ ## Constructors -[Comments](../models_post_post_model/Comments/Comments.md) ({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? sId}) +[Comments](../models_post_post_model/Comments/Comments.md) (\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? sId\}) -[Comments.fromJson](../models_post_post_model/Comments/Comments.fromJson.md) ([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> json) +[Comments.fromJson](../models_post_post_model/Comments/Comments.fromJson.md) ([Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> json) Convert json to dart object. ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [sId](../models_post_post_model/Comments/sId.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [sId](../models_post_post_model/Comments/sId.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? these are dart object. -_read / write_ +_\read / write\_ @@ -60,16 +60,16 @@ _read / write_ ## Methods -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toJson](../models_post_post_model/Comments/toJson.md)() [Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> +##### [toJson](../models_post_post_model/Comments/toJson.md)() [Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> @@ -78,12 +78,12 @@ Convert dart object to json. -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -91,12 +91,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/models_post_post_model/Comments/Comments.fromJson.md b/docs/talawa-mobile-docs/models_post_post_model/Comments/Comments.fromJson.md index 7edc2829750..18e2fa1a09c 100644 --- a/docs/talawa-mobile-docs/models_post_post_model/Comments/Comments.fromJson.md +++ b/docs/talawa-mobile-docs/models_post_post_model/Comments/Comments.fromJson.md @@ -9,25 +9,25 @@ -Comments.fromJson([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> json) +Comments.fromJson([Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> json) -

Convert json to dart object.

-

params: +\Convert json to dart object.\ +\params: None -returns:

-
    -
  • Map<String, dynamic>: Dart object is returned.
  • -
+returns:\ +\ +\\Map<String, dynamic>\: Dart object is returned.\ +\ ## Implementation ```dart -Comments.fromJson(Map json) { +Comments.fromJson(Map\ json) \{ sId = json['_id'] as String?; -} +\} ``` diff --git a/docs/talawa-mobile-docs/models_post_post_model/Comments/Comments.md b/docs/talawa-mobile-docs/models_post_post_model/Comments/Comments.md index ea2aab3be71..b49932257a9 100644 --- a/docs/talawa-mobile-docs/models_post_post_model/Comments/Comments.md +++ b/docs/talawa-mobile-docs/models_post_post_model/Comments/Comments.md @@ -9,7 +9,7 @@ -Comments({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? sId}) +Comments(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? sId\}) @@ -18,7 +18,7 @@ Comments({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? ## Implementation ```dart -Comments({this.sId}); +Comments(\{this.sId\}); ``` diff --git a/docs/talawa-mobile-docs/models_post_post_model/Comments/sId.md b/docs/talawa-mobile-docs/models_post_post_model/Comments/sId.md index 398d78335e6..fd947656d90 100644 --- a/docs/talawa-mobile-docs/models_post_post_model/Comments/sId.md +++ b/docs/talawa-mobile-docs/models_post_post_model/Comments/sId.md @@ -9,17 +9,17 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? sId +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? sId -_read / write_ +_\read / write\_ -

these are dart object.

-

params:

-
    -
  • sId : unique identifier for post
  • -
+\these are dart object.\ +\params:\ +\ +\\sId\ : unique identifier for post\ +\ diff --git a/docs/talawa-mobile-docs/models_post_post_model/Comments/toJson.md b/docs/talawa-mobile-docs/models_post_post_model/Comments/toJson.md index 41171d83c70..d10e8c2df29 100644 --- a/docs/talawa-mobile-docs/models_post_post_model/Comments/toJson.md +++ b/docs/talawa-mobile-docs/models_post_post_model/Comments/toJson.md @@ -10,31 +10,31 @@ -[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> toJson +[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> toJson () -

Convert dart object to json.

-

params: - None

-

returns:

-
    -
  • Map<String, dynamic>: json is returned.
  • -
+\Convert dart object to json.\ +\\params\: + None\ +\\returns\:\ +\ +\\Map<String, dynamic>\: json is returned.\ +\ ## Implementation ```dart -Map toJson() { - final Map data = {}; +Map\ toJson() \{ + final Map\ data = \\{\}; data['_id'] = this.sId; return data; -} +\} ``` diff --git a/docs/talawa-mobile-docs/models_post_post_model/LikedBy-class.md b/docs/talawa-mobile-docs/models_post_post_model/LikedBy-class.md index 414225f5671..7436d2f9f6e 100644 --- a/docs/talawa-mobile-docs/models_post_post_model/LikedBy-class.md +++ b/docs/talawa-mobile-docs/models_post_post_model/LikedBy-class.md @@ -11,48 +11,48 @@ -

This class convert between json and object for likedby.

+\This class convert between json and object for likedby.\ ## Constructors -[LikedBy](../models_post_post_model/LikedBy/LikedBy.md) ({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? sId}) +[LikedBy](../models_post_post_model/LikedBy/LikedBy.md) (\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? sId\}) -[LikedBy.fromJson](../models_post_post_model/LikedBy/LikedBy.fromJson.md) ([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> json) +[LikedBy.fromJson](../models_post_post_model/LikedBy/LikedBy.fromJson.md) ([Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> json) JSON factory constructor. ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [sId](../models_post_post_model/LikedBy/sId.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [sId](../models_post_post_model/LikedBy/sId.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? These are dart object. -_read / write_ +_\read / write\_ @@ -60,16 +60,16 @@ _read / write_ ## Methods -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toJson](../models_post_post_model/LikedBy/toJson.md)() [Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> +##### [toJson](../models_post_post_model/LikedBy/toJson.md)() [Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> @@ -78,12 +78,12 @@ Convert dart object to json. -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -91,12 +91,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/models_post_post_model/LikedBy/LikedBy.fromJson.md b/docs/talawa-mobile-docs/models_post_post_model/LikedBy/LikedBy.fromJson.md index 16f42a9a4e1..3a25f127528 100644 --- a/docs/talawa-mobile-docs/models_post_post_model/LikedBy/LikedBy.fromJson.md +++ b/docs/talawa-mobile-docs/models_post_post_model/LikedBy/LikedBy.fromJson.md @@ -9,19 +9,19 @@ -LikedBy.fromJson([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> json) +LikedBy.fromJson([Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> json) -

JSON factory constructor.

+\JSON factory constructor.\ ## Implementation ```dart -LikedBy.fromJson(Map json) { +LikedBy.fromJson(Map\ json) \{ sId = json['_id'] as String?; -} +\} ``` diff --git a/docs/talawa-mobile-docs/models_post_post_model/LikedBy/LikedBy.md b/docs/talawa-mobile-docs/models_post_post_model/LikedBy/LikedBy.md index 81c5321ef0e..febe6355315 100644 --- a/docs/talawa-mobile-docs/models_post_post_model/LikedBy/LikedBy.md +++ b/docs/talawa-mobile-docs/models_post_post_model/LikedBy/LikedBy.md @@ -9,7 +9,7 @@ -LikedBy({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? sId}) +LikedBy(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? sId\}) @@ -18,7 +18,7 @@ LikedBy({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? ## Implementation ```dart -LikedBy({this.sId}); +LikedBy(\{this.sId\}); ``` diff --git a/docs/talawa-mobile-docs/models_post_post_model/LikedBy/sId.md b/docs/talawa-mobile-docs/models_post_post_model/LikedBy/sId.md index ecdee05914b..f8008b99836 100644 --- a/docs/talawa-mobile-docs/models_post_post_model/LikedBy/sId.md +++ b/docs/talawa-mobile-docs/models_post_post_model/LikedBy/sId.md @@ -9,17 +9,17 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? sId +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? sId -_read / write_ +_\read / write\_ -

These are dart object.

-

params:

-
    -
  • sId : unique identifier for post
  • -
+\These are dart object.\ +\params:\ +\ +\\sId\ : unique identifier for post\ +\ diff --git a/docs/talawa-mobile-docs/models_post_post_model/LikedBy/toJson.md b/docs/talawa-mobile-docs/models_post_post_model/LikedBy/toJson.md index 41171d83c70..d10e8c2df29 100644 --- a/docs/talawa-mobile-docs/models_post_post_model/LikedBy/toJson.md +++ b/docs/talawa-mobile-docs/models_post_post_model/LikedBy/toJson.md @@ -10,31 +10,31 @@ -[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> toJson +[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> toJson () -

Convert dart object to json.

-

params: - None

-

returns:

-
    -
  • Map<String, dynamic>: json is returned.
  • -
+\Convert dart object to json.\ +\\params\: + None\ +\\returns\:\ +\ +\\Map<String, dynamic>\: json is returned.\ +\ ## Implementation ```dart -Map toJson() { - final Map data = {}; +Map\ toJson() \{ + final Map\ data = \\{\}; data['_id'] = this.sId; return data; -} +\} ``` diff --git a/docs/talawa-mobile-docs/models_post_post_model/Post-class.md b/docs/talawa-mobile-docs/models_post_post_model/Post-class.md index aed8de17d3f..9046b7bf032 100644 --- a/docs/talawa-mobile-docs/models_post_post_model/Post-class.md +++ b/docs/talawa-mobile-docs/models_post_post_model/Post-class.md @@ -11,39 +11,39 @@ -

This class creates a Post model.

+\This class creates a Post model.\ ## Constructors -[Post](../models_post_post_model/Post/Post.md) ({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) sId, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? description, [DateTime](https://api.flutter.dev/flutter/dart-core/DateTime-class.html)? createdAt, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? imageUrl, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? videoUrl, required [User](../models_user_user_info/User-class.md)? creator, [OrgInfo](../models_organization_org_info/OrgInfo-class.md)? organization, [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[LikedBy](../models_post_post_model/LikedBy-class.md)>? likedBy, [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Comments](../models_post_post_model/Comments-class.md)>? comments}) +[Post](../models_post_post_model/Post/Post.md) (\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) sId, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? description, [DateTime](https:api.flutter.dev/flutter/dart-core/DateTime-class.html)? createdAt, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? imageUrl, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? videoUrl, required [User](../models_user_user_info/User-class.md)? creator, [OrgInfo](../models_organization_org_info/OrgInfo-class.md)? organization, [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[LikedBy](../models_post_post_model/LikedBy-class.md)\>? likedBy, [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Comments](../models_post_post_model/Comments-class.md)\>? comments\}) -[Post.fromJson](../models_post_post_model/Post/Post.fromJson.md) ([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> json) +[Post.fromJson](../models_post_post_model/Post/Post.fromJson.md) ([Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> json) Creating a new Post instance from a map structure. ## Properties -##### [comments](../models_post_post_model/Post/comments.md) ↔ [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Comments](../models_post_post_model/Comments-class.md)>? +##### [comments](../models_post_post_model/Post/comments.md) ↔ [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Comments](../models_post_post_model/Comments-class.md)\>? comments for post. -_read / write_ +_\read / write\_ -##### [createdAt](../models_post_post_model/Post/createdAt.md) ↔ [DateTime](https://api.flutter.dev/flutter/dart-core/DateTime-class.html)? +##### [createdAt](../models_post_post_model/Post/createdAt.md) ↔ [DateTime](https:api.flutter.dev/flutter/dart-core/DateTime-class.html)? createdAt for post. -_read / write_ +_\read / write\_ @@ -52,43 +52,43 @@ _read / write_ creator for post. -_read / write_ +_\read / write\_ -##### [description](../models_post_post_model/Post/description.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [description](../models_post_post_model/Post/description.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? description for post. -_read / write_ +_\read / write\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [imageUrl](../models_post_post_model/Post/imageUrl.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [imageUrl](../models_post_post_model/Post/imageUrl.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? imageUrl for post. -_read / write_ +_\read / write\_ -##### [likedBy](../models_post_post_model/Post/likedBy.md) ↔ [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[LikedBy](../models_post_post_model/LikedBy-class.md)>? +##### [likedBy](../models_post_post_model/Post/likedBy.md) ↔ [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[LikedBy](../models_post_post_model/LikedBy-class.md)\>? likedBy for post. -_read / write_ +_\read / write\_ @@ -97,34 +97,34 @@ _read / write_ organization for post. -_read / write_ +_\read / write\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [sId](../models_post_post_model/Post/sId.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [sId](../models_post_post_model/Post/sId.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html) unique identifier for post. -_read / write_ +_\read / write\_ -##### [videoUrl](../models_post_post_model/Post/videoUrl.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [videoUrl](../models_post_post_model/Post/videoUrl.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? videoUrl for post. -_read / write_ +_\read / write\_ @@ -132,7 +132,7 @@ _read / write_ ## Methods -##### [getPostCreatedDuration](../models_post_post_model/Post/getPostCreatedDuration.md)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [getPostCreatedDuration](../models_post_post_model/Post/getPostCreatedDuration.md)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -141,21 +141,21 @@ this is to get duration of post. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -163,12 +163,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/models_post_post_model/Post/Post.fromJson.md b/docs/talawa-mobile-docs/models_post_post_model/Post/Post.fromJson.md index 7dba822b4de..b14f1cf8c20 100644 --- a/docs/talawa-mobile-docs/models_post_post_model/Post/Post.fromJson.md +++ b/docs/talawa-mobile-docs/models_post_post_model/Post/Post.fromJson.md @@ -9,52 +9,51 @@ -Post.fromJson([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> json) +Post.fromJson([Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> json) -

Creating a new Post instance from a map structure.

-

params: +\Creating a new Post instance from a map structure.\ +\params: None -returns:

-
    -
  • PostObject: Dart Object for posts
  • -
+returns:\ +\ +\\PostObject\: Dart Object for posts\ +\ ## Implementation ```dart -/// -/// params: -/// None -/// returns: -/// * `PostObject`: Dart Object for posts -Post.fromJson(Map json) { +params: +None +returns: +* `PostObject`: Dart Object for posts +Post.fromJson(Map\ json) \{ sId = json['_id'] as String; description = json['text'] as String?; createdAt = DateTime.parse(json['createdAt'] as String); imageUrl = json['imageUrl'] as String?; videoUrl = json['videoUrl'] as String?; creator = json['creator'] != null - ? User.fromJson(json['creator'] as Map, fromOrg: true) + ? User.fromJson(json['creator'] as Map\, fromOrg: true) : null; organization = json['organization'] != null - ? OrgInfo.fromJson(json['organization'] as Map) + ? OrgInfo.fromJson(json['organization'] as Map\) : null; - if (json['likedBy'] != null) { - likedBy = []; - json['likedBy'].forEach((v) { - likedBy?.add(LikedBy.fromJson(v as Map)); - }); - } - if (json['comments'] != null) { - comments = []; - json['comments'].forEach((v) { - comments?.add(Comments.fromJson(v as Map)); - }); - } -} + if (json['likedBy'] != null) \{ + likedBy = \[]; + json['likedBy'].forEach((v) \{ + likedBy?.add(LikedBy.fromJson(v as Map\)); + \}); + \} + if (json['comments'] != null) \{ + comments = \[]; + json['comments'].forEach((v) \{ + comments?.add(Comments.fromJson(v as Map\)); + \}); + \} +\} ``` diff --git a/docs/talawa-mobile-docs/models_post_post_model/Post/Post.md b/docs/talawa-mobile-docs/models_post_post_model/Post/Post.md index 829c0b018d5..3b730fe195b 100644 --- a/docs/talawa-mobile-docs/models_post_post_model/Post/Post.md +++ b/docs/talawa-mobile-docs/models_post_post_model/Post/Post.md @@ -9,7 +9,7 @@ -Post({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) sId, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? description, [DateTime](https://api.flutter.dev/flutter/dart-core/DateTime-class.html)? createdAt, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? imageUrl, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? videoUrl, required [User](../../models_user_user_info/User-class.md)? creator, [OrgInfo](../../models_organization_org_info/OrgInfo-class.md)? organization, [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[LikedBy](../../models_post_post_model/LikedBy-class.md)>? likedBy, [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Comments](../../models_post_post_model/Comments-class.md)>? comments}) +Post(\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) sId, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? description, [DateTime](https:api.flutter.dev/flutter/dart-core/DateTime-class.html)? createdAt, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? imageUrl, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? videoUrl, required [User](../../models_user_user_info/User-class.md)? creator, [OrgInfo](../../models_organization_org_info/OrgInfo-class.md)? organization, [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[LikedBy](../../models_post_post_model/LikedBy-class.md)\>? likedBy, [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Comments](../../models_post_post_model/Comments-class.md)\>? comments\}) @@ -18,7 +18,7 @@ Post({required [String](https://api.flutter.dev/flutter/dart-core/String-class.h ## Implementation ```dart -Post({ +Post(\{ required this.sId, this.description, this.createdAt, @@ -28,7 +28,7 @@ Post({ this.organization, this.likedBy, this.comments, -}); +\}); ``` diff --git a/docs/talawa-mobile-docs/models_post_post_model/Post/comments.md b/docs/talawa-mobile-docs/models_post_post_model/Post/comments.md index ecf34896607..e9e1135104b 100644 --- a/docs/talawa-mobile-docs/models_post_post_model/Post/comments.md +++ b/docs/talawa-mobile-docs/models_post_post_model/Post/comments.md @@ -9,20 +9,20 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Comments](../../models_post_post_model/Comments-class.md)>? comments +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Comments](../../models_post_post_model/Comments-class.md)\>? comments -_read / write_ +_\read / write\_ -

comments for post.

+\comments for post.\ ## Implementation ```dart -List? comments; +List\? comments; ``` diff --git a/docs/talawa-mobile-docs/models_post_post_model/Post/createdAt.md b/docs/talawa-mobile-docs/models_post_post_model/Post/createdAt.md index 6238dfa3cf4..6e6e81901b8 100644 --- a/docs/talawa-mobile-docs/models_post_post_model/Post/createdAt.md +++ b/docs/talawa-mobile-docs/models_post_post_model/Post/createdAt.md @@ -9,13 +9,13 @@ -[DateTime](https://api.flutter.dev/flutter/dart-core/DateTime-class.html)? createdAt +[DateTime](https:api.flutter.dev/flutter/dart-core/DateTime-class.html)? createdAt -_read / write_ +_\read / write\_ -

createdAt for post.

+\createdAt for post.\ diff --git a/docs/talawa-mobile-docs/models_post_post_model/Post/creator.md b/docs/talawa-mobile-docs/models_post_post_model/Post/creator.md index a7a0a80a410..8e4105512ac 100644 --- a/docs/talawa-mobile-docs/models_post_post_model/Post/creator.md +++ b/docs/talawa-mobile-docs/models_post_post_model/Post/creator.md @@ -11,11 +11,11 @@ [User](../../models_user_user_info/User-class.md)? creator -_read / write_ +_\read / write\_ -

creator for post.

+\creator for post.\ diff --git a/docs/talawa-mobile-docs/models_post_post_model/Post/description.md b/docs/talawa-mobile-docs/models_post_post_model/Post/description.md index a34d1f7ab5c..754e1fff881 100644 --- a/docs/talawa-mobile-docs/models_post_post_model/Post/description.md +++ b/docs/talawa-mobile-docs/models_post_post_model/Post/description.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? description +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? description -_read / write_ +_\read / write\_ -

description for post.

+\description for post.\ diff --git a/docs/talawa-mobile-docs/models_post_post_model/Post/getPostCreatedDuration.md b/docs/talawa-mobile-docs/models_post_post_model/Post/getPostCreatedDuration.md index 561e425671f..1411e851fa5 100644 --- a/docs/talawa-mobile-docs/models_post_post_model/Post/getPostCreatedDuration.md +++ b/docs/talawa-mobile-docs/models_post_post_model/Post/getPostCreatedDuration.md @@ -10,41 +10,41 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) getPostCreatedDuration +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) getPostCreatedDuration () -

this is to get duration of post.

-

params: - None

-

returns:

-
    -
  • String: date is returned in ago form.
  • -
+\this is to get duration of post.\ +\\params\: + None\ +\\returns\:\ +\ +\\String\: date is returned in ago form.\ +\ ## Implementation ```dart -String getPostCreatedDuration() { - if (DateTime.now().difference(this.createdAt!).inSeconds < 60) { - return '${DateTime.now().difference(this.createdAt!).inSeconds} Seconds Ago'; - } else if (DateTime.now().difference(this.createdAt!).inMinutes < 60) { - return '${DateTime.now().difference(this.createdAt!).inMinutes} Minutes Ago'; - } else if (DateTime.now().difference(this.createdAt!).inHours < 24) { - return '${DateTime.now().difference(this.createdAt!).inHours} Hours Ago'; - } else if (DateTime.now().difference(this.createdAt!).inDays < 30) { - return '${DateTime.now().difference(this.createdAt!).inDays} Days Ago'; - } else if (DateTime.now().difference(this.createdAt!).inDays < 365) { - return '${DateTime.now().difference(this.createdAt!).inDays ~/ 30} Months Ago'; - } else { - return '${DateTime.now().difference(this.createdAt!).inDays ~/ 365} Years Ago'; - } -} +String getPostCreatedDuration() \{ + if (DateTime.now().difference(this.createdAt!).inSeconds \< 60) \{ + return '$\{DateTime.now().difference(this.createdAt!).inSeconds\} Seconds Ago'; + \} else if (DateTime.now().difference(this.createdAt!).inMinutes \< 60) \{ + return '$\{DateTime.now().difference(this.createdAt!).inMinutes\} Minutes Ago'; + \} else if (DateTime.now().difference(this.createdAt!).inHours \< 24) \{ + return '$\{DateTime.now().difference(this.createdAt!).inHours\} Hours Ago'; + \} else if (DateTime.now().difference(this.createdAt!).inDays \< 30) \{ + return '$\{DateTime.now().difference(this.createdAt!).inDays\} Days Ago'; + \} else if (DateTime.now().difference(this.createdAt!).inDays \< 365) \{ + return '$\{DateTime.now().difference(this.createdAt!).inDays ~/ 30\} Months Ago'; + \} else \{ + return '$\{DateTime.now().difference(this.createdAt!).inDays ~/ 365\} Years Ago'; + \} +\} ``` diff --git a/docs/talawa-mobile-docs/models_post_post_model/Post/imageUrl.md b/docs/talawa-mobile-docs/models_post_post_model/Post/imageUrl.md index ccbaf0864c6..49cf6b12ab4 100644 --- a/docs/talawa-mobile-docs/models_post_post_model/Post/imageUrl.md +++ b/docs/talawa-mobile-docs/models_post_post_model/Post/imageUrl.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? imageUrl +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? imageUrl -_read / write_ +_\read / write\_ -

imageUrl for post.

+\imageUrl for post.\ diff --git a/docs/talawa-mobile-docs/models_post_post_model/Post/likedBy.md b/docs/talawa-mobile-docs/models_post_post_model/Post/likedBy.md index 3568e7dd849..006a64f6a20 100644 --- a/docs/talawa-mobile-docs/models_post_post_model/Post/likedBy.md +++ b/docs/talawa-mobile-docs/models_post_post_model/Post/likedBy.md @@ -9,20 +9,20 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[LikedBy](../../models_post_post_model/LikedBy-class.md)>? likedBy +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[LikedBy](../../models_post_post_model/LikedBy-class.md)\>? likedBy -_read / write_ +_\read / write\_ -

likedBy for post.

+\likedBy for post.\ ## Implementation ```dart -List? likedBy; +List\? likedBy; ``` diff --git a/docs/talawa-mobile-docs/models_post_post_model/Post/organization.md b/docs/talawa-mobile-docs/models_post_post_model/Post/organization.md index 87e5b3d7521..9008fc74b11 100644 --- a/docs/talawa-mobile-docs/models_post_post_model/Post/organization.md +++ b/docs/talawa-mobile-docs/models_post_post_model/Post/organization.md @@ -11,11 +11,11 @@ [OrgInfo](../../models_organization_org_info/OrgInfo-class.md)? organization -_read / write_ +_\read / write\_ -

organization for post.

+\organization for post.\ diff --git a/docs/talawa-mobile-docs/models_post_post_model/Post/sId.md b/docs/talawa-mobile-docs/models_post_post_model/Post/sId.md index 1a82d26e6fb..f79a0bbbefb 100644 --- a/docs/talawa-mobile-docs/models_post_post_model/Post/sId.md +++ b/docs/talawa-mobile-docs/models_post_post_model/Post/sId.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) sId +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) sId -_read / write_ +_\read / write\_ -

unique identifier for post.

+\unique identifier for post.\ diff --git a/docs/talawa-mobile-docs/models_post_post_model/Post/videoUrl.md b/docs/talawa-mobile-docs/models_post_post_model/Post/videoUrl.md index 12fb954e3ef..ba3cea2dc5c 100644 --- a/docs/talawa-mobile-docs/models_post_post_model/Post/videoUrl.md +++ b/docs/talawa-mobile-docs/models_post_post_model/Post/videoUrl.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? videoUrl +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? videoUrl -_read / write_ +_\read / write\_ -

videoUrl for post.

+\videoUrl for post.\ diff --git a/docs/talawa-mobile-docs/models_task_task_model/Task-class.md b/docs/talawa-mobile-docs/models_task_task_model/Task-class.md index 622477968df..ebb6a7b3db3 100644 --- a/docs/talawa-mobile-docs/models_task_task_model/Task-class.md +++ b/docs/talawa-mobile-docs/models_task_task_model/Task-class.md @@ -17,23 +17,23 @@ ## Constructors -[Task](../models_task_task_model/Task/Task.md) ({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) id, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) title, required [User](../models_user_user_info/User-class.md) creator, required [Event](../models_events_event_model/Event-class.md) event, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) createdAt, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? description, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? deadline}) +[Task](../models_task_task_model/Task/Task.md) (\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) id, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) title, required [User](../models_user_user_info/User-class.md) creator, required [Event](../models_events_event_model/Event-class.md) event, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) createdAt, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? description, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? deadline\}) _const_ -[Task.fromJson](../models_task_task_model/Task/Task.fromJson.md) ([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> json) +[Task.fromJson](../models_task_task_model/Task/Task.fromJson.md) ([Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> json) /Creating a new Task instance from a map structure. _factory_ ## Properties -##### [createdAt](../models_task_task_model/Task/createdAt.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [createdAt](../models_task_task_model/Task/createdAt.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_final_ +_\final\_ @@ -42,25 +42,25 @@ _final_ -_final_ +_\final\_ -##### [deadline](../models_task_task_model/Task/deadline.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [deadline](../models_task_task_model/Task/deadline.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_final_ +_\final\_ -##### [description](../models_task_task_model/Task/description.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [description](../models_task_task_model/Task/description.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_final_ +_\final\_ @@ -69,43 +69,43 @@ _final_ -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [id](../models_task_task_model/Task/id.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [id](../models_task_task_model/Task/id.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [title](../models_task_task_model/Task/title.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [title](../models_task_task_model/Task/title.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_final_ +_\final\_ @@ -113,21 +113,21 @@ _final_ ## Methods -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -135,12 +135,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/models_task_task_model/Task/Task.fromJson.md b/docs/talawa-mobile-docs/models_task_task_model/Task/Task.fromJson.md index f1c2c1fb00d..ea9fb3249b1 100644 --- a/docs/talawa-mobile-docs/models_task_task_model/Task/Task.fromJson.md +++ b/docs/talawa-mobile-docs/models_task_task_model/Task/Task.fromJson.md @@ -9,10 +9,10 @@ -Task.fromJson([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> json) +Task.fromJson([Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> json) -

/Creating a new Task instance from a map structure.

+\/Creating a new Task instance from a map structure.\ @@ -20,23 +20,23 @@ Task.fromJson([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)< ```dart factory Task.fromJson( - Map json, -) { + Map\ json, +) \{ return Task( id: json['_id'] as String, title: json['title'] as String, creator: User.fromJson( - json['creator'] as Map, + json['creator'] as Map\, fromOrg: true, ), event: Event.fromJson( - json['event'] as Map, + json['event'] as Map\, ), createdAt: json['createdAt'] as String, description: json['description'] as String?, deadline: json['deadline'] as String?, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/models_task_task_model/Task/Task.md b/docs/talawa-mobile-docs/models_task_task_model/Task/Task.md index ee67ef19e98..5118c2f10fb 100644 --- a/docs/talawa-mobile-docs/models_task_task_model/Task/Task.md +++ b/docs/talawa-mobile-docs/models_task_task_model/Task/Task.md @@ -9,7 +9,7 @@ const -Task({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) id, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) title, required [User](../../models_user_user_info/User-class.md) creator, required [Event](../../models_events_event_model/Event-class.md) event, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) createdAt, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? description, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? deadline}) +Task(\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) id, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) title, required [User](../../models_user_user_info/User-class.md) creator, required [Event](../../models_events_event_model/Event-class.md) event, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) createdAt, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? description, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? deadline\}) @@ -18,7 +18,7 @@ Task({required [String](https://api.flutter.dev/flutter/dart-core/String-class.h ## Implementation ```dart -const Task({ +const Task(\{ required this.id, required this.title, required this.creator, @@ -26,7 +26,7 @@ const Task({ required this.createdAt, this.description, this.deadline, -}); +\}); ``` diff --git a/docs/talawa-mobile-docs/models_task_task_model/Task/createdAt.md b/docs/talawa-mobile-docs/models_task_task_model/Task/createdAt.md index 84314f52c8b..79fd5289e5c 100644 --- a/docs/talawa-mobile-docs/models_task_task_model/Task/createdAt.md +++ b/docs/talawa-mobile-docs/models_task_task_model/Task/createdAt.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) createdAt +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) createdAt -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/models_task_task_model/Task/creator.md b/docs/talawa-mobile-docs/models_task_task_model/Task/creator.md index b5c8e08369a..d4002b81428 100644 --- a/docs/talawa-mobile-docs/models_task_task_model/Task/creator.md +++ b/docs/talawa-mobile-docs/models_task_task_model/Task/creator.md @@ -11,7 +11,7 @@ [User](../../models_user_user_info/User-class.md) creator -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/models_task_task_model/Task/deadline.md b/docs/talawa-mobile-docs/models_task_task_model/Task/deadline.md index 21dd7e7e7e9..235039d0a21 100644 --- a/docs/talawa-mobile-docs/models_task_task_model/Task/deadline.md +++ b/docs/talawa-mobile-docs/models_task_task_model/Task/deadline.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? deadline +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? deadline -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/models_task_task_model/Task/description.md b/docs/talawa-mobile-docs/models_task_task_model/Task/description.md index ae3e97fef08..fca3d690b26 100644 --- a/docs/talawa-mobile-docs/models_task_task_model/Task/description.md +++ b/docs/talawa-mobile-docs/models_task_task_model/Task/description.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? description +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? description -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/models_task_task_model/Task/event.md b/docs/talawa-mobile-docs/models_task_task_model/Task/event.md index 9714bc41af6..37484898515 100644 --- a/docs/talawa-mobile-docs/models_task_task_model/Task/event.md +++ b/docs/talawa-mobile-docs/models_task_task_model/Task/event.md @@ -11,7 +11,7 @@ [Event](../../models_events_event_model/Event-class.md) event -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/models_task_task_model/Task/id.md b/docs/talawa-mobile-docs/models_task_task_model/Task/id.md index 672a052c2a6..9f71bb9b272 100644 --- a/docs/talawa-mobile-docs/models_task_task_model/Task/id.md +++ b/docs/talawa-mobile-docs/models_task_task_model/Task/id.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) id +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) id -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/models_task_task_model/Task/title.md b/docs/talawa-mobile-docs/models_task_task_model/Task/title.md index 7c14a386485..27e728d54a8 100644 --- a/docs/talawa-mobile-docs/models_task_task_model/Task/title.md +++ b/docs/talawa-mobile-docs/models_task_task_model/Task/title.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) title +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) title -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/models_user_user_info/User-class.md b/docs/talawa-mobile-docs/models_user_user_info/User-class.md index 2f88321317e..d9808dece21 100644 --- a/docs/talawa-mobile-docs/models_user_user_info/User-class.md +++ b/docs/talawa-mobile-docs/models_user_user_info/User-class.md @@ -11,14 +11,14 @@ -

This class creates a User model and returns a user instance.

+\This class creates a User model and returns a user instance.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [HiveObject](https://pub.dev/documentation/hive/2.2.3/hive/HiveObject-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [HiveObject](https:pub.dev/documentation/hive/2.2.3/hive/HiveObject-class.html) - User @@ -28,165 +28,165 @@ **Annotations** -- @[HiveType](https://pub.dev/documentation/hive/2.2.3/hive/HiveType-class.html)(typeId: 1) +- @[HiveType](https:pub.dev/documentation/hive/2.2.3/hive/HiveType-class.html)(typeId: 1) ## Constructors -[User](../models_user_user_info/User/User.md) ({[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)>? adminFor, [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)>? createdOrganizations, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? email, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? firstName, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? id, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? image, [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)>? joinedOrganizations, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? lastName, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? authToken, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? refreshToken, [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)>? membershipRequests}) +[User](../models_user_user_info/User/User.md) (\{[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)\>? adminFor, [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)\>? createdOrganizations, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? email, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? firstName, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? id, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? image, [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)\>? joinedOrganizations, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? lastName, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? authToken, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? refreshToken, [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)\>? membershipRequests\}) -[User.fromJson](../models_user_user_info/User/User.fromJson.md) ([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> json1, {[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) fromOrg = false}) +[User.fromJson](../models_user_user_info/User/User.fromJson.md) ([Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> json1, \{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) fromOrg = false\}) _factory_ ## Properties -##### [adminFor](../models_user_user_info/User/adminFor.md) ↔ [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)>? +##### [adminFor](../models_user_user_info/User/adminFor.md) ↔ [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)\>? -_read / write_ +_\read / write\_ -##### [authToken](../models_user_user_info/User/authToken.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [authToken](../models_user_user_info/User/authToken.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [box](https://pub.dev/documentation/hive/2.2.3/hive/HiveObjectMixin/box.html) → [BoxBase](https://pub.dev/documentation/hive/2.2.3/hive/BoxBase-class.html)? +##### [box](https:pub.dev/documentation/hive/2.2.3/hive/HiveObjectMixin/box.html) → [BoxBase](https:pub.dev/documentation/hive/2.2.3/hive/BoxBase-class.html)? -Get the box in which this object is stored. Returns null if object has +Get the box in which this object is stored. Returns \null\ if object has not been added to a box yet. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [createdOrganizations](../models_user_user_info/User/createdOrganizations.md) ↔ [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)>? +##### [createdOrganizations](../models_user_user_info/User/createdOrganizations.md) ↔ [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)\>? -_read / write_ +_\read / write\_ -##### [email](../models_user_user_info/User/email.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [email](../models_user_user_info/User/email.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [firstName](../models_user_user_info/User/firstName.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [firstName](../models_user_user_info/User/firstName.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [id](../models_user_user_info/User/id.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [id](../models_user_user_info/User/id.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [image](../models_user_user_info/User/image.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [image](../models_user_user_info/User/image.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [isInBox](https://pub.dev/documentation/hive/2.2.3/hive/HiveObjectMixin/isInBox.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isInBox](https:pub.dev/documentation/hive/2.2.3/hive/HiveObjectMixin/isInBox.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Returns whether this object is currently stored in a box. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [joinedOrganizations](../models_user_user_info/User/joinedOrganizations.md) ↔ [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)>? +##### [joinedOrganizations](../models_user_user_info/User/joinedOrganizations.md) ↔ [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)\>? -_read / write_ +_\read / write\_ -##### [key](https://pub.dev/documentation/hive/2.2.3/hive/HiveObjectMixin/key.html) → dynamic +##### [key](https:pub.dev/documentation/hive/2.2.3/hive/HiveObjectMixin/key.html) → dynamic -Get the key associated with this object. Returns null if object has +Get the key associated with this object. Returns \null\ if object has not been added to a box yet. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [lastName](../models_user_user_info/User/lastName.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [lastName](../models_user_user_info/User/lastName.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [membershipRequests](../models_user_user_info/User/membershipRequests.md) ↔ [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)>? +##### [membershipRequests](../models_user_user_info/User/membershipRequests.md) ↔ [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)\>? -_read / write_ +_\read / write\_ -##### [refreshToken](../models_user_user_info/User/refreshToken.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [refreshToken](../models_user_user_info/User/refreshToken.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -194,21 +194,21 @@ _read-onlyinherited_ ## Methods -##### [delete](https://pub.dev/documentation/hive/2.2.3/hive/HiveObjectMixin/delete.html)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [delete](https:pub.dev/documentation/hive/2.2.3/hive/HiveObjectMixin/delete.html)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> Deletes this object from the box it is stored in. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ @@ -221,21 +221,21 @@ _inherited_ -##### [save](https://pub.dev/documentation/hive/2.2.3/hive/HiveObjectMixin/save.html)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [save](https:pub.dev/documentation/hive/2.2.3/hive/HiveObjectMixin/save.html)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> Persists this object. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -248,7 +248,7 @@ _inherited_ -##### [updateAdminFor](../models_user_user_info/User/updateAdminFor.md)([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)> orgList) void +##### [updateAdminFor](../models_user_user_info/User/updateAdminFor.md)([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)\> orgList) void @@ -257,7 +257,7 @@ _inherited_ -##### [updateCreatedOrg](../models_user_user_info/User/updateCreatedOrg.md)([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)> orgList) void +##### [updateCreatedOrg](../models_user_user_info/User/updateCreatedOrg.md)([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)\> orgList) void @@ -266,7 +266,7 @@ _inherited_ -##### [updateJoinedOrg](../models_user_user_info/User/updateJoinedOrg.md)([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)> orgList) void +##### [updateJoinedOrg](../models_user_user_info/User/updateJoinedOrg.md)([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)\> orgList) void @@ -275,7 +275,7 @@ _inherited_ -##### [updateMemberRequestOrg](../models_user_user_info/User/updateMemberRequestOrg.md)([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)> orgList) void +##### [updateMemberRequestOrg](../models_user_user_info/User/updateMemberRequestOrg.md)([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)\> orgList) void @@ -288,12 +288,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/models_user_user_info/User/User.fromJson.md b/docs/talawa-mobile-docs/models_user_user_info/User/User.fromJson.md index c568f69e4a2..1cdcd89d090 100644 --- a/docs/talawa-mobile-docs/models_user_user_info/User/User.fromJson.md +++ b/docs/talawa-mobile-docs/models_user_user_info/User/User.fromJson.md @@ -9,7 +9,7 @@ -User.fromJson([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> json1, {[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) fromOrg = false}) +User.fromJson([Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> json1, \{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) fromOrg = false\}) @@ -18,13 +18,13 @@ User.fromJson([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)< ## Implementation ```dart -factory User.fromJson(Map json1, {bool fromOrg = false}) { - Map json; - if (fromOrg) { +factory User.fromJson(Map\ json1, \{bool fromOrg = false\}) \{ + Map\ json; + if (fromOrg) \{ json = json1; - } else { - json = json1['user'] as Map; - } + \} else \{ + json = json1['user'] as Map\; + \} return User( authToken: fromOrg ? ' ' : json1['accessToken'] as String?, refreshToken: fromOrg ? ' ' : json1['refreshToken'] as String?, @@ -35,32 +35,32 @@ factory User.fromJson(Map json1, {bool fromOrg = false}) { email: json['email'] != null ? json['email'] as String? : null, image: json['image'] != null ? json['image'] as String? : null, adminFor: json['adminFor'] != null - ? (json['adminFor'] as List?) - ?.map((e) => OrgInfo.fromJson(e as Map)) + ? (json['adminFor'] as List\?) + ?.map((e) =\> OrgInfo.fromJson(e as Map\)) .toList() : null, createdOrganizations: json['createdOrganizations'] != null - ? (json['createdOrganizations'] as List?) - ?.map((e) => OrgInfo.fromJson(e as Map)) + ? (json['createdOrganizations'] as List\?) + ?.map((e) =\> OrgInfo.fromJson(e as Map\)) .toList() : null, joinedOrganizations: json['joinedOrganizations'] != null - ? (json['joinedOrganizations'] as List?) - ?.map((e) => OrgInfo.fromJson(e as Map)) + ? (json['joinedOrganizations'] as List\?) + ?.map((e) =\> OrgInfo.fromJson(e as Map\)) .toList() : null, membershipRequests: json['membershipRequests'] != null - ? (json['membershipRequests'] as List?) + ? (json['membershipRequests'] as List\?) ?.map( - (e) => OrgInfo.fromJson( - e as Map, + (e) =\> OrgInfo.fromJson( + e as Map\, memberRequest: true, ), ) .toList() : null, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/models_user_user_info/User/User.md b/docs/talawa-mobile-docs/models_user_user_info/User/User.md index 2e34c1ed08c..f9582d8cdd0 100644 --- a/docs/talawa-mobile-docs/models_user_user_info/User/User.md +++ b/docs/talawa-mobile-docs/models_user_user_info/User/User.md @@ -9,7 +9,7 @@ -User({[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)>? adminFor, [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)>? createdOrganizations, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? email, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? firstName, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? id, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? image, [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)>? joinedOrganizations, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? lastName, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? authToken, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? refreshToken, [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)>? membershipRequests}) +User(\{[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)\>? adminFor, [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)\>? createdOrganizations, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? email, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? firstName, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? id, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? image, [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)\>? joinedOrganizations, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? lastName, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? authToken, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? refreshToken, [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)\>? membershipRequests\}) @@ -18,7 +18,7 @@ User({[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgI ## Implementation ```dart -User({ +User(\{ this.adminFor, this.createdOrganizations, this.email, @@ -30,7 +30,7 @@ User({ this.authToken, this.refreshToken, this.membershipRequests, -}); +\}); ``` diff --git a/docs/talawa-mobile-docs/models_user_user_info/User/adminFor.md b/docs/talawa-mobile-docs/models_user_user_info/User/adminFor.md index f32ef5aca4c..628d900c159 100644 --- a/docs/talawa-mobile-docs/models_user_user_info/User/adminFor.md +++ b/docs/talawa-mobile-docs/models_user_user_info/User/adminFor.md @@ -11,10 +11,10 @@ **Annotations** -- @[HiveField](https://pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(9) -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)>? adminFor +- @[HiveField](https:pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(9) +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)\>? adminFor -_read / write_ +_\read / write\_ @@ -25,7 +25,7 @@ _read / write_ ```dart @HiveField(9) -List? adminFor = []; +List\? adminFor = []; ``` diff --git a/docs/talawa-mobile-docs/models_user_user_info/User/authToken.md b/docs/talawa-mobile-docs/models_user_user_info/User/authToken.md index f378cbba335..1282d2a27dd 100644 --- a/docs/talawa-mobile-docs/models_user_user_info/User/authToken.md +++ b/docs/talawa-mobile-docs/models_user_user_info/User/authToken.md @@ -11,10 +11,10 @@ **Annotations** -- @[HiveField](https://pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(0) -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? authToken +- @[HiveField](https:pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(0) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? authToken -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_user_user_info/User/createdOrganizations.md b/docs/talawa-mobile-docs/models_user_user_info/User/createdOrganizations.md index 791251b3951..520419c42ec 100644 --- a/docs/talawa-mobile-docs/models_user_user_info/User/createdOrganizations.md +++ b/docs/talawa-mobile-docs/models_user_user_info/User/createdOrganizations.md @@ -11,10 +11,10 @@ **Annotations** -- @[HiveField](https://pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(8) -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)>? createdOrganizations +- @[HiveField](https:pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(8) +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)\>? createdOrganizations -_read / write_ +_\read / write\_ @@ -25,7 +25,7 @@ _read / write_ ```dart @HiveField(8) -List? createdOrganizations = []; +List\? createdOrganizations = []; ``` diff --git a/docs/talawa-mobile-docs/models_user_user_info/User/email.md b/docs/talawa-mobile-docs/models_user_user_info/User/email.md index 34b599f1bc1..4a1037a42b5 100644 --- a/docs/talawa-mobile-docs/models_user_user_info/User/email.md +++ b/docs/talawa-mobile-docs/models_user_user_info/User/email.md @@ -11,10 +11,10 @@ **Annotations** -- @[HiveField](https://pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(5) -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? email +- @[HiveField](https:pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(5) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? email -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_user_user_info/User/firstName.md b/docs/talawa-mobile-docs/models_user_user_info/User/firstName.md index b782ee7afd8..e26c88f0c4f 100644 --- a/docs/talawa-mobile-docs/models_user_user_info/User/firstName.md +++ b/docs/talawa-mobile-docs/models_user_user_info/User/firstName.md @@ -11,10 +11,10 @@ **Annotations** -- @[HiveField](https://pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(3) -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? firstName +- @[HiveField](https:pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(3) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? firstName -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_user_user_info/User/id.md b/docs/talawa-mobile-docs/models_user_user_info/User/id.md index 1f2e418e572..d9b63e51b89 100644 --- a/docs/talawa-mobile-docs/models_user_user_info/User/id.md +++ b/docs/talawa-mobile-docs/models_user_user_info/User/id.md @@ -11,10 +11,10 @@ **Annotations** -- @[HiveField](https://pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(2) -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? id +- @[HiveField](https:pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(2) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? id -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_user_user_info/User/image.md b/docs/talawa-mobile-docs/models_user_user_info/User/image.md index ff44e85e098..94fd4c36e0c 100644 --- a/docs/talawa-mobile-docs/models_user_user_info/User/image.md +++ b/docs/talawa-mobile-docs/models_user_user_info/User/image.md @@ -11,10 +11,10 @@ **Annotations** -- @[HiveField](https://pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(6) -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? image +- @[HiveField](https:pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(6) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? image -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_user_user_info/User/joinedOrganizations.md b/docs/talawa-mobile-docs/models_user_user_info/User/joinedOrganizations.md index 364ee575b9c..3a8a036f5a3 100644 --- a/docs/talawa-mobile-docs/models_user_user_info/User/joinedOrganizations.md +++ b/docs/talawa-mobile-docs/models_user_user_info/User/joinedOrganizations.md @@ -11,10 +11,10 @@ **Annotations** -- @[HiveField](https://pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(7) -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)>? joinedOrganizations +- @[HiveField](https:pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(7) +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)\>? joinedOrganizations -_read / write_ +_\read / write\_ @@ -25,7 +25,7 @@ _read / write_ ```dart @HiveField(7) -List? joinedOrganizations = []; +List\? joinedOrganizations = []; ``` diff --git a/docs/talawa-mobile-docs/models_user_user_info/User/lastName.md b/docs/talawa-mobile-docs/models_user_user_info/User/lastName.md index b02f4c180f5..9fc34b8be3d 100644 --- a/docs/talawa-mobile-docs/models_user_user_info/User/lastName.md +++ b/docs/talawa-mobile-docs/models_user_user_info/User/lastName.md @@ -11,10 +11,10 @@ **Annotations** -- @[HiveField](https://pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(4) -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? lastName +- @[HiveField](https:pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(4) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? lastName -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_user_user_info/User/membershipRequests.md b/docs/talawa-mobile-docs/models_user_user_info/User/membershipRequests.md index 483f6a9dff1..8395813675c 100644 --- a/docs/talawa-mobile-docs/models_user_user_info/User/membershipRequests.md +++ b/docs/talawa-mobile-docs/models_user_user_info/User/membershipRequests.md @@ -11,10 +11,10 @@ **Annotations** -- @[HiveField](https://pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(10) -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)>? membershipRequests +- @[HiveField](https:pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(10) +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)\>? membershipRequests -_read / write_ +_\read / write\_ @@ -25,7 +25,7 @@ _read / write_ ```dart @HiveField(10) -List? membershipRequests = []; +List\? membershipRequests = []; ``` diff --git a/docs/talawa-mobile-docs/models_user_user_info/User/print.md b/docs/talawa-mobile-docs/models_user_user_info/User/print.md index 9887d704aa7..900272351e5 100644 --- a/docs/talawa-mobile-docs/models_user_user_info/User/print.md +++ b/docs/talawa-mobile-docs/models_user_user_info/User/print.md @@ -23,19 +23,19 @@ void print ## Implementation ```dart -void print() { - debugPrint('authToken: ${this.authToken}'); - debugPrint('refreshToken: ${this.refreshToken}'); - debugPrint('_id: ${this.id}'); - debugPrint('firstName: ${this.firstName}'); - debugPrint('lastName: ${this.lastName}'); - debugPrint('image: ${this.image}'); - debugPrint('email: ${this.email}'); - debugPrint('joinedOrganizations: ${this.joinedOrganizations}'); - debugPrint('adminFor: ${this.adminFor}'); - debugPrint('createdOrganizations: ${this.createdOrganizations}'); - debugPrint('membershipRequests: ${this.membershipRequests}'); -} +void print() \{ + debugPrint('authToken: $\{this.authToken\}'); + debugPrint('refreshToken: $\{this.refreshToken\}'); + debugPrint('_id: $\{this.id\}'); + debugPrint('firstName: $\{this.firstName\}'); + debugPrint('lastName: $\{this.lastName\}'); + debugPrint('image: $\{this.image\}'); + debugPrint('email: $\{this.email\}'); + debugPrint('joinedOrganizations: $\{this.joinedOrganizations\}'); + debugPrint('adminFor: $\{this.adminFor\}'); + debugPrint('createdOrganizations: $\{this.createdOrganizations\}'); + debugPrint('membershipRequests: $\{this.membershipRequests\}'); +\} ``` diff --git a/docs/talawa-mobile-docs/models_user_user_info/User/refreshToken.md b/docs/talawa-mobile-docs/models_user_user_info/User/refreshToken.md index 87c25db04fc..b34d184e731 100644 --- a/docs/talawa-mobile-docs/models_user_user_info/User/refreshToken.md +++ b/docs/talawa-mobile-docs/models_user_user_info/User/refreshToken.md @@ -11,10 +11,10 @@ **Annotations** -- @[HiveField](https://pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(1) -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? refreshToken +- @[HiveField](https:pub.dev/documentation/hive/2.2.3/hive/HiveField-class.html)(1) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? refreshToken -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/models_user_user_info/User/update.md b/docs/talawa-mobile-docs/models_user_user_info/User/update.md index a11d0f02346..0d622cbe2ed 100644 --- a/docs/talawa-mobile-docs/models_user_user_info/User/update.md +++ b/docs/talawa-mobile-docs/models_user_user_info/User/update.md @@ -23,7 +23,7 @@ void update ## Implementation ```dart -void update(User details) { +void update(User details) \{ this.firstName = details.firstName; this.lastName = details.lastName; this.email = details.email; @@ -34,7 +34,7 @@ void update(User details) { this.createdOrganizations = details.createdOrganizations; this.membershipRequests = details.membershipRequests; this.adminFor = details.adminFor; -} +\} ``` diff --git a/docs/talawa-mobile-docs/models_user_user_info/User/updateAdminFor.md b/docs/talawa-mobile-docs/models_user_user_info/User/updateAdminFor.md index 0d104cd528a..715ab557ae0 100644 --- a/docs/talawa-mobile-docs/models_user_user_info/User/updateAdminFor.md +++ b/docs/talawa-mobile-docs/models_user_user_info/User/updateAdminFor.md @@ -11,7 +11,7 @@ void updateAdminFor -([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)> orgList) +([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)\> orgList) @@ -23,9 +23,9 @@ void updateAdminFor ## Implementation ```dart -void updateAdminFor(List orgList) { +void updateAdminFor(List\ orgList) \{ this.adminFor = orgList; -} +\} ``` diff --git a/docs/talawa-mobile-docs/models_user_user_info/User/updateCreatedOrg.md b/docs/talawa-mobile-docs/models_user_user_info/User/updateCreatedOrg.md index 384f2a3638e..616fee18937 100644 --- a/docs/talawa-mobile-docs/models_user_user_info/User/updateCreatedOrg.md +++ b/docs/talawa-mobile-docs/models_user_user_info/User/updateCreatedOrg.md @@ -11,7 +11,7 @@ void updateCreatedOrg -([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)> orgList) +([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)\> orgList) @@ -23,9 +23,9 @@ void updateCreatedOrg ## Implementation ```dart -void updateCreatedOrg(List orgList) { +void updateCreatedOrg(List\ orgList) \{ this.createdOrganizations = orgList; -} +\} ``` diff --git a/docs/talawa-mobile-docs/models_user_user_info/User/updateJoinedOrg.md b/docs/talawa-mobile-docs/models_user_user_info/User/updateJoinedOrg.md index ce7eb1d6417..02c8cd4d4cf 100644 --- a/docs/talawa-mobile-docs/models_user_user_info/User/updateJoinedOrg.md +++ b/docs/talawa-mobile-docs/models_user_user_info/User/updateJoinedOrg.md @@ -11,7 +11,7 @@ void updateJoinedOrg -([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)> orgList) +([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)\> orgList) @@ -23,9 +23,9 @@ void updateJoinedOrg ## Implementation ```dart -void updateJoinedOrg(List orgList) { +void updateJoinedOrg(List\ orgList) \{ this.joinedOrganizations = orgList; -} +\} ``` diff --git a/docs/talawa-mobile-docs/models_user_user_info/User/updateMemberRequestOrg.md b/docs/talawa-mobile-docs/models_user_user_info/User/updateMemberRequestOrg.md index a64ede2dca1..adb7d68f9ed 100644 --- a/docs/talawa-mobile-docs/models_user_user_info/User/updateMemberRequestOrg.md +++ b/docs/talawa-mobile-docs/models_user_user_info/User/updateMemberRequestOrg.md @@ -11,7 +11,7 @@ void updateMemberRequestOrg -([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)> orgList) +([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)\> orgList) @@ -23,9 +23,9 @@ void updateMemberRequestOrg ## Implementation ```dart -void updateMemberRequestOrg(List orgList) { +void updateMemberRequestOrg(List\ orgList) \{ this.membershipRequests = [...membershipRequests!, ...orgList]; -} +\} ``` diff --git a/docs/talawa-mobile-docs/models_user_user_info/UserAdapter-class.md b/docs/talawa-mobile-docs/models_user_user_info/UserAdapter-class.md index 128bc0ea409..6849d2120f4 100644 --- a/docs/talawa-mobile-docs/models_user_user_info/UserAdapter-class.md +++ b/docs/talawa-mobile-docs/models_user_user_info/UserAdapter-class.md @@ -16,8 +16,8 @@ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [TypeAdapter](https://pub.dev/documentation/hive/2.2.3/hive/TypeAdapter-class.html)<[User](../models_user_user_info/User-class.md)> +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [TypeAdapter](https:pub.dev/documentation/hive/2.2.3/hive/TypeAdapter-class.html)<[User](../models_user_user_info/User-class.md)\> - UserAdapter @@ -36,30 +36,30 @@ ## Properties -##### [hashCode](../models_user_user_info/UserAdapter/hashCode.md) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](../models_user_user_info/UserAdapter/hashCode.md) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyoverride_ +_\read-only\\override\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [typeId](../models_user_user_info/UserAdapter/typeId.md) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [typeId](../models_user_user_info/UserAdapter/typeId.md) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) Called for type registration -_final_ +_\final\_ @@ -67,39 +67,39 @@ _final_ ## Methods -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [read](../models_user_user_info/UserAdapter/read.md)([BinaryReader](https://pub.dev/documentation/hive/2.2.3/hive/BinaryReader-class.html) reader) [User](../models_user_user_info/User-class.md) +##### [read](../models_user_user_info/UserAdapter/read.md)([BinaryReader](https:pub.dev/documentation/hive/2.2.3/hive/BinaryReader-class.html) reader) [User](../models_user_user_info/User-class.md) Is called when a value has to be decoded. -_override_ +_\override\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [write](../models_user_user_info/UserAdapter/write.md)([BinaryWriter](https://pub.dev/documentation/hive/2.2.3/hive/BinaryWriter-class.html) writer, [User](../models_user_user_info/User-class.md) obj) void +##### [write](../models_user_user_info/UserAdapter/write.md)([BinaryWriter](https:pub.dev/documentation/hive/2.2.3/hive/BinaryWriter-class.html) writer, [User](../models_user_user_info/User-class.md) obj) void Is called when a value has to be encoded. -_override_ +_\override\_ @@ -107,12 +107,12 @@ _override_ ## Operators -##### [operator ==](../models_user_user_info/UserAdapter/operator_equals.md)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](../models_user_user_info/UserAdapter/operator_equals.md)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_override_ +_\override\_ diff --git a/docs/talawa-mobile-docs/models_user_user_info/UserAdapter/hashCode.md b/docs/talawa-mobile-docs/models_user_user_info/UserAdapter/hashCode.md index 8cc0476945a..11905f6348f 100644 --- a/docs/talawa-mobile-docs/models_user_user_info/UserAdapter/hashCode.md +++ b/docs/talawa-mobile-docs/models_user_user_info/UserAdapter/hashCode.md @@ -13,39 +13,39 @@ **Annotations** -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) -[int](https://api.flutter.dev/flutter/dart-core/int-class.html) hashCode +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) +[int](https:api.flutter.dev/flutter/dart-core/int-class.html) hashCode -_override_ +_\override\_ -

The hash code for this object.

-

A hash code is a single integer which represents the state of the object -that affects operator == comparisons.

-

All objects have hash codes. -The default hash code implemented by Object +\The hash code for this object.\ +\A hash code is a single integer which represents the state of the object +that affects \operator ==\ comparisons.\ +\All objects have hash codes. +The default hash code implemented by \Object\ represents only the identity of the object, -the same way as the default operator == implementation only considers objects -equal if they are identical (see identityHashCode).

-

If operator == is overridden to use the object state instead, +the same way as the default \operator ==\ implementation only considers objects +equal if they are identical (see \identityHashCode\).\ +\If \operator ==\ is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures -like the default Set and Map implementations.

-

Hash codes must be the same for objects that are equal to each other -according to operator ==. +like the default \Set\ and \Map\ implementations.\ +\Hash codes must be the same for objects that are equal to each other +according to \operator ==\. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program -and there are no distribution guarantees.

-

Objects that are not equal are allowed to have the same hash code. +and there are no distribution guarantees.\ +\Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures -like HashSet or HashMap.

-

If a subclass overrides hashCode, it should override the -operator == operator as well to maintain consistency.

+like \HashSet\ or \HashMap\.\ +\If a subclass overrides \hashCode\, it should override the +\operator ==\ operator as well to maintain consistency.\ @@ -53,7 +53,7 @@ like override_ +_\override\_ -

The equality operator.

-

The default behavior for all Objects is to return true if and -only if this object and other are the same object.

-

Override this method to specify a different equality relation on +\The equality operator.\ +\The default behavior for all \Object\s is to return true if and +only if this object and \other\ are the same object.\ +\Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. -That is, it must be:

-
    -
  • -

    Total: It must return a boolean for all arguments. It should never throw.

    -
  • -
  • -

    Reflexive: For all objects o, o == o must be true.

    -
  • -
  • -

    Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must -either both be true, or both be false.

    -
  • -
  • -

    Transitive: For all objects o1, o2, and o3, if o1 == o2 and -o2 == o3 are true, then o1 == o3 must be true.

    -
  • -
-

The method should also be consistent over time, +That is, it must be:\ +\ +\ +\Total: It must return a boolean for all arguments. It should never throw.\ +\ +\ +\Reflexive: For all objects \o\, \o == o\ must be true.\ +\ +\ +\Symmetric: For all objects \o1\ and \o2\, \o1 == o2\ and \o2 == o1\ must +either both be true, or both be false.\ +\ +\ +\Transitive: For all objects \o1\, \o2\, and \o3\, if \o1 == o2\ and +\o2 == o3\ are true, then \o1 == o3\ must be true.\ +\ +\ +\The method should also be consistent over time, so whether two objects are equal should only change -if at least one of the objects was modified.

-

If a subclass overrides the equality operator, it should override -the hashCode method as well to maintain consistency.

+if at least one of the objects was modified.\ +\If a subclass overrides the equality operator, it should override +the \hashCode\ method as well to maintain consistency.\ @@ -52,7 +52,7 @@ the hashCode m ```dart @override -bool operator ==(Object other) => +bool operator ==(Object other) =\> identical(this, other) || other is UserAdapter && runtimeType == other.runtimeType && diff --git a/docs/talawa-mobile-docs/models_user_user_info/UserAdapter/read.md b/docs/talawa-mobile-docs/models_user_user_info/UserAdapter/read.md index 8431b02dd56..45ae9905cac 100644 --- a/docs/talawa-mobile-docs/models_user_user_info/UserAdapter/read.md +++ b/docs/talawa-mobile-docs/models_user_user_info/UserAdapter/read.md @@ -9,16 +9,16 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) [User](../../models_user_user_info/User-class.md) read -([BinaryReader](https://pub.dev/documentation/hive/2.2.3/hive/BinaryReader-class.html) reader) +([BinaryReader](https:pub.dev/documentation/hive/2.2.3/hive/BinaryReader-class.html) reader) -_override_ +_\override\_ -

Is called when a value has to be decoded.

+\Is called when a value has to be decoded.\ @@ -26,25 +26,25 @@ _override_ ```dart @override -User read(BinaryReader reader) { +User read(BinaryReader reader) \{ final numOfFields = reader.readByte(); - final fields = { - for (int i = 0; i < numOfFields; i++) reader.readByte(): reader.read(), - }; + final fields = \\{ + for (int i = 0; i \< numOfFields; i++) reader.readByte(): reader.read(), + \}; return User( - adminFor: (fields[9] as List?)?.cast(), - createdOrganizations: (fields[8] as List?)?.cast(), + adminFor: (fields[9] as List?)?.cast\(), + createdOrganizations: (fields[8] as List?)?.cast\(), email: fields[5] as String?, firstName: fields[3] as String?, id: fields[2] as String?, image: fields[6] as String?, - joinedOrganizations: (fields[7] as List?)?.cast(), + joinedOrganizations: (fields[7] as List?)?.cast\(), lastName: fields[4] as String?, authToken: fields[0] as String?, refreshToken: fields[1] as String?, - membershipRequests: (fields[10] as List?)?.cast(), + membershipRequests: (fields[10] as List?)?.cast\(), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/models_user_user_info/UserAdapter/typeId.md b/docs/talawa-mobile-docs/models_user_user_info/UserAdapter/typeId.md index 2fc04cff052..7333369cdbe 100644 --- a/docs/talawa-mobile-docs/models_user_user_info/UserAdapter/typeId.md +++ b/docs/talawa-mobile-docs/models_user_user_info/UserAdapter/typeId.md @@ -11,14 +11,14 @@ **Annotations** -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) -[int](https://api.flutter.dev/flutter/dart-core/int-class.html) typeId +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) +[int](https:api.flutter.dev/flutter/dart-core/int-class.html) typeId -_final_ +_\final\_ -

Called for type registration

+\Called for type registration\ diff --git a/docs/talawa-mobile-docs/models_user_user_info/UserAdapter/write.md b/docs/talawa-mobile-docs/models_user_user_info/UserAdapter/write.md index 5d2fbb7a79d..a52cd2dd9ff 100644 --- a/docs/talawa-mobile-docs/models_user_user_info/UserAdapter/write.md +++ b/docs/talawa-mobile-docs/models_user_user_info/UserAdapter/write.md @@ -9,16 +9,16 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) void write -([BinaryWriter](https://pub.dev/documentation/hive/2.2.3/hive/BinaryWriter-class.html) writer, [User](../../models_user_user_info/User-class.md) obj) +([BinaryWriter](https:pub.dev/documentation/hive/2.2.3/hive/BinaryWriter-class.html) writer, [User](../../models_user_user_info/User-class.md) obj) -_override_ +_\override\_ -

Is called when a value has to be encoded.

+\Is called when a value has to be encoded.\ @@ -26,7 +26,7 @@ _override_ ```dart @override -void write(BinaryWriter writer, User obj) { +void write(BinaryWriter writer, User obj) \{ writer ..writeByte(11) ..writeByte(0) @@ -51,7 +51,7 @@ void write(BinaryWriter writer, User obj) { ..write(obj.adminFor) ..writeByte(10) ..write(obj.membershipRequests); -} +\} ``` diff --git a/docs/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList-class.md b/docs/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList-class.md index 84893bd0b0f..7cef0f080fd 100644 --- a/docs/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList-class.md +++ b/docs/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList-class.md @@ -11,7 +11,7 @@ -

This class fetch plugins list.

+\This class fetch plugins list.\ @@ -25,30 +25,30 @@ Constructor of the class. ## Properties -##### [box](../plugins_fetch_plugin_list/FetchPluginList/box.md) ↔ [Box](https://pub.dev/documentation/hive/2.2.3/hive/Box-class.html) +##### [box](../plugins_fetch_plugin_list/FetchPluginList/box.md) ↔ [Box](https:pub.dev/documentation/hive/2.2.3/hive/Box-class.html) late initialize the box. -_read / write_ +_\read / write\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -56,30 +56,30 @@ _read-onlyinherited_ ## Methods -##### [fetchList](../plugins_fetch_plugin_list/FetchPluginList/fetchList.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [fetchList](../plugins_fetch_plugin_list/FetchPluginList/fetchList.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> -Fetches plugins from server and stores them in Hive pluginBox. +Fetches plugins from server and stores them in Hive \pluginBox\. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -87,12 +87,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList/FetchPluginList.md b/docs/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList/FetchPluginList.md index 55304e7c1f7..cd9f3b12fb5 100644 --- a/docs/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList/FetchPluginList.md +++ b/docs/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList/FetchPluginList.md @@ -12,16 +12,16 @@ FetchPluginList() -

Constructor of the class.

+\Constructor of the class.\ ## Implementation ```dart -FetchPluginList() { +FetchPluginList() \{ fetchList(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList/box.md b/docs/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList/box.md index a4027696693..69b008248f4 100644 --- a/docs/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList/box.md +++ b/docs/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList/box.md @@ -9,13 +9,13 @@ -[Box](https://pub.dev/documentation/hive/2.2.3/hive/Box-class.html) box +[Box](https:pub.dev/documentation/hive/2.2.3/hive/Box-class.html) box -_read / write_ +_\read / write\_ -

late initialize the box.

+\late initialize the box.\ diff --git a/docs/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList/fetchList.md b/docs/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList/fetchList.md index 4a819919aaf..694960b85a0 100644 --- a/docs/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList/fetchList.md +++ b/docs/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList/fetchList.md @@ -10,27 +10,27 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> fetchList +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> fetchList () -

Fetches plugins from server and stores them in Hive pluginBox.

-

params: - None

-

returns:

-
    -
  • Future<void>: it returns Future of void
  • -
+\Fetches plugins from server and stores them in Hive \pluginBox\.\ +\\params\: + None\ +\\returns\:\ +\ +\\Future<void>\: it returns Future of void\ +\ ## Implementation ```dart -Future fetchList() async { +Future\ fetchList() async \{ late final GraphQLClient client = graphqlConfig.clientToQuery(); final QueryResult result = await client.query( QueryOptions( @@ -39,7 +39,7 @@ Future fetchList() async { ); box = Hive.box('pluginBox'); box.put('plugins', result.data!["getPlugins"]); -} +\} ``` diff --git a/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider-class.md b/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider-class.md index 85a8d898a13..75fe91827d1 100644 --- a/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider-class.md +++ b/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider-class.md @@ -11,16 +11,16 @@ -

TalwaPluginProvider provides ability to implement features as plugins

+\TalwaPluginProvider provides ability to implement features as plugins\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - TalawaPluginProvider @@ -32,64 +32,64 @@ ## Constructors -[TalawaPluginProvider](../plugins_talawa_plugin_provider/TalawaPluginProvider/TalawaPluginProvider.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, @[required](https://pub.dev/documentation/meta/1.8.0/meta/required-constant.html) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html)? child, required [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) visible, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) pluginName}) +[TalawaPluginProvider](../plugins_talawa_plugin_provider/TalawaPluginProvider/TalawaPluginProvider.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, @[required](https:pub.dev/documentation/meta/1.8.0/meta/required-constant.html) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html)? child, required [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) visible, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) pluginName\}) _const_ ## Properties -##### [child](../plugins_talawa_plugin_provider/TalawaPluginProvider/child.md) → [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html)? +##### [child](../plugins_talawa_plugin_provider/TalawaPluginProvider/child.md) → [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html)? child contains the widget for the plugin UI. -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [pluginName](../plugins_talawa_plugin_provider/TalawaPluginProvider/pluginName.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [pluginName](../plugins_talawa_plugin_provider/TalawaPluginProvider/pluginName.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) name of plugin preferred with underscores(_) instead of spaces -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [visible](../plugins_talawa_plugin_provider/TalawaPluginProvider/visible.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [visible](../plugins_talawa_plugin_provider/TalawaPluginProvider/visible.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) visible is the property that decides visibility of the UI. -_final_ +_\final\_ @@ -97,104 +97,104 @@ _final_ ## Methods -##### [build](../plugins_talawa_plugin_provider/TalawaPluginProvider/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../plugins_talawa_plugin_provider/TalawaPluginProvider/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) -build the Plugin combining local visibility property and serverVisible property -_override_ +build the Plugin combining local \visibility\ property and \serverVisible\ property +_\override\_ -##### [checkFromPluginList](../plugins_talawa_plugin_provider/TalawaPluginProvider/checkFromPluginList.md)() [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [checkFromPluginList](../plugins_talawa_plugin_provider/TalawaPluginProvider/checkFromPluginList.md)() [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -return bool decides the final visibility of the verifying from database and current OrgId +return \bool\ decides the final visibility of the verifying from database and current OrgId -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -202,12 +202,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/TalawaPluginProvider.md b/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/TalawaPluginProvider.md index fc8bbf2802f..32d59f07474 100644 --- a/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/TalawaPluginProvider.md +++ b/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/TalawaPluginProvider.md @@ -9,7 +9,7 @@ const -TalawaPluginProvider({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, @[required](https://pub.dev/documentation/meta/1.8.0/meta/required-constant.html) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html)? child, required [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) visible, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) pluginName}) +TalawaPluginProvider(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, @[required](https:pub.dev/documentation/meta/1.8.0/meta/required-constant.html) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html)? child, required [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) visible, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) pluginName\}) @@ -18,12 +18,12 @@ TalawaPluginProvider({[Key](https://api.flutter.dev/flutter/foundation/Key-class ## Implementation ```dart -const TalawaPluginProvider({ +const TalawaPluginProvider(\{ Key? key, @required this.child, required this.visible, required this.pluginName, -}) : super(key: key); +\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/build.md b/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/build.md index 1c71ed24b2c..a0a7066455b 100644 --- a/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/build.md +++ b/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/build.md @@ -9,16 +9,16 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

build the Plugin combining local visibility property and serverVisible property

+\build the Plugin combining local \visibility\ property and \serverVisible\ property\ @@ -26,11 +26,11 @@ _override_ ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ var serverVisible = false; serverVisible = checkFromPluginList(); return serverVisible || visible ? child! : Container(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/checkFromPluginList.md b/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/checkFromPluginList.md index b432bce7404..382289936cc 100644 --- a/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/checkFromPluginList.md +++ b/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/checkFromPluginList.md @@ -10,46 +10,46 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) checkFromPluginList +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) checkFromPluginList () -

return bool decides the final visibility of the verifying from database and current OrgId

+\return \bool\ decides the final visibility of the verifying from database and current OrgId\ ## Implementation ```dart -bool checkFromPluginList() { - final UserConfig userConfig = locator(); +bool checkFromPluginList() \{ + final UserConfig userConfig = locator\(); final Box box; bool res = false; box = Hive.box('pluginBox'); var pluginList = box.get('plugins'); - pluginList ??= []; // if null then make it [] + pluginList ??= []; if null then make it [] - ///mapping over the list from the server + mapping over the list from the server pluginList .map( - (plugin) => { + (plugin) =\> \{ if (plugin["pluginName"] == pluginName) - { + \{ if (plugin["pluginInstallStatus"] as bool) - { + \{ res = plugin["pluginInstallStatus"] as bool || plugin["installedOrgs"] .contains(userConfig.currentOrg.id) as bool - } - } - }, + \} + \} + \}, ) .toList(); return res; -} +\} ``` diff --git a/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/child.md b/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/child.md index 35ec65b9131..833b72edb0a 100644 --- a/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/child.md +++ b/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/child.md @@ -9,13 +9,13 @@ -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html)? child +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html)? child -_final_ +_\final\_ -

child contains the widget for the plugin UI.

+\child contains the widget for the plugin UI.\ diff --git a/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/pluginName.md b/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/pluginName.md index 9825d89330a..377fd7ec60f 100644 --- a/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/pluginName.md +++ b/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/pluginName.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) pluginName +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) pluginName -_final_ +_\final\_ -

name of plugin preferred with underscores(_) instead of spaces

+\name of plugin preferred with underscores(_) instead of spaces\ diff --git a/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/visible.md b/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/visible.md index bacba07b8fe..0578373b377 100644 --- a/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/visible.md +++ b/docs/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/visible.md @@ -9,13 +9,13 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) visible +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) visible -_final_ +_\final\_ -

visible is the property that decides visibility of the UI.

+\visible is the property that decides visibility of the UI.\ diff --git a/docs/talawa-mobile-docs/router/generateRoute.md b/docs/talawa-mobile-docs/router/generateRoute.md index cdb9d89fbde..6658d54c93a 100644 --- a/docs/talawa-mobile-docs/router/generateRoute.md +++ b/docs/talawa-mobile-docs/router/generateRoute.md @@ -12,172 +12,172 @@ -[Route](https://api.flutter.dev/flutter/widgets/Route-class.html) generateRoute -([RouteSettings](https://api.flutter.dev/flutter/widgets/RouteSettings-class.html) settings) +[Route](https:api.flutter.dev/flutter/widgets/Route-class.html) generateRoute +([RouteSettings](https:api.flutter.dev/flutter/widgets/RouteSettings-class.html) settings) -

The MaterialApp provides us with a property called generateRoute where -we can pass in a Function that returns a Route and takes in RouteSettings

-

Thus for this purpose, we create a function named generateRoute

+\The MaterialApp provides us with a property called generateRoute where +we can pass in a Function that returns a Route\ and takes in RouteSettings\\ +\Thus for this purpose, we create a function named generateRoute\ ## Implementation ```dart -Route generateRoute(RouteSettings settings) { - // The settings contains the route information of the requested route. - // It provides two key things to us: the name, and the arguments. - // We use the name to determine which view to return. - switch (settings.name) { - // Returns the SplashScreen +Route\ generateRoute(RouteSettings settings) \{ + The settings contains the route information of the requested route. + It provides two key things to us: the name, and the arguments. + We use the name to determine which view to return. + switch (settings.name) \{ + Returns the SplashScreen case Routes.splashScreen: final int mainScreenIndex = settings.arguments! as int; return MaterialPageRoute( - builder: (context) => SplashScreen( + builder: (context) =\> SplashScreen( key: const Key('SplashScreen'), mainScreenIndex: mainScreenIndex, ), ); - // Returns the SelectLanguage Widget + Returns the SelectLanguage Widget case Routes.languageSelectionRoute: return MaterialPageRoute( - builder: (context) => const SelectLanguage(key: Key('SelectLanguage')), + builder: (context) =\> const SelectLanguage(key: Key('SelectLanguage')), ); - // Returns the SetUrl Widget + Returns the SetUrl Widget case Routes.setUrlScreen: final String uri = settings.arguments!.toString(); return MaterialPageRoute( - builder: (context) => SetUrl( + builder: (context) =\> SetUrl( key: const Key('SetUrl'), uri: uri, ), ); - // Returns the Login Widget + Returns the Login Widget case Routes.loginScreen: return MaterialPageRoute( - builder: (context) => const Login(key: Key('Login')), + builder: (context) =\> const Login(key: Key('Login')), ); - // Returns the SelectOrganization Widget + Returns the SelectOrganization Widget case Routes.selectOrgScreen: final String id = settings.arguments!.toString(); return CupertinoPageRoute( - builder: (context) => SelectOrganization( + builder: (context) =\> SelectOrganization( key: const Key('Signup'), selectedOrgId: id, ), ); - // Returns the SignUpDetails Widget + Returns the SignUpDetails Widget case Routes.signupDetailScreen: final OrgInfo org = settings.arguments! as OrgInfo; return CupertinoPageRoute( - builder: (context) => SignUpDetails( + builder: (context) =\> SignUpDetails( key: const Key('Signup'), selectedOrg: org, ), ); - // Returns the WaitingPge Widget + Returns the WaitingPge Widget case Routes.waitingScreen: return CupertinoPageRoute( - builder: (context) => const WaitingPage(key: Key('Waiting')), + builder: (context) =\> const WaitingPage(key: Key('Waiting')), ); - // Returns the Recover Widget + Returns the Recover Widget case Routes.recoverScreen: return MaterialPageRoute( - builder: (context) => const Recover(key: Key('Recover')), + builder: (context) =\> const Recover(key: Key('Recover')), ); - // Returns the ChangePass Widget + Returns the ChangePass Widget case Routes.updateScreen: return MaterialPageRoute( - builder: (context) => const ChangePass(key: Key('Update')), + builder: (context) =\> const ChangePass(key: Key('Update')), ); - // Returns the OrganizationFeed Widget + Returns the OrganizationFeed Widget case Routes.homeScreen: return MaterialPageRoute( - builder: (context) => const OrganizationFeed(key: Key('HomeScreen')), + builder: (context) =\> const OrganizationFeed(key: Key('HomeScreen')), ); - // Returns the MainScreen Widget + Returns the MainScreen Widget case Routes.mainScreen: final MainScreenArgs mainScreenArgs = settings.arguments! as MainScreenArgs; - // final bool fromSignUp = settings.arguments! as bool; + final bool fromSignUp = settings.arguments! as bool; return MaterialPageRoute( - builder: (context) => MainScreen( + builder: (context) =\> MainScreen( key: const Key('MainScreen'), mainScreenArgs: mainScreenArgs, ), ); - // Returns the IndividualPostView Widget + Returns the IndividualPostView Widget case Routes.individualPost: final Post post = settings.arguments! as Post; return MaterialPageRoute( - builder: (context) => IndividualPostView( + builder: (context) =\> IndividualPostView( key: const Key('IndividualPost'), post: post, ), ); - // Returns the PinnedPostPgae Widget + Returns the PinnedPostPgae Widget case Routes.pinnedPostPage: - final List pinnedPosts = settings.arguments! as List; + final List\ pinnedPosts = settings.arguments! as List\; return MaterialPageRoute( - builder: (context) => PinnedPostPage(pinnedPosts: pinnedPosts), + builder: (context) =\> PinnedPostPage(pinnedPosts: pinnedPosts), ); - // Returns the ExploreEvents Widget + Returns the ExploreEvents Widget case Routes.exploreEventsScreen: return MaterialPageRoute( - builder: (context) => const ExploreEvents(key: Key('ExploreEvents')), + builder: (context) =\> const ExploreEvents(key: Key('ExploreEvents')), ); - // Returns the EventInfoPage Widget + Returns the EventInfoPage Widget case Routes.eventInfoPage: - final Map args = - settings.arguments! as Map; + final Map\ args = + settings.arguments! as Map\; return MaterialPageRoute( - builder: (context) => EventInfoPage( + builder: (context) =\> EventInfoPage( key: const Key('EventInfo'), args: args, ), ); - // Returns the CreateEventPage Widget + Returns the CreateEventPage Widget case Routes.createEventPage: return MaterialPageRoute( - builder: (context) => const CreateEventPage(key: Key('CreateEvent')), + builder: (context) =\> const CreateEventPage(key: Key('CreateEvent')), ); - // Returns the ProfilePage Widget + Returns the ProfilePage Widget case Routes.profilePage: return MaterialPageRoute( - builder: (context) => const ProfilePage(key: Key('Profile')), + builder: (context) =\> const ProfilePage(key: Key('Profile')), ); - // Returns the EditProfilePage Widget + Returns the EditProfilePage Widget case Routes.editProfilePage: return MaterialPageRoute( - builder: (context) => const EditProfilePage(key: Key('EditProfile')), + builder: (context) =\> const EditProfilePage(key: Key('EditProfile')), ); - // Returns the JoinOrganizationAfterAuth Widget + Returns the JoinOrganizationAfterAuth Widget case Routes.joinOrg: final String id = settings.arguments!.toString(); return MaterialPageRoute( - builder: (context) => JoinOrganisationAfterAuth( + builder: (context) =\> JoinOrganisationAfterAuth( key: const Key('JoinOrganisationAfterAuth'), orgId: id, ), @@ -186,48 +186,48 @@ Route generateRoute(RouteSettings settings) { case Routes.requestAccess: final OrgInfo org = settings.arguments! as OrgInfo; return CupertinoPageRoute( - builder: (context) => SendAccessRequest( + builder: (context) =\> SendAccessRequest( key: const Key('Signup'), org: org, ), ); - // Returns the EditEventPage Widget + Returns the EditEventPage Widget case Routes.editEventPage: final Event event = settings.arguments! as Event; return MaterialPageRoute( - builder: (context) => EditEventPage( + builder: (context) =\> EditEventPage( key: const Key('EditEvent'), event: event, ), ); - // Returns the AppSettingsPage Widget + Returns the AppSettingsPage Widget case Routes.appSettings: return MaterialPageRoute( - builder: (context) => const AppSettingsPage(key: Key('AppSettings')), + builder: (context) =\> const AppSettingsPage(key: Key('AppSettings')), ); - // Returns the ChatMessageScreen Widget + Returns the ChatMessageScreen Widget case Routes.chatMessageScreen: - final List arguments = settings.arguments! as List; + final List\ arguments = settings.arguments! as List\; final String chatId = arguments[0] as String; final DirectChatViewModel model = arguments[1] as DirectChatViewModel; return MaterialPageRoute( - builder: (context) => ChatMessageScreen( + builder: (context) =\> ChatMessageScreen( key: const Key('ChatMessageScreen'), chatId: chatId, model: model, ), ); - // Returns the MapScreen Widget + Returns the MapScreen Widget case Routes.mapScreen: - final arguments = settings.arguments! as Map; + final arguments = settings.arguments! as Map\; final model = arguments['model'] as CreateEventViewModel?; final latitude = arguments['latitude'] as double; final longitude = arguments['longitude'] as double; return MaterialPageRoute( - builder: (context) => MapScreen( + builder: (context) =\> MapScreen( model, latitude, longitude, @@ -236,29 +236,29 @@ Route generateRoute(RouteSettings settings) { ); case Routes.calendar: return MaterialPageRoute( - builder: (context) => EventCalendar( - settings.arguments! as List, + builder: (context) =\> EventCalendar( + settings.arguments! as List\, key: const Key('Calendar'), ), ); case Routes.eventTasks: final eventId = settings.arguments! as String; return MaterialPageRoute( - builder: (context) => EventTasksPage( + builder: (context) =\> EventTasksPage( eventId: eventId, key: const Key('EventTasks'), ), ); case Routes.userTasks: return MaterialPageRoute( - builder: (context) => const UserTasksPage( + builder: (context) =\> const UserTasksPage( key: Key('UserTasks'), ), ); case Routes.addTask: final eventId = settings.arguments! as String; return MaterialPageRoute( - builder: (context) => CreateTaskPage( + builder: (context) =\> CreateTaskPage( key: const Key('AddTask'), eventId: eventId, ), @@ -266,24 +266,24 @@ Route generateRoute(RouteSettings settings) { case Routes.editTask: final task = settings.arguments! as Task; return MaterialPageRoute( - builder: (context) => EditTaskPage( + builder: (context) =\> EditTaskPage( key: const Key('EditTask'), task: task, ), ); - // Returns the DemoPageView Widget by default + Returns the DemoPageView Widget by default case Routes.selectContact: return MaterialPageRoute( - builder: (context) => const SelectContact(key: Key('selectContact')), + builder: (context) =\> const SelectContact(key: Key('selectContact')), ); default: return MaterialPageRoute( - builder: (context) => const DemoPageView( + builder: (context) =\> const DemoPageView( key: Key("DemoPage"), ), ); - } -} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/router/router-library.md b/docs/talawa-mobile-docs/router/router-library.md index c8ba8c929ab..d476d10900d 100644 --- a/docs/talawa-mobile-docs/router/router-library.md +++ b/docs/talawa-mobile-docs/router/router-library.md @@ -21,12 +21,12 @@ ## Functions -##### [generateRoute](../router/generateRoute.md)([RouteSettings](https://api.flutter.dev/flutter/widgets/RouteSettings-class.html) settings) [Route](https://api.flutter.dev/flutter/widgets/Route-class.html) +##### [generateRoute](../router/generateRoute.md)([RouteSettings](https:api.flutter.dev/flutter/widgets/RouteSettings-class.html) settings) [Route](https:api.flutter.dev/flutter/widgets/Route-class.html) The MaterialApp provides us with a property called generateRoute where -we can pass in a Function that returns a Route and takes in RouteSettings +we can pass in a Function that returns a Route\ and takes in RouteSettings\ diff --git a/docs/talawa-mobile-docs/services_chat_service/ChatService-class.md b/docs/talawa-mobile-docs/services_chat_service/ChatService-class.md index 1139306407a..50b6fa9c767 100644 --- a/docs/talawa-mobile-docs/services_chat_service/ChatService-class.md +++ b/docs/talawa-mobile-docs/services_chat_service/ChatService-class.md @@ -11,13 +11,13 @@ -

ChatService class provides different services for direct chats of the user.

-

Services include:

-
    -
  • sendMessageToDirectChat - used to send messages.
  • -
  • getDirectChatsByUserId - used to get all chats by the user.
  • -
  • getDirectChatMessagesByChatId - used to get all chats of a user with another user.
  • -
+\ChatService class provides different services for direct chats of the user.\ +\Services include:\ +\ +\\sendMessageToDirectChat\ - used to send messages.\ +\\getDirectChatsByUserId\ - used to get all chats by the user.\ +\\getDirectChatMessagesByChatId\ - used to get all chats of a user with another user.\ +\ @@ -31,48 +31,48 @@ ## Properties -##### [chatListStream](../services_chat_service/ChatService/chatListStream.md) → [Stream](https://api.flutter.dev/flutter/dart-async/Stream-class.html)<[ChatListTileDataModel](../models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md)> +##### [chatListStream](../services_chat_service/ChatService/chatListStream.md) → [Stream](https:api.flutter.dev/flutter/dart-async/Stream-class.html)<[ChatListTileDataModel](../models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md)\> -_read-only_ +_\read-only\_ -##### [chatMessagesStream](../services_chat_service/ChatService/chatMessagesStream.md) → [Stream](https://api.flutter.dev/flutter/dart-async/Stream-class.html)<[ChatMessage](../models_chats_chat_message/ChatMessage-class.md)> +##### [chatMessagesStream](../services_chat_service/ChatService/chatMessagesStream.md) → [Stream](https:api.flutter.dev/flutter/dart-async/Stream-class.html)<[ChatMessage](../models_chats_chat_message/ChatMessage-class.md)\> -_read-only_ +_\read-only\_ -##### [chatStream](../services_chat_service/ChatService/chatStream.md) ↔ [Stream](https://api.flutter.dev/flutter/dart-async/Stream-class.html)<[QueryResult](https://pub.dev/documentation/graphql/5.2.0-beta.4/graphql/QueryResult-class.html)<[Object](https://api.flutter.dev/flutter/dart-core/Object-class.html)?>> +##### [chatStream](../services_chat_service/ChatService/chatStream.md) ↔ [Stream](https:api.flutter.dev/flutter/dart-async/Stream-class.html)<[QueryResult](https:pub.dev/documentation/graphql/5.2.0-beta.4/graphql/QueryResult-class.html)<[Object](https:api.flutter.dev/flutter/dart-core/Object-class.html)?\>\> -_read / write_ +_\read / write\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -80,7 +80,7 @@ _read-onlyinherited_ ## Methods -##### [getDirectChatMessagesByChatId](../services_chat_service/ChatService/getDirectChatMessagesByChatId.md)(dynamic chatId) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [getDirectChatMessagesByChatId](../services_chat_service/ChatService/getDirectChatMessagesByChatId.md)(dynamic chatId) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -89,7 +89,7 @@ This function is used to get all the chat messages of a particular chat by the u -##### [getDirectChatsByUserId](../services_chat_service/ChatService/getDirectChatsByUserId.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [getDirectChatsByUserId](../services_chat_service/ChatService/getDirectChatsByUserId.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -98,16 +98,16 @@ This function is used to get all the chats by the user. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [sendMessageToDirectChat](../services_chat_service/ChatService/sendMessageToDirectChat.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) chatId, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) messageContent) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [sendMessageToDirectChat](../services_chat_service/ChatService/sendMessageToDirectChat.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) chatId, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) messageContent) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -116,12 +116,12 @@ This function is used to send the message in the direct chats. -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -129,12 +129,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/services_chat_service/ChatService/ChatService.md b/docs/talawa-mobile-docs/services_chat_service/ChatService/ChatService.md index 3dfdea61a54..116e640ccee 100644 --- a/docs/talawa-mobile-docs/services_chat_service/ChatService/ChatService.md +++ b/docs/talawa-mobile-docs/services_chat_service/ChatService/ChatService.md @@ -18,11 +18,11 @@ ChatService() ## Implementation ```dart -ChatService() { - _dbFunctions = locator(); +ChatService() \{ + _dbFunctions = locator\(); _chatListStream = _chatController.stream.asBroadcastStream(); _chatMessagesStream = _chatMessageController.stream.asBroadcastStream(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_chat_service/ChatService/chatListStream.md b/docs/talawa-mobile-docs/services_chat_service/ChatService/chatListStream.md index 2f7d5759eca..58053cd26ec 100644 --- a/docs/talawa-mobile-docs/services_chat_service/ChatService/chatListStream.md +++ b/docs/talawa-mobile-docs/services_chat_service/ChatService/chatListStream.md @@ -11,7 +11,7 @@ -[Stream](https://api.flutter.dev/flutter/dart-async/Stream-class.html)<[ChatListTileDataModel](../../models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md)> chatListStream +[Stream](https:api.flutter.dev/flutter/dart-async/Stream-class.html)<[ChatListTileDataModel](../../models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md)\> chatListStream @@ -23,7 +23,7 @@ ## Implementation ```dart -Stream get chatListStream => _chatListStream; +Stream\ get chatListStream =\> _chatListStream; ``` diff --git a/docs/talawa-mobile-docs/services_chat_service/ChatService/chatMessagesStream.md b/docs/talawa-mobile-docs/services_chat_service/ChatService/chatMessagesStream.md index 740897507a4..bec0848a608 100644 --- a/docs/talawa-mobile-docs/services_chat_service/ChatService/chatMessagesStream.md +++ b/docs/talawa-mobile-docs/services_chat_service/ChatService/chatMessagesStream.md @@ -11,7 +11,7 @@ -[Stream](https://api.flutter.dev/flutter/dart-async/Stream-class.html)<[ChatMessage](../../models_chats_chat_message/ChatMessage-class.md)> chatMessagesStream +[Stream](https:api.flutter.dev/flutter/dart-async/Stream-class.html)<[ChatMessage](../../models_chats_chat_message/ChatMessage-class.md)\> chatMessagesStream @@ -23,7 +23,7 @@ ## Implementation ```dart -Stream get chatMessagesStream => _chatMessagesStream; +Stream\ get chatMessagesStream =\> _chatMessagesStream; ``` diff --git a/docs/talawa-mobile-docs/services_chat_service/ChatService/chatStream.md b/docs/talawa-mobile-docs/services_chat_service/ChatService/chatStream.md index be41fbc55c7..993cb044bf5 100644 --- a/docs/talawa-mobile-docs/services_chat_service/ChatService/chatStream.md +++ b/docs/talawa-mobile-docs/services_chat_service/ChatService/chatStream.md @@ -9,9 +9,9 @@ -[Stream](https://api.flutter.dev/flutter/dart-async/Stream-class.html)<[QueryResult](https://pub.dev/documentation/graphql/5.2.0-beta.4/graphql/QueryResult-class.html)<[Object](https://api.flutter.dev/flutter/dart-core/Object-class.html)?>> chatStream +[Stream](https:api.flutter.dev/flutter/dart-async/Stream-class.html)<[QueryResult](https:pub.dev/documentation/graphql/5.2.0-beta.4/graphql/QueryResult-class.html)<[Object](https:api.flutter.dev/flutter/dart-core/Object-class.html)?\>\> chatStream -_read / write_ +_\read / write\_ @@ -21,7 +21,7 @@ _read / write_ ## Implementation ```dart -late Stream chatStream; +late Stream\ chatStream; ``` diff --git a/docs/talawa-mobile-docs/services_chat_service/ChatService/getDirectChatMessagesByChatId.md b/docs/talawa-mobile-docs/services_chat_service/ChatService/getDirectChatMessagesByChatId.md index bf6686a9cd4..e41002ae7f0 100644 --- a/docs/talawa-mobile-docs/services_chat_service/ChatService/getDirectChatMessagesByChatId.md +++ b/docs/talawa-mobile-docs/services_chat_service/ChatService/getDirectChatMessagesByChatId.md @@ -10,26 +10,26 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> getDirectChatMessagesByChatId +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> getDirectChatMessagesByChatId (dynamic chatId) -

This function is used to get all the chat messages of a particular chat by the user.

-

parameters required:

-
    -
  • chatId - id of the direct chat.
  • -
+\This function is used to get all the chat messages of a particular chat by the user.\ +\parameters required:\ +\ +\\chatId\ - id of the direct chat.\ +\ ## Implementation ```dart -Future getDirectChatMessagesByChatId(chatId) async { - // trigger graphQL query to get all the chat messages of a particular chat using [chatId]. +Future\ getDirectChatMessagesByChatId(chatId) async \{ + trigger graphQL query to get all the chat messages of a particular chat using [chatId]. final String query = ChatQueries().fetchDirectChatMessagesByChatId(chatId as String); @@ -37,11 +37,11 @@ Future getDirectChatMessagesByChatId(chatId) async { final messages = result.data['directChatsMessagesByChatID'] as List; - messages.forEach((message) { - final chatMessage = ChatMessage.fromJson(message as Map); + messages.forEach((message) \{ + final chatMessage = ChatMessage.fromJson(message as Map\); _chatMessageController.add(chatMessage); - }); -} + \}); +\} ``` diff --git a/docs/talawa-mobile-docs/services_chat_service/ChatService/getDirectChatsByUserId.md b/docs/talawa-mobile-docs/services_chat_service/ChatService/getDirectChatsByUserId.md index 0ae91a2aea1..5e11f305ff0 100644 --- a/docs/talawa-mobile-docs/services_chat_service/ChatService/getDirectChatsByUserId.md +++ b/docs/talawa-mobile-docs/services_chat_service/ChatService/getDirectChatsByUserId.md @@ -10,44 +10,44 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> getDirectChatsByUserId +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> getDirectChatsByUserId () -

This function is used to get all the chats by the user.

-

parameters required:

-
    -
  • usedId - current user id, to get all the direct chats associated with this id.
  • -
+\This function is used to get all the chats by the user.\ +\parameters required:\ +\ +\\usedId\ - current user id, to get all the direct chats associated with this id.\ +\ ## Implementation ```dart -Future getDirectChatsByUserId() async { +Future\ getDirectChatsByUserId() async \{ final userId = _userConfig.currentUser.id; - // trigger graphQL query to get all the chats of the user using [userId]. + trigger graphQL query to get all the chats of the user using [userId]. final String query = ChatQueries().fetchDirectChatsByUserId(userId!); final result = await _dbFunctions.gqlAuthQuery(query); final directMessageList = result.data['directChatsByUserID'] as List; - // loop through the result [directMessageList] and append the element to the directChat. - directMessageList.forEach((chat) { + loop through the result [directMessageList] and append the element to the directChat. + directMessageList.forEach((chat) \{ final directChat = - ChatListTileDataModel.fromJson(chat as Map); + ChatListTileDataModel.fromJson(chat as Map\); - directChat.users!.forEach((element) { + directChat.users!.forEach((element) \{ if (element.id != userId) _chatController.add(directChat); - }); - }); -} + \}); + \}); +\} ``` diff --git a/docs/talawa-mobile-docs/services_chat_service/ChatService/sendMessageToDirectChat.md b/docs/talawa-mobile-docs/services_chat_service/ChatService/sendMessageToDirectChat.md index 903348164f2..13cbf1c7198 100644 --- a/docs/talawa-mobile-docs/services_chat_service/ChatService/sendMessageToDirectChat.md +++ b/docs/talawa-mobile-docs/services_chat_service/ChatService/sendMessageToDirectChat.md @@ -10,43 +10,43 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> sendMessageToDirectChat -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) chatId, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) messageContent) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> sendMessageToDirectChat +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) chatId, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) messageContent) -

This function is used to send the message in the direct chats.

-

parameters required:

-
    -
  • chatId - id of the direct chat where message need to be send.
  • -
  • messageContent - the text that need to be send.
  • -
+\This function is used to send the message in the direct chats.\ +\parameters required:\ +\ +\\chatId\ - id of the direct chat where message need to be send.\ +\\messageContent\ - the text that need to be send.\ +\ ## Implementation ```dart -Future sendMessageToDirectChat( +Future\ sendMessageToDirectChat( String chatId, String messageContent, -) async { - // trigger graphQL mutation to push the message in the Database. +) async \{ + trigger graphQL mutation to push the message in the Database. final result = await _dbFunctions.gqlAuthMutation( ChatQueries().sendMessageToDirectChat(), - variables: {"chatId": chatId, "messageContent": messageContent}, + variables: \{"chatId": chatId, "messageContent": messageContent\}, ); final message = ChatMessage.fromJson( - result.data['sendMessageToDirectChat'] as Map, + result.data['sendMessageToDirectChat'] as Map\, ); _chatMessageController.add(message); debugPrint(result.data.toString()); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_comment_service/CommentService-class.md b/docs/talawa-mobile-docs/services_comment_service/CommentService-class.md index b3599d7f738..47679e7be64 100644 --- a/docs/talawa-mobile-docs/services_comment_service/CommentService-class.md +++ b/docs/talawa-mobile-docs/services_comment_service/CommentService-class.md @@ -11,12 +11,12 @@ -

CommentService class have different member functions which provides service in the context of commenting.

-

Services include:

-
    -
  • createComments - used to add comment on the post.
  • -
  • getCommentsForPost - used to get all comments on the post.
  • -
+\CommentService class have different member functions which provides service in the context of commenting.\ +\Services include:\ +\ +\\createComments\ - used to add comment on the post.\ +\\getCommentsForPost\ - used to get all comments on the post.\ +\ @@ -30,21 +30,21 @@ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -52,7 +52,7 @@ _read-onlyinherited_ ## Methods -##### [createComments](../services_comment_service/CommentService/createComments.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) postId, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) text) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [createComments](../services_comment_service/CommentService/createComments.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) postId, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) text) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -61,7 +61,7 @@ This function is used to add comment on the post. -##### [getCommentsForPost](../services_comment_service/CommentService/getCommentsForPost.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) postId) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) +##### [getCommentsForPost](../services_comment_service/CommentService/getCommentsForPost.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) postId) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) @@ -70,21 +70,21 @@ This function is used to fetch all comments on the post. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -92,12 +92,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/services_comment_service/CommentService/CommentService.md b/docs/talawa-mobile-docs/services_comment_service/CommentService/CommentService.md index c59a7cc7e16..beca1ed0974 100644 --- a/docs/talawa-mobile-docs/services_comment_service/CommentService/CommentService.md +++ b/docs/talawa-mobile-docs/services_comment_service/CommentService/CommentService.md @@ -18,9 +18,9 @@ CommentService() ## Implementation ```dart -CommentService() { - _dbFunctions = locator(); -} +CommentService() \{ + _dbFunctions = locator\(); +\} ``` diff --git a/docs/talawa-mobile-docs/services_comment_service/CommentService/createComments.md b/docs/talawa-mobile-docs/services_comment_service/CommentService/createComments.md index 741c7348c4b..a1334c0f4b6 100644 --- a/docs/talawa-mobile-docs/services_comment_service/CommentService/createComments.md +++ b/docs/talawa-mobile-docs/services_comment_service/CommentService/createComments.md @@ -10,39 +10,39 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> createComments -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) postId, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) text) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> createComments +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) postId, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) text) -

This function is used to add comment on the post.

-

parameters:

-
    -
  • postId - Post id where comment need to be added.
  • -
  • text - content of the comment.
  • -
+\This function is used to add comment on the post.\ +\parameters:\ +\ +\\postId\ - Post id where comment need to be added.\ +\\text\ - content of the comment.\ +\ ## Implementation ```dart -Future createComments(String postId, String text) async { +Future\ createComments(String postId, String text) async \{ print("comment service called"); final String createCommentQuery = CommentQueries().createComment(); final result = await _dbFunctions.gqlAuthMutation( createCommentQuery, - variables: { - 'postId': postId, //Add your variables here + variables: \{ + 'postId': postId, Add your variables here 'text': text - }, + \}, ); print("comment added"); print(result); return result; -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_comment_service/CommentService/getCommentsForPost.md b/docs/talawa-mobile-docs/services_comment_service/CommentService/getCommentsForPost.md index 956c67208c8..f7bab69ce6d 100644 --- a/docs/talawa-mobile-docs/services_comment_service/CommentService/getCommentsForPost.md +++ b/docs/talawa-mobile-docs/services_comment_service/CommentService/getCommentsForPost.md @@ -10,32 +10,32 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) getCommentsForPost -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) postId) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) getCommentsForPost +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) postId) -

This function is used to fetch all comments on the post.

-

parameters:

-
    -
  • postId - Post id for which comments need to be fetched.
  • -
+\This function is used to fetch all comments on the post.\ +\parameters:\ +\ +\\postId\ - Post id for which comments need to be fetched.\ +\ ## Implementation ```dart -Future getCommentsForPost(String postId) async { +Future getCommentsForPost(String postId) async \{ final String getCommmentQuery = CommentQueries().getPostsComments(postId); final result = await _dbFunctions.gqlAuthMutation(getCommmentQuery); - if (result.data != null) { + if (result.data != null) \{ return result.data["commentsByPost"] as List; - } + \} return []; -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions-class.md b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions-class.md index 90c047dce84..425f538343a 100644 --- a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions-class.md +++ b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions-class.md @@ -11,17 +11,17 @@ -

DataBaseMutationFunctions class provides different services that are under the context of graphQL mutations and queries.

-

Services include:

-
    -
  • encounteredExceptionOrError
  • -
  • gqlAuthQuery
  • -
  • gqlAuthMutation
  • -
  • gqlNonAuthMutation
  • -
  • gqlNonAuthQuery
  • -
  • refreshAccessToken
  • -
  • fetchOrgById
  • -
+\DataBaseMutationFunctions class provides different services that are under the context of graphQL mutations and queries.\ +\Services include:\ +\ +\\encounteredExceptionOrError\\ +\\gqlAuthQuery\\ +\\gqlAuthMutation\\ +\\gqlNonAuthMutation\\ +\\gqlNonAuthQuery\\ +\\refreshAccessToken\\ +\\fetchOrgById\\ +\ @@ -35,111 +35,111 @@ ## Properties -##### [clientAuth](../services_database_mutation_functions/DataBaseMutationFunctions/clientAuth.md) ↔ [GraphQLClient](https://pub.dev/documentation/graphql/5.2.0-beta.4/graphql/GraphQLClient-class.html) +##### [clientAuth](../services_database_mutation_functions/DataBaseMutationFunctions/clientAuth.md) ↔ [GraphQLClient](https:pub.dev/documentation/graphql/5.2.0-beta.4/graphql/GraphQLClient-class.html) Client Auth for handling authenticated request. -_read / write_ +_\read / write\_ -##### [clientNonAuth](../services_database_mutation_functions/DataBaseMutationFunctions/clientNonAuth.md) ↔ [GraphQLClient](https://pub.dev/documentation/graphql/5.2.0-beta.4/graphql/GraphQLClient-class.html) +##### [clientNonAuth](../services_database_mutation_functions/DataBaseMutationFunctions/clientNonAuth.md) ↔ [GraphQLClient](https:pub.dev/documentation/graphql/5.2.0-beta.4/graphql/GraphQLClient-class.html) Client Auth for handling non-authenticated request. -_read / write_ +_\read / write\_ -##### [emailAccountPresent](../services_database_mutation_functions/DataBaseMutationFunctions/emailAccountPresent.md) ↔ [GraphQLError](https://pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) +##### [emailAccountPresent](../services_database_mutation_functions/DataBaseMutationFunctions/emailAccountPresent.md) ↔ [GraphQLError](https:pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) Graphql error for handling. -_read / write_ +_\read / write\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [memberRequestExist](../services_database_mutation_functions/DataBaseMutationFunctions/memberRequestExist.md) ↔ [GraphQLError](https://pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) +##### [memberRequestExist](../services_database_mutation_functions/DataBaseMutationFunctions/memberRequestExist.md) ↔ [GraphQLError](https:pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) Graphql error for handling. -_read / write_ +_\read / write\_ -##### [notifFeatureNotInstalled](../services_database_mutation_functions/DataBaseMutationFunctions/notifFeatureNotInstalled.md) ↔ [GraphQLError](https://pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) +##### [notifFeatureNotInstalled](../services_database_mutation_functions/DataBaseMutationFunctions/notifFeatureNotInstalled.md) ↔ [GraphQLError](https:pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) Graphql error for handling. -_read / write_ +_\read / write\_ -##### [organizationNotFound](../services_database_mutation_functions/DataBaseMutationFunctions/organizationNotFound.md) ↔ [GraphQLError](https://pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) +##### [organizationNotFound](../services_database_mutation_functions/DataBaseMutationFunctions/organizationNotFound.md) ↔ [GraphQLError](https:pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) Graphql error for handling. -_read / write_ +_\read / write\_ -##### [refreshAccessTokenExpiredException](../services_database_mutation_functions/DataBaseMutationFunctions/refreshAccessTokenExpiredException.md) ↔ [GraphQLError](https://pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) +##### [refreshAccessTokenExpiredException](../services_database_mutation_functions/DataBaseMutationFunctions/refreshAccessTokenExpiredException.md) ↔ [GraphQLError](https:pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) Graphql error for handling. -_read / write_ +_\read / write\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [userNotAuthenticated](../services_database_mutation_functions/DataBaseMutationFunctions/userNotAuthenticated.md) ↔ [GraphQLError](https://pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) +##### [userNotAuthenticated](../services_database_mutation_functions/DataBaseMutationFunctions/userNotAuthenticated.md) ↔ [GraphQLError](https:pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) Graphql error for handling. -_read / write_ +_\read / write\_ -##### [userNotFound](../services_database_mutation_functions/DataBaseMutationFunctions/userNotFound.md) ↔ [GraphQLError](https://pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) +##### [userNotFound](../services_database_mutation_functions/DataBaseMutationFunctions/userNotFound.md) ↔ [GraphQLError](https:pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) Graphql error for handling. -_read / write_ +_\read / write\_ -##### [wrongCredentials](../services_database_mutation_functions/DataBaseMutationFunctions/wrongCredentials.md) ↔ [GraphQLError](https://pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) +##### [wrongCredentials](../services_database_mutation_functions/DataBaseMutationFunctions/wrongCredentials.md) ↔ [GraphQLError](https:pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) Graphql error for handling. -_read / write_ +_\read / write\_ @@ -147,25 +147,25 @@ _read / write_ ## Methods -##### [encounteredExceptionOrError](../services_database_mutation_functions/DataBaseMutationFunctions/encounteredExceptionOrError.md)([OperationException](https://pub.dev/documentation/graphql/5.2.0-beta.4/graphql/OperationException-class.html) exception, {[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) showSnackBar = true}) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? +##### [encounteredExceptionOrError](../services_database_mutation_functions/DataBaseMutationFunctions/encounteredExceptionOrError.md)([OperationException](https:pub.dev/documentation/graphql/5.2.0-beta.4/graphql/OperationException-class.html) exception, \{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) showSnackBar = true\}) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? -This function is used to check if any exceptions or error encountered. The return type is boolean. +This function is used to check if any exceptions or error encountered. The return type is \boolean\. -##### [fetchOrgById](../services_database_mutation_functions/DataBaseMutationFunctions/fetchOrgById.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) id) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) +##### [fetchOrgById](../services_database_mutation_functions/DataBaseMutationFunctions/fetchOrgById.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) id) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) -This function fetch the organization using the id passed. +This function fetch the organization using the \id\ passed. -##### [gqlAuthMutation](../services_database_mutation_functions/DataBaseMutationFunctions/gqlAuthMutation.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) mutation, {[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic>? variables}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) +##### [gqlAuthMutation](../services_database_mutation_functions/DataBaseMutationFunctions/gqlAuthMutation.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) mutation, \{[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>? variables\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) @@ -174,7 +174,7 @@ This function is used to run the graph-ql mutation for authenticated user. -##### [gqlAuthQuery](../services_database_mutation_functions/DataBaseMutationFunctions/gqlAuthQuery.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) query, {[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic>? variables}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) +##### [gqlAuthQuery](../services_database_mutation_functions/DataBaseMutationFunctions/gqlAuthQuery.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) query, \{[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>? variables\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) @@ -183,7 +183,7 @@ This function is used to run the graph-ql query for authentication. -##### [gqlNonAuthMutation](../services_database_mutation_functions/DataBaseMutationFunctions/gqlNonAuthMutation.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) mutation, {[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic>? variables, [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) reCall = true}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) +##### [gqlNonAuthMutation](../services_database_mutation_functions/DataBaseMutationFunctions/gqlNonAuthMutation.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) mutation, \{[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>? variables, [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) reCall = true\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) @@ -192,7 +192,7 @@ This function is used to run the graph-ql mutation to authenticate the non signe -##### [gqlNonAuthQuery](../services_database_mutation_functions/DataBaseMutationFunctions/gqlNonAuthQuery.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) query, {[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic>? variables}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[QueryResult](https://pub.dev/documentation/graphql/5.2.0-beta.4/graphql/QueryResult-class.html)<[Object](https://api.flutter.dev/flutter/dart-core/Object-class.html)?>?> +##### [gqlNonAuthQuery](../services_database_mutation_functions/DataBaseMutationFunctions/gqlNonAuthQuery.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) query, \{[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>? variables\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[QueryResult](https:pub.dev/documentation/graphql/5.2.0-beta.4/graphql/QueryResult-class.html)<[Object](https:api.flutter.dev/flutter/dart-core/Object-class.html)?\>?\> @@ -210,16 +210,16 @@ initialization function. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [refreshAccessToken](../services_database_mutation_functions/DataBaseMutationFunctions/refreshAccessToken.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) refreshToken) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)> +##### [refreshAccessToken](../services_database_mutation_functions/DataBaseMutationFunctions/refreshAccessToken.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) refreshToken) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)\> @@ -228,12 +228,12 @@ This function is used to refresh the Authenication token to access the applicati -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -241,12 +241,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/clientAuth.md b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/clientAuth.md index 4c673497f0d..fa6c126ad43 100644 --- a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/clientAuth.md +++ b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/clientAuth.md @@ -9,13 +9,13 @@ -[GraphQLClient](https://pub.dev/documentation/graphql/5.2.0-beta.4/graphql/GraphQLClient-class.html) clientAuth +[GraphQLClient](https:pub.dev/documentation/graphql/5.2.0-beta.4/graphql/GraphQLClient-class.html) clientAuth -_read / write_ +_\read / write\_ -

Client Auth for handling authenticated request.

+\Client Auth for handling authenticated request.\ diff --git a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/clientNonAuth.md b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/clientNonAuth.md index 4b73d5782f6..00725238cec 100644 --- a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/clientNonAuth.md +++ b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/clientNonAuth.md @@ -9,13 +9,13 @@ -[GraphQLClient](https://pub.dev/documentation/graphql/5.2.0-beta.4/graphql/GraphQLClient-class.html) clientNonAuth +[GraphQLClient](https:pub.dev/documentation/graphql/5.2.0-beta.4/graphql/GraphQLClient-class.html) clientNonAuth -_read / write_ +_\read / write\_ -

Client Auth for handling non-authenticated request.

+\Client Auth for handling non-authenticated request.\ diff --git a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/emailAccountPresent.md b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/emailAccountPresent.md index 62e143ed20d..d5facd0fe00 100644 --- a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/emailAccountPresent.md +++ b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/emailAccountPresent.md @@ -9,13 +9,13 @@ -[GraphQLError](https://pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) emailAccountPresent +[GraphQLError](https:pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) emailAccountPresent -_read / write_ +_\read / write\_ -

Graphql error for handling.

+\Graphql error for handling.\ diff --git a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/encounteredExceptionOrError.md b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/encounteredExceptionOrError.md index f08740a42b9..1d7bf281062 100644 --- a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/encounteredExceptionOrError.md +++ b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/encounteredExceptionOrError.md @@ -10,23 +10,23 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? encounteredExceptionOrError -([OperationException](https://pub.dev/documentation/graphql/5.2.0-beta.4/graphql/OperationException-class.html) exception, {[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) showSnackBar = true}) +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)? encounteredExceptionOrError +([OperationException](https:pub.dev/documentation/graphql/5.2.0-beta.4/graphql/OperationException-class.html) exception, \{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) showSnackBar = true\}) -

This function is used to check if any exceptions or error encountered. The return type is boolean.

-

params:

-
    -
  • exception: OperationException which occur when calling for graphql post request
  • -
  • showSnackBar: Tell if the the place where this function is called wants a SnackBar on error
  • -
-

returns:

-
    -
  • bool?: returns a bool whether or not their is error, can be null
  • -
+\This function is used to check if any exceptions or error encountered. The return type is \boolean\.\ +\\params\:\ +\ +\\exception\: OperationException which occur when calling for graphql post request\ +\\showSnackBar\: Tell if the the place where this function is called wants a SnackBar on error\ +\ +\\returns\:\ +\ +\\bool?\: returns a bool whether or not their is error, can be null\ +\ @@ -34,137 +34,137 @@ ```dart bool? encounteredExceptionOrError( - OperationException exception, { + OperationException exception, \{ bool showSnackBar = true, -}) { - // if server link is wrong. - if (exception.linkException != null) { - // debugPrint(exception.linkException.toString()); - if (showSnackBar) { +\}) \{ + if server link is wrong. + if (exception.linkException != null) \{ + debugPrint(exception.linkException.toString()); + if (showSnackBar) \{ WidgetsBinding.instance.addPostFrameCallback( - (_) => navigationService.showTalawaErrorSnackBar( + (_) =\> navigationService.showTalawaErrorSnackBar( "Server not running/wrong url", MessageType.info, ), ); - } + \} return false; - } + \} - /// looping through graphQL errors. + looping through graphQL errors. debugPrint(exception.graphqlErrors.toString()); - for (int i = 0; i < exception.graphqlErrors.length; i++) { - // if the error message is "Access Token has expired. Please refresh session.: Undefined location" + for (int i = 0; i \< exception.graphqlErrors.length; i++) \{ + if the error message is "Access Token has expired. Please refresh session.: Undefined location" if (exception.graphqlErrors[i].message == - refreshAccessTokenExpiredException.message) { + refreshAccessTokenExpiredException.message) \{ print('token refreshed'); refreshAccessToken(userConfig.currentUser.refreshToken!).then( - (value) => graphqlConfig + (value) =\> graphqlConfig .getToken() - .then((value) => databaseFunctions.init()), + .then((value) =\> databaseFunctions.init()), ); print('client refreshed'); return true; - } + \} - /// if the error message is "User is not authenticated" - if (exception.graphqlErrors[i].message == userNotAuthenticated.message) { + if the error message is "User is not authenticated" + if (exception.graphqlErrors[i].message == userNotAuthenticated.message) \{ print('client refreshed'); refreshAccessToken(userConfig.currentUser.refreshToken!).then( - (value) => graphqlConfig + (value) =\> graphqlConfig .getToken() - .then((value) => databaseFunctions.init()), + .then((value) =\> databaseFunctions.init()), ); return true; - } + \} - /// if the error message is "User not found" - if (exception.graphqlErrors[i].message == userNotFound.message) { - if (showSnackBar) { + if the error message is "User not found" + if (exception.graphqlErrors[i].message == userNotFound.message) \{ + if (showSnackBar) \{ WidgetsBinding.instance.addPostFrameCallback( - (_) => navigationService.showTalawaErrorDialog( + (_) =\> navigationService.showTalawaErrorDialog( "No account registered with this email", MessageType.error, ), ); - } + \} return false; - } + \} - /// if the error message is "Membership Request already exists" - if (exception.graphqlErrors[i].message == memberRequestExist.message) { - if (showSnackBar) { + if the error message is "Membership Request already exists" + if (exception.graphqlErrors[i].message == memberRequestExist.message) \{ + if (showSnackBar) \{ WidgetsBinding.instance.addPostFrameCallback( - (_) => navigationService.showTalawaErrorDialog( + (_) =\> navigationService.showTalawaErrorDialog( "Membership request already exist", MessageType.error, ), ); - } + \} return false; - } + \} - /// if the error message is "Invalid credentials" - if (exception.graphqlErrors[i].message == wrongCredentials.message) { - if (showSnackBar) { + if the error message is "Invalid credentials" + if (exception.graphqlErrors[i].message == wrongCredentials.message) \{ + if (showSnackBar) \{ WidgetsBinding.instance.addPostFrameCallback( - (_) => navigationService.showTalawaErrorDialog( + (_) =\> navigationService.showTalawaErrorDialog( "Enter a valid password", MessageType.error, ), ); - } + \} return false; - } + \} - /// if the error message is "Organization not found" - if (exception.graphqlErrors[i].message == organizationNotFound.message) { - if (showSnackBar) { + if the error message is "Organization not found" + if (exception.graphqlErrors[i].message == organizationNotFound.message) \{ + if (showSnackBar) \{ WidgetsBinding.instance.addPostFrameCallback( - (_) => navigationService.showTalawaErrorDialog( + (_) =\> navigationService.showTalawaErrorDialog( "Organization Not Found", MessageType.error, ), ); - } + \} return false; - } + \} - /// if the error message is "Email address already exists" - if (exception.graphqlErrors[i].message == emailAccountPresent.message) { - if (showSnackBar) { + if the error message is "Email address already exists" + if (exception.graphqlErrors[i].message == emailAccountPresent.message) \{ + if (showSnackBar) \{ WidgetsBinding.instance.addPostFrameCallback( - (_) => navigationService.showTalawaErrorDialog( + (_) =\> navigationService.showTalawaErrorDialog( "Account with this email already registered", MessageType.error, ), ); - } + \} return false; - } + \} if (exception.graphqlErrors[i].message == - notifFeatureNotInstalled.message) { - if (showSnackBar) { + notifFeatureNotInstalled.message) \{ + if (showSnackBar) \{ WidgetsBinding.instance.addPostFrameCallback( - (_) => navigationService.showTalawaErrorDialog( + (_) =\> navigationService.showTalawaErrorDialog( "Notification Feature is not installed", MessageType.error, ), ); - } + \} return false; - } - } - // if the error is unknown + \} + \} + if the error is unknown WidgetsBinding.instance.addPostFrameCallback( - (_) => navigationService.showTalawaErrorDialog( + (_) =\> navigationService.showTalawaErrorDialog( "Something went wrong!", MessageType.error, ), ); return false; -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/fetchOrgById.md b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/fetchOrgById.md index 8fb60f81959..03ab57f5436 100644 --- a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/fetchOrgById.md +++ b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/fetchOrgById.md @@ -10,46 +10,46 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) fetchOrgById -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) id) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) fetchOrgById +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) id) -

This function fetch the organization using the id passed.

-

params:

-
    -
  • id: id that identifies a particular org
  • -
-

returns:

-
    -
  • Future<dynamic>: it returns Future of dynamic
  • -
+\This function fetch the organization using the \id\ passed.\ +\\params\:\ +\ +\\id\: id that identifies a particular org\ +\ +\\returns\:\ +\ +\\Future<dynamic>\: it returns Future of dynamic\ +\ ## Implementation ```dart -Future fetchOrgById(String id) async { +Future\ fetchOrgById(String id) async \{ final QueryResult result = await clientNonAuth .mutate(MutationOptions(document: gql(_query.fetchOrgById(id)))); - // if there is an error or exception in [result] - if (result.hasException) { + if there is an error or exception in [result] + if (result.hasException) \{ final exception = encounteredExceptionOrError(result.exception!); - if (exception!) { + if (exception!) \{ fetchOrgById(id); - } - } else if (result.data != null && result.isConcrete) { + \} + \} else if (result.data != null && result.isConcrete) \{ return OrgInfo.fromJson( - // ignore: collection_methods_unrelated_type - (result.data!['organizations'] as Map)[0] - as Map, + ignore: collection_methods_unrelated_type + (result.data!['organizations'] as Map\)[0] + as Map\, ); - } + \} return false; -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlAuthMutation.md b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlAuthMutation.md index ea11a8fe957..9bdae7dc837 100644 --- a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlAuthMutation.md +++ b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlAuthMutation.md @@ -10,50 +10,50 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) gqlAuthMutation -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) mutation, {[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic>? variables}) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) gqlAuthMutation +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) mutation, \{[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>? variables\}) -

This function is used to run the graph-ql mutation for authenticated user.

-

params:

-
    -
  • mutation: mutation is used to change/add/delete data in graphql, for more info read graphql docs
  • -
  • variables: variables to be passed with mutation
  • -
-

returns:

-
    -
  • Future<dynamic>: it returns Future of dynamic
  • -
+\This function is used to run the graph-ql mutation for authenticated user.\ +\\params\:\ +\ +\\mutation\: mutation is used to change/add/delete data in graphql, for more info read graphql docs\ +\\variables\: variables to be passed with mutation\ +\ +\\returns\:\ +\ +\\Future<dynamic>\: it returns Future of dynamic\ +\ ## Implementation ```dart -Future gqlAuthMutation( - String mutation, { - Map? variables, -}) async { +Future\ gqlAuthMutation( + String mutation, \{ + Map\? variables, +\}) async \{ final QueryResult result = await clientAuth.mutate( MutationOptions( document: gql(mutation), - variables: variables ?? {}, + variables: variables ?? \\{\}, ), ); - // if there is an error or exception in [result] - if (result.hasException) { + if there is an error or exception in [result] + if (result.hasException) \{ final exception = encounteredExceptionOrError(result.exception!); - if (exception!) { + if (exception!) \{ gqlAuthMutation(mutation, variables: variables); - } - } else if (result.data != null && result.isConcrete) { + \} + \} else if (result.data != null && result.isConcrete) \{ return result; - } + \} return null; -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlAuthQuery.md b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlAuthQuery.md index a90ff7cf53f..d44dd38218a 100644 --- a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlAuthQuery.md +++ b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlAuthQuery.md @@ -10,49 +10,49 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) gqlAuthQuery -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) query, {[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic>? variables}) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) gqlAuthQuery +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) query, \{[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>? variables\}) -

This function is used to run the graph-ql query for authentication.

-

params:

-
    -
  • query: query is used to fetch data in graphql, for more info read graphql docs
  • -
  • variables: variables to be passed with query
  • -
-

returns:

-
    -
  • Future<dynamic>: it returns Future of dynamic
  • -
+\This function is used to run the graph-ql query for authentication.\ +\\params\:\ +\ +\\query\: query is used to fetch data in graphql, for more info read graphql docs\ +\\variables\: variables to be passed with query\ +\ +\\returns\:\ +\ +\\Future<dynamic>\: it returns Future of dynamic\ +\ ## Implementation ```dart -Future gqlAuthQuery( - String query, { - Map? variables, -}) async { +Future\ gqlAuthQuery( + String query, \{ + Map\? variables, +\}) async \{ final QueryOptions options = QueryOptions( document: gql(query), - variables: variables ?? {}, + variables: variables ?? \\{\}, ); final QueryResult result = await clientAuth.query(options); - // if there is an error or exception in [result] - if (result.hasException) { + if there is an error or exception in [result] + if (result.hasException) \{ final exception = encounteredExceptionOrError(result.exception!); - if (exception!) { + if (exception!) \{ gqlAuthQuery(query, variables: variables); - } - } else if (result.data != null && result.isConcrete) { + \} + \} else if (result.data != null && result.isConcrete) \{ return result; - } + \} return null; -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlNonAuthMutation.md b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlNonAuthMutation.md index 8791e72a23b..9fb05e02393 100644 --- a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlNonAuthMutation.md +++ b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlNonAuthMutation.md @@ -10,52 +10,52 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) gqlNonAuthMutation -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) mutation, {[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic>? variables, [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) reCall = true}) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) gqlNonAuthMutation +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) mutation, \{[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>? variables, [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) reCall = true\}) -

This function is used to run the graph-ql mutation to authenticate the non signed-in user.

-

params:

-
    -
  • mutation: mutation is used to change/add/delete data in graphql, for more info read graphql docs
  • -
  • variables: variables to be passed with mutation
  • -
  • reCall: when not first fetch call
  • -
-

returns:

-
    -
  • Future<dynamic>: it returns Future of dynamic
  • -
+\This function is used to run the graph-ql mutation to authenticate the non signed-in user.\ +\\params\:\ +\ +\\mutation\: mutation is used to change/add/delete data in graphql, for more info read graphql docs\ +\\variables\: variables to be passed with mutation\ +\\reCall\: when not first fetch call\ +\ +\\returns\:\ +\ +\\Future<dynamic>\: it returns Future of dynamic\ +\ ## Implementation ```dart -Future gqlNonAuthMutation( - String mutation, { - Map? variables, +Future\ gqlNonAuthMutation( + String mutation, \{ + Map\? variables, bool reCall = true, -}) async { +\}) async \{ final QueryResult result = await clientNonAuth.mutate( MutationOptions( document: gql(mutation), - variables: variables ?? {}, + variables: variables ?? \\{\}, ), ); - // if there is an error or exception in [result] - if (result.hasException) { + if there is an error or exception in [result] + if (result.hasException) \{ final exception = encounteredExceptionOrError(result.exception!); - if (exception! && reCall) { + if (exception! && reCall) \{ gqlNonAuthMutation(mutation, variables: variables); - } - } else if (result.data != null && result.isConcrete) { + \} + \} else if (result.data != null && result.isConcrete) \{ return result; - } + \} return null; -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlNonAuthQuery.md b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlNonAuthQuery.md index 6f2ac2bdf49..cb4e180b094 100644 --- a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlNonAuthQuery.md +++ b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlNonAuthQuery.md @@ -10,50 +10,50 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[QueryResult](https://pub.dev/documentation/graphql/5.2.0-beta.4/graphql/QueryResult-class.html)<[Object](https://api.flutter.dev/flutter/dart-core/Object-class.html)?>?> gqlNonAuthQuery -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) query, {[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic>? variables}) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[QueryResult](https:pub.dev/documentation/graphql/5.2.0-beta.4/graphql/QueryResult-class.html)<[Object](https:api.flutter.dev/flutter/dart-core/Object-class.html)?\>?\> gqlNonAuthQuery +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) query, \{[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>? variables\}) -

This function is used to run the graph-ql query for the non signed-in user.

-

params:

-
    -
  • query: query is used to fetch data in graphql, for more info read graphql docs
  • -
  • variables: variables to be passed with query
  • -
-

returns:

-
    -
  • Future<QueryResult<Object?>?>: it returns Future of QueryResult, contains all data
  • -
+\This function is used to run the graph-ql query for the non signed-in user.\ +\\params\:\ +\ +\\query\: query is used to fetch data in graphql, for more info read graphql docs\ +\\variables\: variables to be passed with query\ +\ +\\returns\:\ +\ +\\Future<QueryResult<Object?>?>\: it returns Future of QueryResult, contains all data\ +\ ## Implementation ```dart -Future?> gqlNonAuthQuery( - String query, { - Map? variables, -}) async { +Future\?\> gqlNonAuthQuery( + String query, \{ + Map\? variables, +\}) async \{ final queryOptions = QueryOptions( document: gql(query), - variables: variables ?? {}, + variables: variables ?? \\{\}, ); final result = await clientNonAuth.query(queryOptions); QueryResult? finalRes; - // if there is an error or exception in [result] - if (result.hasException) { + if there is an error or exception in [result] + if (result.hasException) \{ final exception = encounteredExceptionOrError(result.exception!); - if (exception!) { + if (exception!) \{ finalRes = await gqlNonAuthQuery(query, variables: variables); - } - } else if (result.data != null && result.isConcrete) { + \} + \} else if (result.data != null && result.isConcrete) \{ return result; - } + \} return finalRes; -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/init.md b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/init.md index c31b1aeb830..707a327acf6 100644 --- a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/init.md +++ b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/init.md @@ -17,22 +17,22 @@ void init -

initialization function.

-

params: - None

-

returns: - None

+\initialization function.\ +\\params\: + None\ +\\returns\: + None\ ## Implementation ```dart -void init() { +void init() \{ clientNonAuth = graphqlConfig.clientToQuery(); clientAuth = graphqlConfig.authClient(); _query = Queries(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/memberRequestExist.md b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/memberRequestExist.md index ec1aaa4f9a2..09511f7a8e8 100644 --- a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/memberRequestExist.md +++ b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/memberRequestExist.md @@ -9,13 +9,13 @@ -[GraphQLError](https://pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) memberRequestExist +[GraphQLError](https:pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) memberRequestExist -_read / write_ +_\read / write\_ -

Graphql error for handling.

+\Graphql error for handling.\ diff --git a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/notifFeatureNotInstalled.md b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/notifFeatureNotInstalled.md index 3047b0b2236..39af07011e2 100644 --- a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/notifFeatureNotInstalled.md +++ b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/notifFeatureNotInstalled.md @@ -9,13 +9,13 @@ -[GraphQLError](https://pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) notifFeatureNotInstalled +[GraphQLError](https:pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) notifFeatureNotInstalled -_read / write_ +_\read / write\_ -

Graphql error for handling.

+\Graphql error for handling.\ diff --git a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/organizationNotFound.md b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/organizationNotFound.md index 14aac023bf2..507c6229daa 100644 --- a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/organizationNotFound.md +++ b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/organizationNotFound.md @@ -9,13 +9,13 @@ -[GraphQLError](https://pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) organizationNotFound +[GraphQLError](https:pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) organizationNotFound -_read / write_ +_\read / write\_ -

Graphql error for handling.

+\Graphql error for handling.\ diff --git a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/refreshAccessToken.md b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/refreshAccessToken.md index b89af5e6463..3e281459735 100644 --- a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/refreshAccessToken.md +++ b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/refreshAccessToken.md @@ -10,30 +10,30 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)> refreshAccessToken -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) refreshToken) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)\> refreshAccessToken +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) refreshToken) -

This function is used to refresh the Authenication token to access the application.

-

params:

-
    -
  • refreshToken: Needed for authentication
  • -
-

returns:

-
    -
  • Future<bool>: it returns Future of dynamic
  • -
+\This function is used to refresh the Authenication token to access the application.\ +\\params\:\ +\ +\\refreshToken\: Needed for authentication\ +\ +\\returns\:\ +\ +\\Future<bool>\: it returns Future of dynamic\ +\ ## Implementation ```dart -Future refreshAccessToken(String refreshToken) async { - // run the graphQL mutation +Future\ refreshAccessToken(String refreshToken) async \{ + run the graphQL mutation final QueryResult result = await clientNonAuth.mutate( MutationOptions( document: gql( @@ -41,28 +41,28 @@ Future refreshAccessToken(String refreshToken) async { ), ), ); - // if there is an error or exception in [result] - if (result.hasException) { + if there is an error or exception in [result] + if (result.hasException) \{ final exception = encounteredExceptionOrError(result.exception!); - if (exception!) { + if (exception!) \{ refreshAccessToken(refreshToken); - } else { + \} else \{ navigationService.pop(); - } - } else if (result.data != null && result.isConcrete) { + \} + \} else if (result.data != null && result.isConcrete) \{ userConfig.updateAccessToken( refreshToken: (result.data!['refreshToken'] - as Map)['refreshToken'] + as Map\)['refreshToken'] .toString(), accessToken: (result.data!['refreshToken'] - as Map)['accessToken'] + as Map\)['accessToken'] .toString(), ); databaseFunctions.init(); return true; - } + \} return false; -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/refreshAccessTokenExpiredException.md b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/refreshAccessTokenExpiredException.md index 6a21805485a..9b7ab421aea 100644 --- a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/refreshAccessTokenExpiredException.md +++ b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/refreshAccessTokenExpiredException.md @@ -9,13 +9,13 @@ -[GraphQLError](https://pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) refreshAccessTokenExpiredException +[GraphQLError](https:pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) refreshAccessTokenExpiredException -_read / write_ +_\read / write\_ -

Graphql error for handling.

+\Graphql error for handling.\ diff --git a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/userNotAuthenticated.md b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/userNotAuthenticated.md index a812e0ddc06..d4f9c43ab53 100644 --- a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/userNotAuthenticated.md +++ b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/userNotAuthenticated.md @@ -9,13 +9,13 @@ -[GraphQLError](https://pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) userNotAuthenticated +[GraphQLError](https:pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) userNotAuthenticated -_read / write_ +_\read / write\_ -

Graphql error for handling.

+\Graphql error for handling.\ diff --git a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/userNotFound.md b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/userNotFound.md index 032289659a9..5210e679544 100644 --- a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/userNotFound.md +++ b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/userNotFound.md @@ -9,13 +9,13 @@ -[GraphQLError](https://pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) userNotFound +[GraphQLError](https:pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) userNotFound -_read / write_ +_\read / write\_ -

Graphql error for handling.

+\Graphql error for handling.\ diff --git a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/wrongCredentials.md b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/wrongCredentials.md index a0a4a26d5b6..50a6ce4fed9 100644 --- a/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/wrongCredentials.md +++ b/docs/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/wrongCredentials.md @@ -9,13 +9,13 @@ -[GraphQLError](https://pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) wrongCredentials +[GraphQLError](https:pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) wrongCredentials -_read / write_ +_\read / write\_ -

Graphql error for handling.

+\Graphql error for handling.\ diff --git a/docs/talawa-mobile-docs/services_event_service/EventService-class.md b/docs/talawa-mobile-docs/services_event_service/EventService-class.md index 7a9e701c0a5..9f2e7837bca 100644 --- a/docs/talawa-mobile-docs/services_event_service/EventService-class.md +++ b/docs/talawa-mobile-docs/services_event_service/EventService-class.md @@ -11,17 +11,17 @@ -

EventService class provides different services in the context of Event.

-

Services include:

-
    -
  • setOrgStreamSubscription : to set organization stream subscription for user.
  • -
  • getEvents : to get all events of the organization.
  • -
  • fetchRegistrantsByEvent : to fetch all registrants of an event.
  • -
  • registerForAnEvent : to register for an event.
  • -
  • deleteEvent : to delete an event.
  • -
  • editEvent : to edit the event.
  • -
  • dispose : to cancel the stream subscription of an organization.
  • -
+\EventService class provides different services in the context of Event.\ +\Services include:\ +\ +\\setOrgStreamSubscription\ : to set organization stream subscription for user.\ +\\getEvents\ : to get all events of the organization.\ +\\fetchRegistrantsByEvent\ : to fetch all registrants of an event.\ +\\registerForAnEvent\ : to register for an event.\ +\\deleteEvent\ : to delete an event.\ +\\editEvent\ : to edit the event.\ +\\dispose\ : to cancel the stream subscription of an organization.\ +\ @@ -35,30 +35,30 @@ ## Properties -##### [eventStream](../services_event_service/EventService/eventStream.md) → [Stream](https://api.flutter.dev/flutter/dart-async/Stream-class.html)<[Event](../models_events_event_model/Event-class.md)> +##### [eventStream](../services_event_service/EventService/eventStream.md) → [Stream](https:api.flutter.dev/flutter/dart-async/Stream-class.html)<[Event](../models_events_event_model/Event-class.md)\> The event stream. -_read-only_ +_\read-only\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -66,7 +66,7 @@ _read-onlyinherited_ ## Methods -##### [deleteEvent](../services_event_service/EventService/deleteEvent.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) +##### [deleteEvent](../services_event_service/EventService/deleteEvent.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) @@ -84,7 +84,7 @@ This function is used to cancel the stream subscription of an organization. -##### [editEvent](../services_event_service/EventService/editEvent.md)({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId, required [Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> variables}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [editEvent](../services_event_service/EventService/editEvent.md)(\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId, required [Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> variables\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -93,7 +93,7 @@ This function is used to edit an event. -##### [fetchRegistrantsByEvent](../services_event_service/EventService/fetchRegistrantsByEvent.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) +##### [fetchRegistrantsByEvent](../services_event_service/EventService/fetchRegistrantsByEvent.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) @@ -102,7 +102,7 @@ This function is used to fetch all registrants of an event. -##### [getEvents](../services_event_service/EventService/getEvents.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [getEvents](../services_event_service/EventService/getEvents.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -111,16 +111,16 @@ This function is used to fetch all the events of an organization. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [registerForAnEvent](../services_event_service/EventService/registerForAnEvent.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) +##### [registerForAnEvent](../services_event_service/EventService/registerForAnEvent.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) @@ -138,12 +138,12 @@ This function is used to set stream subscription for an organization. -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -151,12 +151,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/services_event_service/EventService/EventService.md b/docs/talawa-mobile-docs/services_event_service/EventService/EventService.md index 8d9d309765a..169075cd7e5 100644 --- a/docs/talawa-mobile-docs/services_event_service/EventService/EventService.md +++ b/docs/talawa-mobile-docs/services_event_service/EventService/EventService.md @@ -18,12 +18,12 @@ EventService() ## Implementation ```dart -EventService() { +EventService() \{ _eventStream = _eventStreamController.stream.asBroadcastStream(); _currentOrg = _userConfig.currentOrg; _userConfig.initialiseStream(); setOrgStreamSubscription(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_event_service/EventService/deleteEvent.md b/docs/talawa-mobile-docs/services_event_service/EventService/deleteEvent.md index 3c3c53776d7..180a196600b 100644 --- a/docs/talawa-mobile-docs/services_event_service/EventService/deleteEvent.md +++ b/docs/talawa-mobile-docs/services_event_service/EventService/deleteEvent.md @@ -10,29 +10,29 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) deleteEvent -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) deleteEvent +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId) -

This function is used to delete the event.

-

params:

-
    -
  • eventId: id of an event
  • -
-

returns:

-
    -
  • Future<dynamic>: Information about the event deletion
  • -
+\This function is used to delete the event.\ +\\params\:\ +\ +\\eventId\: id of an event\ +\ +\\returns\:\ +\ +\\Future<dynamic>\: Information about the event deletion\ +\ ## Implementation ```dart -Future deleteEvent(String eventId) async { +Future\ deleteEvent(String eventId) async \{ navigationService.pushDialog( const CustomProgressDialog(key: Key('DeleteEventProgress')), ); @@ -44,7 +44,7 @@ Future deleteEvent(String eventId) async { ); navigationService.pop(); return result; -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_event_service/EventService/dispose.md b/docs/talawa-mobile-docs/services_event_service/EventService/dispose.md index 5eb528fee85..3b8aa694a69 100644 --- a/docs/talawa-mobile-docs/services_event_service/EventService/dispose.md +++ b/docs/talawa-mobile-docs/services_event_service/EventService/dispose.md @@ -17,20 +17,20 @@ void dispose -

This function is used to cancel the stream subscription of an organization.

-

params: - None

-

returns: - None

+\This function is used to cancel the stream subscription of an organization.\ +\\params\: + None\ +\\returns\: + None\ ## Implementation ```dart -void dispose() { +void dispose() \{ _currentOrganizationStreamSubscription.cancel(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_event_service/EventService/editEvent.md b/docs/talawa-mobile-docs/services_event_service/EventService/editEvent.md index 51f6f640e58..a977be56cdc 100644 --- a/docs/talawa-mobile-docs/services_event_service/EventService/editEvent.md +++ b/docs/talawa-mobile-docs/services_event_service/EventService/editEvent.md @@ -10,33 +10,33 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> editEvent -({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId, required [Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> variables}) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> editEvent +(\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId, required [Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> variables\}) -

This function is used to edit an event.

-

params:

-
    -
  • eventId: id of an event
  • -
  • variables: this will be map type and contain all the event details need to be update.
  • -
-

returns:

-
    -
  • Future<void>: void return
  • -
+\This function is used to edit an event.\ +\\params\:\ +\ +\\eventId\: id of an event\ +\\variables\: this will be \map\ type and contain all the event details need to be update.\ +\ +\\returns\:\ +\ +\\Future<void>\: void return\ +\ ## Implementation ```dart -Future editEvent({ +Future\ editEvent(\{ required String eventId, - required Map variables, -}) async { + required Map\ variables, +\}) async \{ navigationService.pushDialog( const CustomProgressDialog( key: Key('EditEventProgress'), @@ -50,14 +50,14 @@ Future editEvent({ variables: variables, ); navigationService.pop(); - if (result != null) { + if (result != null) \{ navigationService.removeAllAndPush( Routes.exploreEventsScreen, Routes.mainScreen, arguments: MainScreenArgs(mainScreenIndex: 0, fromSignUp: false), ); - } -} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/services_event_service/EventService/eventStream.md b/docs/talawa-mobile-docs/services_event_service/EventService/eventStream.md index e243c838596..876b1131191 100644 --- a/docs/talawa-mobile-docs/services_event_service/EventService/eventStream.md +++ b/docs/talawa-mobile-docs/services_event_service/EventService/eventStream.md @@ -11,26 +11,26 @@ -[Stream](https://api.flutter.dev/flutter/dart-async/Stream-class.html)<[Event](../../models_events_event_model/Event-class.md)> eventStream +[Stream](https:api.flutter.dev/flutter/dart-async/Stream-class.html)<[Event](../../models_events_event_model/Event-class.md)\> eventStream -

The event stream.

-

params: +\The event stream.\ +\params: None -returns:

-
    -
  • Stream<Event>: returns the event stream
  • -
+returns:\ +\ +\\Stream<Event>\: returns the event stream\ +\ ## Implementation ```dart -Stream get eventStream => _eventStream; +Stream\ get eventStream =\> _eventStream; ``` diff --git a/docs/talawa-mobile-docs/services_event_service/EventService/fetchRegistrantsByEvent.md b/docs/talawa-mobile-docs/services_event_service/EventService/fetchRegistrantsByEvent.md index 5125946240e..029ffec9dd9 100644 --- a/docs/talawa-mobile-docs/services_event_service/EventService/fetchRegistrantsByEvent.md +++ b/docs/talawa-mobile-docs/services_event_service/EventService/fetchRegistrantsByEvent.md @@ -10,35 +10,35 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) fetchRegistrantsByEvent -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) fetchRegistrantsByEvent +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId) -

This function is used to fetch all registrants of an event.

-

params:

-
    -
  • eventId: id of an event.
  • -
-

returns:

-
    -
  • Future<dynamic>: Information about event registrants.
  • -
+\This function is used to fetch all registrants of an event.\ +\\params\:\ +\ +\\eventId\: id of an event.\ +\ +\\returns\:\ +\ +\\Future<dynamic>\: Information about event registrants.\ +\ ## Implementation ```dart -Future fetchRegistrantsByEvent(String eventId) async { +Future\ fetchRegistrantsByEvent(String eventId) async \{ await _dbFunctions.refreshAccessToken(userConfig.currentUser.refreshToken!); final result = await _dbFunctions.gqlAuthQuery( EventQueries().registrantsByEvent(eventId), ); return result; -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_event_service/EventService/getEvents.md b/docs/talawa-mobile-docs/services_event_service/EventService/getEvents.md index 031bd6276c0..b0f825ee38e 100644 --- a/docs/talawa-mobile-docs/services_event_service/EventService/getEvents.md +++ b/docs/talawa-mobile-docs/services_event_service/EventService/getEvents.md @@ -10,48 +10,48 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> getEvents +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> getEvents () -

This function is used to fetch all the events of an organization.

-

params: - None

-

returns:

-
    -
  • Future<void>: void
  • -
+\This function is used to fetch all the events of an organization.\ +\\params\: + None\ +\\returns\:\ +\ +\\Future<void>\: void\ +\ ## Implementation ```dart -Future getEvents() async { - // refresh user's access token +Future\ getEvents() async \{ + refresh user's access token await _dbFunctions.refreshAccessToken(userConfig.currentUser.refreshToken!); _dbFunctions.init(); - // get current organization id + get current organization id final String currentOrgID = _currentOrg.id!; - // mutation to fetch the events + mutation to fetch the events final String mutation = EventQueries().fetchOrgEvents(currentOrgID); final result = await _dbFunctions.gqlAuthMutation(mutation); if (result == null) return; final List eventsJson = result.data!["eventsByOrganization"] as List; - eventsJson.forEach((eventJsonData) { - final Event event = Event.fromJson(eventJsonData as Map); + eventsJson.forEach((eventJsonData) \{ + final Event event = Event.fromJson(eventJsonData as Map\); event.isRegistered = event.registrants?.any( - (registrant) => registrant.id == _userConfig.currentUser.id, + (registrant) =\> registrant.id == _userConfig.currentUser.id, ) ?? false; _eventStreamController.add(event); - }); -} + \}); +\} ``` diff --git a/docs/talawa-mobile-docs/services_event_service/EventService/registerForAnEvent.md b/docs/talawa-mobile-docs/services_event_service/EventService/registerForAnEvent.md index d0714cd5458..977fc2549cd 100644 --- a/docs/talawa-mobile-docs/services_event_service/EventService/registerForAnEvent.md +++ b/docs/talawa-mobile-docs/services_event_service/EventService/registerForAnEvent.md @@ -10,39 +10,39 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) registerForAnEvent -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) registerForAnEvent +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId) -

This function is used to register user for an event.

-

params:

-
    -
  • eventId: id of an event.
  • -
-

returns:

-
    -
  • Future<dynamic>: Information about the event registration.
  • -
+\This function is used to register user for an event.\ +\\params\:\ +\ +\\eventId\: id of an event.\ +\ +\\returns\:\ +\ +\\Future<dynamic>\: Information about the event registration.\ +\ ## Implementation ```dart -Future registerForAnEvent(String eventId) async { +Future\ registerForAnEvent(String eventId) async \{ final tokenResult = await _dbFunctions .refreshAccessToken(userConfig.currentUser.refreshToken!); debugPrint(tokenResult.toString()); - final Map variables = {'eventId': eventId}; + final Map\ variables = \{'eventId': eventId\}; final result = await _dbFunctions.gqlAuthMutation( EventQueries().registerForEvent(), variables: variables, ); return result; -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_event_service/EventService/setOrgStreamSubscription.md b/docs/talawa-mobile-docs/services_event_service/EventService/setOrgStreamSubscription.md index 3aae014067e..099d5764810 100644 --- a/docs/talawa-mobile-docs/services_event_service/EventService/setOrgStreamSubscription.md +++ b/docs/talawa-mobile-docs/services_event_service/EventService/setOrgStreamSubscription.md @@ -17,23 +17,23 @@ void setOrgStreamSubscription -

This function is used to set stream subscription for an organization.

-

params: - None

-

returns: - None

+\This function is used to set stream subscription for an organization.\ +\\params\: + None\ +\\returns\: + None\ ## Implementation ```dart -void setOrgStreamSubscription() { +void setOrgStreamSubscription() \{ _currentOrganizationStreamSubscription = - _userConfig.currentOrgInfoStream.listen((updatedOrganization) { + _userConfig.currentOrgInfoStream.listen((updatedOrganization) \{ _currentOrg = updatedOrganization; - }); -} + \}); +\} ``` diff --git a/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig-class.md b/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig-class.md index 9d5a105a259..8c8c6554a63 100644 --- a/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig-class.md +++ b/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig-class.md @@ -11,10 +11,10 @@ -

GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data. +\GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data. Talawa uses graphQL for the integrating with the API's. -You can go through talawa-api, here. -GraphqlConfig class provides service to configure graph ql API with talawa mobile-app.

+You can go through talawa-api, \here\. +GraphqlConfig class provides service to configure graph ql API with talawa mobile-app.\ @@ -28,48 +28,48 @@ GraphqlConfig class provides service to configure graph ql API with talawa mobil ## Properties -##### [displayImgRoute](../services_graphql_config/GraphqlConfig/displayImgRoute.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [displayImgRoute](../services_graphql_config/GraphqlConfig/displayImgRoute.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [httpLink](../services_graphql_config/GraphqlConfig/httpLink.md) ↔ [HttpLink](https://pub.dev/documentation/gql_http_link/1.0.1/gql_http_link/HttpLink-class.html) +##### [httpLink](../services_graphql_config/GraphqlConfig/httpLink.md) ↔ [HttpLink](https:pub.dev/documentation/gql_http_link/1.0.1/gql_http_link/HttpLink-class.html) -_read / write_ +_\read / write\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [webSocketLink](../services_graphql_config/GraphqlConfig/webSocketLink.md) ↔ [WebSocketLink](https://pub.dev/documentation/graphql/5.2.0-beta.4/graphql/WebSocketLink-class.html) +##### [webSocketLink](../services_graphql_config/GraphqlConfig/webSocketLink.md) ↔ [WebSocketLink](https:pub.dev/documentation/graphql/5.2.0-beta.4/graphql/WebSocketLink-class.html) -_read / write_ +_\read / write\_ @@ -77,7 +77,7 @@ _read / write_ ## Methods -##### [authClient](../services_graphql_config/GraphqlConfig/authClient.md)() [GraphQLClient](https://pub.dev/documentation/graphql/5.2.0-beta.4/graphql/GraphQLClient-class.html) +##### [authClient](../services_graphql_config/GraphqlConfig/authClient.md)() [GraphQLClient](https:pub.dev/documentation/graphql/5.2.0-beta.4/graphql/GraphQLClient-class.html) @@ -86,7 +86,7 @@ _read / write_ -##### [clientToQuery](../services_graphql_config/GraphqlConfig/clientToQuery.md)() [GraphQLClient](https://pub.dev/documentation/graphql/5.2.0-beta.4/graphql/GraphQLClient-class.html) +##### [clientToQuery](../services_graphql_config/GraphqlConfig/clientToQuery.md)() [GraphQLClient](https:pub.dev/documentation/graphql/5.2.0-beta.4/graphql/GraphQLClient-class.html) @@ -104,7 +104,7 @@ This function is used to get the organization URL. -##### [getToken](../services_graphql_config/GraphqlConfig/getToken.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) +##### [getToken](../services_graphql_config/GraphqlConfig/getToken.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) @@ -113,12 +113,12 @@ This function is used to get user the access token. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ @@ -131,12 +131,12 @@ _inherited_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -144,12 +144,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ @@ -157,21 +157,21 @@ _inherited_ ## Static Properties -##### [orgURI](../services_graphql_config/GraphqlConfig/orgURI.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [orgURI](../services_graphql_config/GraphqlConfig/orgURI.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [token](../services_graphql_config/GraphqlConfig/token.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [token](../services_graphql_config/GraphqlConfig/token.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ @@ -182,7 +182,7 @@ _read / write_ ## Constants -##### [imageUrlKey](../services_graphql_config/GraphqlConfig/imageUrlKey-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [imageUrlKey](../services_graphql_config/GraphqlConfig/imageUrlKey-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -191,7 +191,7 @@ _read / write_ -##### [urlKey](../services_graphql_config/GraphqlConfig/urlKey-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [urlKey](../services_graphql_config/GraphqlConfig/urlKey-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) diff --git a/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/authClient.md b/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/authClient.md index aaacdd3202e..69ce3a80d2a 100644 --- a/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/authClient.md +++ b/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/authClient.md @@ -10,7 +10,7 @@ -[GraphQLClient](https://pub.dev/documentation/graphql/5.2.0-beta.4/graphql/GraphQLClient-class.html) authClient +[GraphQLClient](https:pub.dev/documentation/graphql/5.2.0-beta.4/graphql/GraphQLClient-class.html) authClient () @@ -23,14 +23,14 @@ ## Implementation ```dart -GraphQLClient authClient() { - final AuthLink authLink = AuthLink(getToken: () async => 'Bearer $token'); +GraphQLClient authClient() \{ + final AuthLink authLink = AuthLink(getToken: () async =\> 'Bearer $token'); final Link finalAuthLink = authLink.concat(httpLink); return GraphQLClient( cache: GraphQLCache(partialDataPolicy: PartialDataCachePolicy.accept), link: finalAuthLink, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/clientToQuery.md b/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/clientToQuery.md index 25b35a9ac6f..49491c9eed3 100644 --- a/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/clientToQuery.md +++ b/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/clientToQuery.md @@ -10,7 +10,7 @@ -[GraphQLClient](https://pub.dev/documentation/graphql/5.2.0-beta.4/graphql/GraphQLClient-class.html) clientToQuery +[GraphQLClient](https:pub.dev/documentation/graphql/5.2.0-beta.4/graphql/GraphQLClient-class.html) clientToQuery () @@ -23,15 +23,15 @@ ## Implementation ```dart -GraphQLClient clientToQuery() { - //TODO: Implement websocket link from OrgUrl - // final link = Link.split( - // (request) => request.isSubscription, webSocketLink, httpLink); +GraphQLClient clientToQuery() \{ + TODO: Implement websocket link from OrgUrl + final link = Link.split( + (request) =\> request.isSubscription, webSocketLink, httpLink); return GraphQLClient( cache: GraphQLCache(partialDataPolicy: PartialDataCachePolicy.accept), link: httpLink, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/displayImgRoute.md b/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/displayImgRoute.md index 0f5ca852023..34a2a395572 100644 --- a/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/displayImgRoute.md +++ b/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/displayImgRoute.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? displayImgRoute +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? displayImgRoute -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/getOrgUrl.md b/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/getOrgUrl.md index fceac943c52..15b44b38d71 100644 --- a/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/getOrgUrl.md +++ b/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/getOrgUrl.md @@ -17,14 +17,14 @@ void getOrgUrl -

This function is used to get the organization URL.

+\This function is used to get the organization URL.\ ## Implementation ```dart -void getOrgUrl() { +void getOrgUrl() \{ final box = Hive.box('url'); final String? url = box.get(urlKey) as String?; final String? imgUrl = box.get(imageUrlKey) as String?; @@ -33,7 +33,7 @@ void getOrgUrl() { httpLink = HttpLink(orgURI!); clientToQuery(); authClient(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/getToken.md b/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/getToken.md index e2d6dda0da8..a95fa16c70c 100644 --- a/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/getToken.md +++ b/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/getToken.md @@ -10,26 +10,26 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) getToken +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) getToken () -

This function is used to get user the access token.

+\This function is used to get user the access token.\ ## Implementation ```dart -Future getToken() async { +Future getToken() async \{ final authToken = userConfig.currentUser.authToken; token = authToken; getOrgUrl(); return true; -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/httpLink.md b/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/httpLink.md index 763c7961232..bcaa89206e8 100644 --- a/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/httpLink.md +++ b/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/httpLink.md @@ -9,9 +9,9 @@ -[HttpLink](https://pub.dev/documentation/gql_http_link/1.0.1/gql_http_link/HttpLink-class.html) httpLink +[HttpLink](https:pub.dev/documentation/gql_http_link/1.0.1/gql_http_link/HttpLink-class.html) httpLink -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/imageUrlKey-constant.md b/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/imageUrlKey-constant.md index e12d339b1c0..263933f26e9 100644 --- a/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/imageUrlKey-constant.md +++ b/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/imageUrlKey-constant.md @@ -9,7 +9,7 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const imageUrlKey +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const imageUrlKey diff --git a/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/orgURI.md b/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/orgURI.md index 4c6dd02995e..6873b71acd8 100644 --- a/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/orgURI.md +++ b/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/orgURI.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? orgURI +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? orgURI -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/test.md b/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/test.md index 8b19dcfa4c9..635908c74a7 100644 --- a/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/test.md +++ b/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/test.md @@ -23,12 +23,12 @@ void test ## Implementation ```dart -void test() { +void test() \{ httpLink = HttpLink( - 'https://talawa-graphql-api.herokuapp.com/graphql', + 'https:talawa-graphql-api.herokuapp.com/graphql', httpClient: MockHttpClient(), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/token.md b/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/token.md index 16321bc2576..1f9ea2e4b94 100644 --- a/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/token.md +++ b/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/token.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? token +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? token -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/urlKey-constant.md b/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/urlKey-constant.md index d90752c5987..338c6e839fe 100644 --- a/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/urlKey-constant.md +++ b/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/urlKey-constant.md @@ -9,7 +9,7 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const urlKey +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const urlKey diff --git a/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/webSocketLink.md b/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/webSocketLink.md index 1284f5e825e..e5eda8b8306 100644 --- a/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/webSocketLink.md +++ b/docs/talawa-mobile-docs/services_graphql_config/GraphqlConfig/webSocketLink.md @@ -9,9 +9,9 @@ -[WebSocketLink](https://pub.dev/documentation/graphql/5.2.0-beta.4/graphql/WebSocketLink-class.html) webSocketLink +[WebSocketLink](https:pub.dev/documentation/graphql/5.2.0-beta.4/graphql/WebSocketLink-class.html) webSocketLink -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/services_graphql_config/MockHttpClient-class.md b/docs/talawa-mobile-docs/services_graphql_config/MockHttpClient-class.md index 44dbf595713..9299ae44dfd 100644 --- a/docs/talawa-mobile-docs/services_graphql_config/MockHttpClient-class.md +++ b/docs/talawa-mobile-docs/services_graphql_config/MockHttpClient-class.md @@ -11,19 +11,19 @@ -

A mock HTTP client designed for use when testing code that uses BaseClient.

+\A mock HTTP client designed for use when testing code that uses BaseClient.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [Mock](https://pub.dev/documentation/mockito/5.4.0/mockito/Mock-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [Mock](https:pub.dev/documentation/mockito/5.4.0/mockito/Mock-class.html) - MockHttpClient **Implemented types** -- [Client](https://pub.dev/documentation/http/0.13.6/http/Client-class.html) +- [Client](https:pub.dev/documentation/http/0.13.6/http/Client-class.html) @@ -40,21 +40,21 @@ ## Properties -##### [hashCode](https://pub.dev/documentation/mockito/5.4.0/mockito/Mock/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:pub.dev/documentation/mockito/5.4.0/mockito/Mock/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -62,117 +62,117 @@ _read-onlyinherited_ ## Methods -##### [close](https://pub.dev/documentation/http/0.13.6/http/Client/close.html)() void +##### [close](https:pub.dev/documentation/http/0.13.6/http/Client/close.html)() void Closes the client and cleans up any resources associated with it. -_inherited_ +_\inherited\_ -##### [delete](https://pub.dev/documentation/http/0.13.6/http/Client/delete.html)([Uri](https://api.flutter.dev/flutter/dart-core/Uri-class.html) url, {[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), [String](https://api.flutter.dev/flutter/dart-core/String-class.html)>? headers, [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html)? body, [Encoding](https://api.flutter.dev/flutter/dart-convert/Encoding-class.html)? encoding}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[Response](https://pub.dev/documentation/http/0.13.6/http/Response-class.html)> +##### [delete](https:pub.dev/documentation/http/0.13.6/http/Client/delete.html)([Uri](https:api.flutter.dev/flutter/dart-core/Uri-class.html) url, \{[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), [String](https:api.flutter.dev/flutter/dart-core/String-class.html)\>? headers, [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html)? body, [Encoding](https:api.flutter.dev/flutter/dart-convert/Encoding-class.html)? encoding\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[Response](https:pub.dev/documentation/http/0.13.6/http/Response-class.html)\> Sends an HTTP DELETE request with the given headers to the given URL. -_inherited_ +_\inherited\_ -##### [get](https://pub.dev/documentation/http/0.13.6/http/Client/get.html)([Uri](https://api.flutter.dev/flutter/dart-core/Uri-class.html) url, {[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), [String](https://api.flutter.dev/flutter/dart-core/String-class.html)>? headers}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[Response](https://pub.dev/documentation/http/0.13.6/http/Response-class.html)> +##### [get](https:pub.dev/documentation/http/0.13.6/http/Client/get.html)([Uri](https:api.flutter.dev/flutter/dart-core/Uri-class.html) url, \{[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), [String](https:api.flutter.dev/flutter/dart-core/String-class.html)\>? headers\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[Response](https:pub.dev/documentation/http/0.13.6/http/Response-class.html)\> Sends an HTTP GET request with the given headers to the given URL. -_inherited_ +_\inherited\_ -##### [head](https://pub.dev/documentation/http/0.13.6/http/Client/head.html)([Uri](https://api.flutter.dev/flutter/dart-core/Uri-class.html) url, {[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), [String](https://api.flutter.dev/flutter/dart-core/String-class.html)>? headers}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[Response](https://pub.dev/documentation/http/0.13.6/http/Response-class.html)> +##### [head](https:pub.dev/documentation/http/0.13.6/http/Client/head.html)([Uri](https:api.flutter.dev/flutter/dart-core/Uri-class.html) url, \{[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), [String](https:api.flutter.dev/flutter/dart-core/String-class.html)\>? headers\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[Response](https:pub.dev/documentation/http/0.13.6/http/Response-class.html)\> Sends an HTTP HEAD request with the given headers to the given URL. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://pub.dev/documentation/mockito/5.4.0/mockito/Mock/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation, {[Object](https://api.flutter.dev/flutter/dart-core/Object-class.html)? returnValue, [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html)? returnValueForMissingStub = deferToDefaultResponse}) dynamic +##### [noSuchMethod](https:pub.dev/documentation/mockito/5.4.0/mockito/Mock/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation, \{[Object](https:api.flutter.dev/flutter/dart-core/Object-class.html)? returnValue, [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html)? returnValueForMissingStub = deferToDefaultResponse\}) dynamic Handles method stubbing, method call verification, and real method calls. -_inherited_ +_\inherited\_ -##### [patch](https://pub.dev/documentation/http/0.13.6/http/Client/patch.html)([Uri](https://api.flutter.dev/flutter/dart-core/Uri-class.html) url, {[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), [String](https://api.flutter.dev/flutter/dart-core/String-class.html)>? headers, [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html)? body, [Encoding](https://api.flutter.dev/flutter/dart-convert/Encoding-class.html)? encoding}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[Response](https://pub.dev/documentation/http/0.13.6/http/Response-class.html)> +##### [patch](https:pub.dev/documentation/http/0.13.6/http/Client/patch.html)([Uri](https:api.flutter.dev/flutter/dart-core/Uri-class.html) url, \{[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), [String](https:api.flutter.dev/flutter/dart-core/String-class.html)\>? headers, [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html)? body, [Encoding](https:api.flutter.dev/flutter/dart-convert/Encoding-class.html)? encoding\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[Response](https:pub.dev/documentation/http/0.13.6/http/Response-class.html)\> Sends an HTTP PATCH request with the given headers and body to the given URL. -_inherited_ +_\inherited\_ -##### [post](https://pub.dev/documentation/http/0.13.6/http/Client/post.html)([Uri](https://api.flutter.dev/flutter/dart-core/Uri-class.html) url, {[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), [String](https://api.flutter.dev/flutter/dart-core/String-class.html)>? headers, [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html)? body, [Encoding](https://api.flutter.dev/flutter/dart-convert/Encoding-class.html)? encoding}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[Response](https://pub.dev/documentation/http/0.13.6/http/Response-class.html)> +##### [post](https:pub.dev/documentation/http/0.13.6/http/Client/post.html)([Uri](https:api.flutter.dev/flutter/dart-core/Uri-class.html) url, \{[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), [String](https:api.flutter.dev/flutter/dart-core/String-class.html)\>? headers, [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html)? body, [Encoding](https:api.flutter.dev/flutter/dart-convert/Encoding-class.html)? encoding\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[Response](https:pub.dev/documentation/http/0.13.6/http/Response-class.html)\> Sends an HTTP POST request with the given headers and body to the given URL. -_inherited_ +_\inherited\_ -##### [put](https://pub.dev/documentation/http/0.13.6/http/Client/put.html)([Uri](https://api.flutter.dev/flutter/dart-core/Uri-class.html) url, {[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), [String](https://api.flutter.dev/flutter/dart-core/String-class.html)>? headers, [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html)? body, [Encoding](https://api.flutter.dev/flutter/dart-convert/Encoding-class.html)? encoding}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[Response](https://pub.dev/documentation/http/0.13.6/http/Response-class.html)> +##### [put](https:pub.dev/documentation/http/0.13.6/http/Client/put.html)([Uri](https:api.flutter.dev/flutter/dart-core/Uri-class.html) url, \{[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), [String](https:api.flutter.dev/flutter/dart-core/String-class.html)\>? headers, [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html)? body, [Encoding](https:api.flutter.dev/flutter/dart-convert/Encoding-class.html)? encoding\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[Response](https:pub.dev/documentation/http/0.13.6/http/Response-class.html)\> Sends an HTTP PUT request with the given headers and body to the given URL. -_inherited_ +_\inherited\_ -##### [read](https://pub.dev/documentation/http/0.13.6/http/Client/read.html)([Uri](https://api.flutter.dev/flutter/dart-core/Uri-class.html) url, {[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), [String](https://api.flutter.dev/flutter/dart-core/String-class.html)>? headers}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html)> +##### [read](https:pub.dev/documentation/http/0.13.6/http/Client/read.html)([Uri](https:api.flutter.dev/flutter/dart-core/Uri-class.html) url, \{[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), [String](https:api.flutter.dev/flutter/dart-core/String-class.html)\>? headers\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html)\> Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a String. -_inherited_ +_\inherited\_ -##### [readBytes](https://pub.dev/documentation/http/0.13.6/http/Client/readBytes.html)([Uri](https://api.flutter.dev/flutter/dart-core/Uri-class.html) url, {[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), [String](https://api.flutter.dev/flutter/dart-core/String-class.html)>? headers}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[Uint8List](https://api.flutter.dev/flutter/dart-typed_data/Uint8List-class.html)> +##### [readBytes](https:pub.dev/documentation/http/0.13.6/http/Client/readBytes.html)([Uri](https:api.flutter.dev/flutter/dart-core/Uri-class.html) url, \{[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), [String](https:api.flutter.dev/flutter/dart-core/String-class.html)\>? headers\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[Uint8List](https:api.flutter.dev/flutter/dart-typed_data/Uint8List-class.html)\> Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a list of bytes. -_inherited_ +_\inherited\_ -##### [send](../services_graphql_config/MockHttpClient/send.md)([BaseRequest](https://pub.dev/documentation/http/0.13.6/http/BaseRequest-class.html)? request) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[StreamedResponse](https://pub.dev/documentation/http/0.13.6/http/StreamedResponse-class.html)> +##### [send](../services_graphql_config/MockHttpClient/send.md)([BaseRequest](https:pub.dev/documentation/http/0.13.6/http/BaseRequest-class.html)? request) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[StreamedResponse](https:pub.dev/documentation/http/0.13.6/http/StreamedResponse-class.html)\> Sends an HTTP request and asynchronously returns the response. -_override_ +_\override\_ -##### [toString](https://pub.dev/documentation/mockito/5.4.0/mockito/Mock/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:pub.dev/documentation/mockito/5.4.0/mockito/Mock/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -180,12 +180,12 @@ _inherited_ ## Operators -##### [operator ==](https://pub.dev/documentation/mockito/5.4.0/mockito/Mock/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:pub.dev/documentation/mockito/5.4.0/mockito/Mock/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/services_graphql_config/MockHttpClient/send.md b/docs/talawa-mobile-docs/services_graphql_config/MockHttpClient/send.md index d2358b9041a..50c3ebfe8ce 100644 --- a/docs/talawa-mobile-docs/services_graphql_config/MockHttpClient/send.md +++ b/docs/talawa-mobile-docs/services_graphql_config/MockHttpClient/send.md @@ -9,16 +9,16 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[StreamedResponse](https://pub.dev/documentation/http/0.13.6/http/StreamedResponse-class.html)> send -([BaseRequest](https://pub.dev/documentation/http/0.13.6/http/BaseRequest-class.html)? request) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[StreamedResponse](https:pub.dev/documentation/http/0.13.6/http/StreamedResponse-class.html)\> send +([BaseRequest](https:pub.dev/documentation/http/0.13.6/http/BaseRequest-class.html)? request) -_override_ +_\override\_ -

Sends an HTTP request and asynchronously returns the response.

+\Sends an HTTP request and asynchronously returns the response.\ @@ -26,17 +26,17 @@ _override_ ```dart @override -Future send(http.BaseRequest? request) => - // ignore: invalid_use_of_visible_for_testing_member +Future\ send(http.BaseRequest? request) =\> + ignore: invalid_use_of_visible_for_testing_member super.noSuchMethod( Invocation.method(#send, [request]), returnValue: Future.value( http.StreamedResponse( - Stream.fromIterable(const [[]]), + Stream.fromIterable(const [\[]]), 500, ), ), - ) as Future; + ) as Future\; ``` diff --git a/docs/talawa-mobile-docs/services_graphql_config/services_graphql_config-library.md b/docs/talawa-mobile-docs/services_graphql_config/services_graphql_config-library.md index ddc74cda14e..d993c02aed8 100644 --- a/docs/talawa-mobile-docs/services_graphql_config/services_graphql_config-library.md +++ b/docs/talawa-mobile-docs/services_graphql_config/services_graphql_config-library.md @@ -22,7 +22,7 @@ GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data. Talawa uses graphQL for the integrating with the API's. -You can go through talawa-api,
here. +You can go through talawa-api, \here\. GraphqlConfig class provides service to configure graph ql API with talawa mobile-app. diff --git a/docs/talawa-mobile-docs/services_navigation_service/NavigationService-class.md b/docs/talawa-mobile-docs/services_navigation_service/NavigationService-class.md index 5485dfc4e0d..85cc37ecaa5 100644 --- a/docs/talawa-mobile-docs/services_navigation_service/NavigationService-class.md +++ b/docs/talawa-mobile-docs/services_navigation_service/NavigationService-class.md @@ -11,19 +11,19 @@ -

NavigationService class provides different functions as service in the context of navigation.

-

Services include:

-
    -
  • pushScreen
  • -
  • popAndPushScreen
  • -
  • pushReplacementScreen
  • -
  • removeAllAndPush
  • -
  • showSnackBar
  • -
  • pushDialog
  • -
  • showTalawaErrorWidget
  • -
  • showTalawaErrorDialog
  • -
  • pop
  • -
+\NavigationService class provides different functions as service in the context of navigation.\ +\Services include:\ +\ +\\pushScreen\\ +\\popAndPushScreen\\ +\\pushReplacementScreen\\ +\\removeAllAndPush\\ +\\showSnackBar\\ +\\pushDialog\\ +\\showTalawaErrorWidget\\ +\\showTalawaErrorDialog\\ +\\pop\\ +\ @@ -37,30 +37,30 @@ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [navigatorKey](../services_navigation_service/NavigationService/navigatorKey.md) ↔ [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[NavigatorState](https://api.flutter.dev/flutter/widgets/NavigatorState-class.html)> +##### [navigatorKey](../services_navigation_service/NavigationService/navigatorKey.md) ↔ [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[NavigatorState](https:api.flutter.dev/flutter/widgets/NavigatorState-class.html)\> -_read / write_ +_\read / write\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -68,7 +68,7 @@ _read-onlyinherited_ ## Methods -##### [fromInviteLink](../services_navigation_service/NavigationService/fromInviteLink.md)([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html)> routeNames, [List](https://api.flutter.dev/flutter/dart-core/List-class.html) arguments) void +##### [fromInviteLink](../services_navigation_service/NavigationService/fromInviteLink.md)([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html)\> routeNames, [List](https:api.flutter.dev/flutter/dart-core/List-class.html) arguments) void @@ -77,12 +77,12 @@ _read-onlyinherited_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ @@ -95,7 +95,7 @@ This function pops the current state. -##### [popAndPushScreen](../services_navigation_service/NavigationService/popAndPushScreen.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) routeName, {dynamic arguments}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) +##### [popAndPushScreen](../services_navigation_service/NavigationService/popAndPushScreen.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) routeName, \{dynamic arguments\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) @@ -104,7 +104,7 @@ This function pop the initial route and push the new route to the navigator. -##### [pushDialog](../services_navigation_service/NavigationService/pushDialog.md)([Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) dialog) void +##### [pushDialog](../services_navigation_service/NavigationService/pushDialog.md)([Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) dialog) void @@ -113,7 +113,7 @@ This function is used to show the custom Dialog. -##### [pushReplacementScreen](../services_navigation_service/NavigationService/pushReplacementScreen.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) routeName, {dynamic arguments}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) +##### [pushReplacementScreen](../services_navigation_service/NavigationService/pushReplacementScreen.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) routeName, \{dynamic arguments\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) @@ -122,7 +122,7 @@ This function push the route and replace the screen. -##### [pushScreen](../services_navigation_service/NavigationService/pushScreen.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) routeName, {dynamic arguments}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) +##### [pushScreen](../services_navigation_service/NavigationService/pushScreen.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) routeName, \{dynamic arguments\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) @@ -131,7 +131,7 @@ This function push the route to the navigator. -##### [removeAllAndPush](../services_navigation_service/NavigationService/removeAllAndPush.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) routeName, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) tillRoute, {dynamic arguments}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) +##### [removeAllAndPush](../services_navigation_service/NavigationService/removeAllAndPush.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) routeName, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) tillRoute, \{dynamic arguments\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) @@ -140,16 +140,16 @@ This function remove all the routes till the particular route and add new route. -##### [showSnackBar](../services_navigation_service/NavigationService/showSnackBar.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) message, {[Duration](https://api.flutter.dev/flutter/dart-core/Duration-class.html) duration = const Duration(seconds: 2)}) void +##### [showSnackBar](../services_navigation_service/NavigationService/showSnackBar.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) message, \{[Duration](https:api.flutter.dev/flutter/dart-core/Duration-class.html) duration = const Duration(seconds: 2)\}) void -This is used for the quick alert of duration: 2 seconds with text message(passed). +This is used for the quick alert of \duration: 2 seconds\ with text message(passed). -##### [showTalawaErrorDialog](../services_navigation_service/NavigationService/showTalawaErrorDialog.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) errorMessage, [MessageType](../enums_enums/MessageType.md) messageType) void +##### [showTalawaErrorDialog](../services_navigation_service/NavigationService/showTalawaErrorDialog.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) errorMessage, [MessageType](../enums_enums/MessageType.md) messageType) void @@ -158,7 +158,7 @@ This is used for the quick alert of duration: 2 seconds with text m -##### [showTalawaErrorSnackBar](../services_navigation_service/NavigationService/showTalawaErrorSnackBar.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) errorMessage, [MessageType](../enums_enums/MessageType.md) messageType, {[Duration](https://api.flutter.dev/flutter/dart-core/Duration-class.html) duration = const Duration(seconds: 2)}) void +##### [showTalawaErrorSnackBar](../services_navigation_service/NavigationService/showTalawaErrorSnackBar.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) errorMessage, [MessageType](../enums_enums/MessageType.md) messageType, \{[Duration](https:api.flutter.dev/flutter/dart-core/Duration-class.html) duration = const Duration(seconds: 2)\}) void @@ -167,12 +167,12 @@ This is used for the quick alert of duration: 2 seconds with text m -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -180,12 +180,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/services_navigation_service/NavigationService/fromInviteLink.md b/docs/talawa-mobile-docs/services_navigation_service/NavigationService/fromInviteLink.md index e65d09b5480..ed247f0ae2c 100644 --- a/docs/talawa-mobile-docs/services_navigation_service/NavigationService/fromInviteLink.md +++ b/docs/talawa-mobile-docs/services_navigation_service/NavigationService/fromInviteLink.md @@ -11,7 +11,7 @@ void fromInviteLink -([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html)> routeNames, [List](https://api.flutter.dev/flutter/dart-core/List-class.html) arguments) +([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html)\> routeNames, [List](https:api.flutter.dev/flutter/dart-core/List-class.html) arguments) @@ -23,13 +23,13 @@ void fromInviteLink ## Implementation ```dart -void fromInviteLink(List routeNames, List arguments) { +void fromInviteLink(List\ routeNames, List\ arguments) \{ int i = 0; - removeAllAndPush('/${routeNames[i]}', '/', arguments: arguments[i]); - for (i = 1; i < routeNames.length; i++) { - pushScreen('/${routeNames[i]}', arguments: arguments[i]); - } -} + removeAllAndPush('/$\{routeNames[i]\}', '/', arguments: arguments[i]); + for (i = 1; i \< routeNames.length; i++) \{ + pushScreen('/$\{routeNames[i]\}', arguments: arguments[i]); + \} +\} ``` diff --git a/docs/talawa-mobile-docs/services_navigation_service/NavigationService/navigatorKey.md b/docs/talawa-mobile-docs/services_navigation_service/NavigationService/navigatorKey.md index ba78b322e34..d613740864d 100644 --- a/docs/talawa-mobile-docs/services_navigation_service/NavigationService/navigatorKey.md +++ b/docs/talawa-mobile-docs/services_navigation_service/NavigationService/navigatorKey.md @@ -9,9 +9,9 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[NavigatorState](https://api.flutter.dev/flutter/widgets/NavigatorState-class.html)> navigatorKey +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[NavigatorState](https:api.flutter.dev/flutter/widgets/NavigatorState-class.html)\> navigatorKey -_read / write_ +_\read / write\_ @@ -21,7 +21,7 @@ _read / write_ ## Implementation ```dart -GlobalKey navigatorKey = GlobalKey(); +GlobalKey\ navigatorKey = GlobalKey\(); ``` diff --git a/docs/talawa-mobile-docs/services_navigation_service/NavigationService/pop.md b/docs/talawa-mobile-docs/services_navigation_service/NavigationService/pop.md index fcf90d6f10c..3d96b0bc1e8 100644 --- a/docs/talawa-mobile-docs/services_navigation_service/NavigationService/pop.md +++ b/docs/talawa-mobile-docs/services_navigation_service/NavigationService/pop.md @@ -17,16 +17,16 @@ void pop -

This function pops the current state.

+\This function pops the current state.\ ## Implementation ```dart -void pop() { +void pop() \{ return navigatorKey.currentState!.pop(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_navigation_service/NavigationService/popAndPushScreen.md b/docs/talawa-mobile-docs/services_navigation_service/NavigationService/popAndPushScreen.md index 2dd7b0e99e0..c9a56b5cf21 100644 --- a/docs/talawa-mobile-docs/services_navigation_service/NavigationService/popAndPushScreen.md +++ b/docs/talawa-mobile-docs/services_navigation_service/NavigationService/popAndPushScreen.md @@ -10,29 +10,29 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) popAndPushScreen -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) routeName, {dynamic arguments}) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) popAndPushScreen +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) routeName, \{dynamic arguments\}) -

This function pop the initial route and push the new route to the navigator.

-

params:

-
    -
  • routeName
  • -
  • arguments : necessary data for the route
  • -
+\This function pop the initial route and push the new route to the navigator.\ +\params:\ +\ +\\routeName\\ +\\arguments\ : necessary data for the route\ +\ ## Implementation ```dart -Future popAndPushScreen(String routeName, {dynamic arguments}) { +Future\ popAndPushScreen(String routeName, \{dynamic arguments\}) \{ navigatorKey.currentState!.pop(); return pushScreen(routeName, arguments: arguments); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_navigation_service/NavigationService/pushDialog.md b/docs/talawa-mobile-docs/services_navigation_service/NavigationService/pushDialog.md index 1c6f2e7e0bc..a368d7d2003 100644 --- a/docs/talawa-mobile-docs/services_navigation_service/NavigationService/pushDialog.md +++ b/docs/talawa-mobile-docs/services_navigation_service/NavigationService/pushDialog.md @@ -11,29 +11,29 @@ void pushDialog -([Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) dialog) +([Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) dialog) -

This function is used to show the custom Dialog.

+\This function is used to show the custom Dialog.\ ## Implementation ```dart -void pushDialog(Widget dialog) { +void pushDialog(Widget dialog) \{ showDialog( context: navigatorKey.currentContext!, barrierColor: Colors.transparent, barrierDismissible: false, - builder: (BuildContext context) { + builder: (BuildContext context) \{ return dialog; - }, + \}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_navigation_service/NavigationService/pushReplacementScreen.md b/docs/talawa-mobile-docs/services_navigation_service/NavigationService/pushReplacementScreen.md index d424e9278e6..78eabbb8fde 100644 --- a/docs/talawa-mobile-docs/services_navigation_service/NavigationService/pushReplacementScreen.md +++ b/docs/talawa-mobile-docs/services_navigation_service/NavigationService/pushReplacementScreen.md @@ -10,29 +10,29 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) pushReplacementScreen -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) routeName, {dynamic arguments}) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) pushReplacementScreen +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) routeName, \{dynamic arguments\}) -

This function push the route and replace the screen.

-

params:

-
    -
  • routeName
  • -
  • arguments : necessary data for the route
  • -
+\This function push the route and replace the screen.\ +\params:\ +\ +\\routeName\\ +\\arguments\ : necessary data for the route\ +\ ## Implementation ```dart -Future pushReplacementScreen(String routeName, {dynamic arguments}) { +Future\ pushReplacementScreen(String routeName, \{dynamic arguments\}) \{ return navigatorKey.currentState! .pushReplacementNamed(routeName, arguments: arguments); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_navigation_service/NavigationService/pushScreen.md b/docs/talawa-mobile-docs/services_navigation_service/NavigationService/pushScreen.md index cee22161313..921c49bbb9c 100644 --- a/docs/talawa-mobile-docs/services_navigation_service/NavigationService/pushScreen.md +++ b/docs/talawa-mobile-docs/services_navigation_service/NavigationService/pushScreen.md @@ -10,29 +10,29 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) pushScreen -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) routeName, {dynamic arguments}) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) pushScreen +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) routeName, \{dynamic arguments\}) -

This function push the route to the navigator.

-

params:

-
    -
  • routeName
  • -
  • arguments : necessary data for the route
  • -
+\This function push the route to the navigator.\ +\params:\ +\ +\\routeName\\ +\\arguments\ : necessary data for the route\ +\ ## Implementation ```dart -Future pushScreen(String routeName, {dynamic arguments}) { +Future\ pushScreen(String routeName, \{dynamic arguments\}) \{ return navigatorKey.currentState! .pushNamed(routeName, arguments: arguments); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_navigation_service/NavigationService/removeAllAndPush.md b/docs/talawa-mobile-docs/services_navigation_service/NavigationService/removeAllAndPush.md index 675e9d43030..85af9488ea4 100644 --- a/docs/talawa-mobile-docs/services_navigation_service/NavigationService/removeAllAndPush.md +++ b/docs/talawa-mobile-docs/services_navigation_service/NavigationService/removeAllAndPush.md @@ -10,37 +10,37 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) removeAllAndPush -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) routeName, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) tillRoute, {dynamic arguments}) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) removeAllAndPush +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) routeName, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) tillRoute, \{dynamic arguments\}) -

This function remove all the routes till the particular route and add new route.

-

params:

-
    -
  • routeName : route that need to add
  • -
  • tillRoute : remove all route until this route.
  • -
  • arguments : necessary data for the route
  • -
+\This function remove all the routes till the particular route and add new route.\ +\params:\ +\ +\\routeName\ : route that need to add\ +\\tillRoute\ : remove all route until this route.\ +\\arguments\ : necessary data for the route\ +\ ## Implementation ```dart -Future removeAllAndPush( +Future\ removeAllAndPush( String routeName, - String tillRoute, { + String tillRoute, \{ dynamic arguments, -}) { +\}) \{ return navigatorKey.currentState!.pushNamedAndRemoveUntil( routeName, ModalRoute.withName(tillRoute), arguments: arguments, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_navigation_service/NavigationService/showSnackBar.md b/docs/talawa-mobile-docs/services_navigation_service/NavigationService/showSnackBar.md index 26dee20c015..79d7447ff10 100644 --- a/docs/talawa-mobile-docs/services_navigation_service/NavigationService/showSnackBar.md +++ b/docs/talawa-mobile-docs/services_navigation_service/NavigationService/showSnackBar.md @@ -11,13 +11,13 @@ void showSnackBar -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) message, {[Duration](https://api.flutter.dev/flutter/dart-core/Duration-class.html) duration = const Duration(seconds: 2)}) +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) message, \{[Duration](https:api.flutter.dev/flutter/dart-core/Duration-class.html) duration = const Duration(seconds: 2)\}) -

This is used for the quick alert of duration: 2 seconds with text message(passed).

+\This is used for the quick alert of \duration: 2 seconds\ with text message(passed).\ @@ -25,9 +25,9 @@ void showSnackBar ```dart void showSnackBar( - String message, { + String message, \{ Duration duration = const Duration(seconds: 2), -}) { +\}) \{ ScaffoldMessenger.of(navigatorKey.currentContext!).showSnackBar( SnackBar( behavior: SnackBarBehavior.floating, @@ -35,7 +35,7 @@ void showSnackBar( content: Text(message), ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_navigation_service/NavigationService/showTalawaErrorDialog.md b/docs/talawa-mobile-docs/services_navigation_service/NavigationService/showTalawaErrorDialog.md index 553dac12b7c..3ad3a5be1fd 100644 --- a/docs/talawa-mobile-docs/services_navigation_service/NavigationService/showTalawaErrorDialog.md +++ b/docs/talawa-mobile-docs/services_navigation_service/NavigationService/showTalawaErrorDialog.md @@ -11,7 +11,7 @@ void showTalawaErrorDialog -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) errorMessage, [MessageType](../../enums_enums/MessageType.md) messageType) +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) errorMessage, [MessageType](../../enums_enums/MessageType.md) messageType) @@ -23,19 +23,19 @@ void showTalawaErrorDialog ## Implementation ```dart -void showTalawaErrorDialog(String errorMessage, MessageType messageType) { +void showTalawaErrorDialog(String errorMessage, MessageType messageType) \{ showDialog( context: navigatorKey.currentContext!, barrierColor: Colors.transparent, barrierDismissible: false, - builder: (BuildContext context) { + builder: (BuildContext context) \{ return TalawaErrorDialog( errorMessage, messageType: messageType, ); - }, + \}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_navigation_service/NavigationService/showTalawaErrorSnackBar.md b/docs/talawa-mobile-docs/services_navigation_service/NavigationService/showTalawaErrorSnackBar.md index 565c775000b..b2ce9829c8b 100644 --- a/docs/talawa-mobile-docs/services_navigation_service/NavigationService/showTalawaErrorSnackBar.md +++ b/docs/talawa-mobile-docs/services_navigation_service/NavigationService/showTalawaErrorSnackBar.md @@ -11,7 +11,7 @@ void showTalawaErrorSnackBar -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) errorMessage, [MessageType](../../enums_enums/MessageType.md) messageType, {[Duration](https://api.flutter.dev/flutter/dart-core/Duration-class.html) duration = const Duration(seconds: 2)}) +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) errorMessage, [MessageType](../../enums_enums/MessageType.md) messageType, \{[Duration](https:api.flutter.dev/flutter/dart-core/Duration-class.html) duration = const Duration(seconds: 2)\}) @@ -25,9 +25,9 @@ void showTalawaErrorSnackBar ```dart void showTalawaErrorSnackBar( String errorMessage, - MessageType messageType, { + MessageType messageType, \{ Duration duration = const Duration(seconds: 2), -}) { +\}) \{ ScaffoldMessenger.of(navigatorKey.currentContext!).showSnackBar( SnackBar( padding: EdgeInsets.zero, @@ -38,7 +38,7 @@ void showTalawaErrorSnackBar( backgroundColor: const Color.fromRGBO(65, 65, 66, 1), ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_org_service/OrganizationService-class.md b/docs/talawa-mobile-docs/services_org_service/OrganizationService-class.md index dec42251978..bd3a6019224 100644 --- a/docs/talawa-mobile-docs/services_org_service/OrganizationService-class.md +++ b/docs/talawa-mobile-docs/services_org_service/OrganizationService-class.md @@ -11,11 +11,11 @@ -

OrganizationService class provides the in the context of organizations.

-

Services include:

-
    -
  • getOrgMembersList : to get all organizations members
  • -
+\OrganizationService class provides the in the context of organizations.\ +\Services include:\ +\ +\\getOrgMembersList\ : to get all organizations members\ +\ @@ -29,21 +29,21 @@ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -51,7 +51,7 @@ _read-onlyinherited_ ## Methods -##### [getOrgMembersList](../services_org_service/OrganizationService/getOrgMembersList.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)>> +##### [getOrgMembersList](../services_org_service/OrganizationService/getOrgMembersList.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) orgId) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)\>\> @@ -60,21 +60,21 @@ This function fetch and returns the list of organization members. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -82,12 +82,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/services_org_service/OrganizationService/OrganizationService.md b/docs/talawa-mobile-docs/services_org_service/OrganizationService/OrganizationService.md index 6827db76d67..63305350af5 100644 --- a/docs/talawa-mobile-docs/services_org_service/OrganizationService/OrganizationService.md +++ b/docs/talawa-mobile-docs/services_org_service/OrganizationService/OrganizationService.md @@ -18,9 +18,9 @@ OrganizationService() ## Implementation ```dart -OrganizationService() { - _dbFunctions = locator(); -} +OrganizationService() \{ + _dbFunctions = locator\(); +\} ``` diff --git a/docs/talawa-mobile-docs/services_org_service/OrganizationService/getOrgMembersList.md b/docs/talawa-mobile-docs/services_org_service/OrganizationService/getOrgMembersList.md index b44d1f1dedd..73e74d1ad71 100644 --- a/docs/talawa-mobile-docs/services_org_service/OrganizationService/getOrgMembersList.md +++ b/docs/talawa-mobile-docs/services_org_service/OrganizationService/getOrgMembersList.md @@ -10,40 +10,40 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)>> getOrgMembersList -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)\>\> getOrgMembersList +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) orgId) -

This function fetch and returns the list of organization members.

-

params:

-
    -
  • orgId : id of the organization for which members list need be fetched.
  • -
+\This function fetch and returns the list of organization members.\ +\params:\ +\ +\\orgId\ : id of the organization for which members list need be fetched.\ +\ ## Implementation ```dart -Future> getOrgMembersList(String orgId) async { +Future\\> getOrgMembersList(String orgId) async \{ final String query = Queries().fetchOrgDetailsById(orgId); - // fetching from database using graphQL mutations. + fetching from database using graphQL mutations. final result = await _dbFunctions.gqlAuthMutation(query); final List orgMembersResult = result.data['organizations'][0]['members'] as List; - final List orgMembersList = []; - orgMembersResult.forEach((jsonElement) { + final List\ orgMembersList = []; + orgMembersResult.forEach((jsonElement) \{ final User member = - User.fromJson(jsonElement as Map, fromOrg: true); + User.fromJson(jsonElement as Map\, fromOrg: true); orgMembersList.add(member); - }); + \}); - // return list + return list return orgMembersList; -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_post_service/PostService-class.md b/docs/talawa-mobile-docs/services_post_service/PostService-class.md index 41a1ca68308..2036ec58ce5 100644 --- a/docs/talawa-mobile-docs/services_post_service/PostService-class.md +++ b/docs/talawa-mobile-docs/services_post_service/PostService-class.md @@ -11,13 +11,13 @@ -

PostService class provides functions in the context of a Post.

-

Services include:

-
    -
  • getPosts : to get all posts of the organization.
  • -
  • addLike : to add like to the post.
  • -
  • removeLike : to remove the like from the post.
  • -
+\PostService class provides functions in the context of a Post.\ +\Services include:\ +\ +\\getPosts\ : to get all posts of the organization.\ +\\addLike\ : to add like to the post.\ +\\removeLike\ : to remove the like from the post.\ +\ @@ -31,39 +31,39 @@ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [postStream](../services_post_service/PostService/postStream.md) → [Stream](https://api.flutter.dev/flutter/dart-async/Stream-class.html)<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../models_post_post_model/Post-class.md)>> +##### [postStream](../services_post_service/PostService/postStream.md) → [Stream](https:api.flutter.dev/flutter/dart-async/Stream-class.html)<[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../models_post_post_model/Post-class.md)\>\> -_read-only_ +_\read-only\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [updatedPostStream](../services_post_service/PostService/updatedPostStream.md) → [Stream](https://api.flutter.dev/flutter/dart-async/Stream-class.html)<[Post](../models_post_post_model/Post-class.md)> +##### [updatedPostStream](../services_post_service/PostService/updatedPostStream.md) → [Stream](https:api.flutter.dev/flutter/dart-async/Stream-class.html)<[Post](../models_post_post_model/Post-class.md)\> -_read-only_ +_\read-only\_ @@ -71,7 +71,7 @@ _read-only_ ## Methods -##### [addCommentLocally](../services_post_service/PostService/addCommentLocally.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) postID) void +##### [addCommentLocally](../services_post_service/PostService/addCommentLocally.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) postID) void @@ -80,7 +80,7 @@ _read-only_ -##### [addLike](../services_post_service/PostService/addLike.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) postID) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [addLike](../services_post_service/PostService/addLike.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) postID) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -89,26 +89,26 @@ This function is used to add Like to the Post. -##### [getPosts](../services_post_service/PostService/getPosts.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [getPosts](../services_post_service/PostService/getPosts.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> This function used to get all posts of an organization. -The function reference the organization Id from _currentOrg. +The function reference the organization Id from \_currentOrg\. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [removeLike](../services_post_service/PostService/removeLike.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) postID) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [removeLike](../services_post_service/PostService/removeLike.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) postID) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -126,12 +126,12 @@ This function is used to remove like from the Post. -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -139,12 +139,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/services_post_service/PostService/PostService.md b/docs/talawa-mobile-docs/services_post_service/PostService/PostService.md index 0ee01b0b66c..d5869b968a1 100644 --- a/docs/talawa-mobile-docs/services_post_service/PostService/PostService.md +++ b/docs/talawa-mobile-docs/services_post_service/PostService/PostService.md @@ -18,14 +18,14 @@ PostService() ## Implementation ```dart -PostService() { +PostService() \{ _postStream = _postStreamController.stream.asBroadcastStream(); _updatedPostStream = _updatedPostStreamController.stream.asBroadcastStream(); _currentOrg = _userConfig.currentOrg; setOrgStreamSubscription(); getPosts(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_post_service/PostService/addCommentLocally.md b/docs/talawa-mobile-docs/services_post_service/PostService/addCommentLocally.md index f2123c5d58a..be03cb2ce7d 100644 --- a/docs/talawa-mobile-docs/services_post_service/PostService/addCommentLocally.md +++ b/docs/talawa-mobile-docs/services_post_service/PostService/addCommentLocally.md @@ -11,7 +11,7 @@ void addCommentLocally -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) postID) +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) postID) @@ -23,14 +23,14 @@ void addCommentLocally ## Implementation ```dart -void addCommentLocally(String postID) { - for (int i = 0; i < _posts.length; i++) { - if (_posts[i].sId == postID) { +void addCommentLocally(String postID) \{ + for (int i = 0; i \< _posts.length; i++) \{ + if (_posts[i].sId == postID) \{ _posts[i].comments!.add(Comments(sId: postID)); _updatedPostStreamController.add(_posts[i]); - } - } -} + \} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/services_post_service/PostService/addLike.md b/docs/talawa-mobile-docs/services_post_service/PostService/addLike.md index 6e68fdc7f6f..1e175dfe14b 100644 --- a/docs/talawa-mobile-docs/services_post_service/PostService/addLike.md +++ b/docs/talawa-mobile-docs/services_post_service/PostService/addLike.md @@ -10,34 +10,34 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> addLike -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) postID) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> addLike +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) postID) -

This function is used to add Like to the Post.

-

params:

-
    -
  • postId : id of the post where like need to be added.
  • -
+\This function is used to add Like to the Post.\ +\params:\ +\ +\\postId\ : id of the post where like need to be added.\ +\ ## Implementation ```dart -Future addLike(String postID) async { +Future\ addLike(String postID) async \{ _localAddLike(postID); final String mutation = PostQueries().addLike(); - // run the graphQl mutation. + run the graphQl mutation. final result = await _dbFunctions - .gqlAuthMutation(mutation, variables: {"postID": postID}); + .gqlAuthMutation(mutation, variables: \{"postID": postID\}); print(result); - // return result + return result return result; -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_post_service/PostService/getPosts.md b/docs/talawa-mobile-docs/services_post_service/PostService/getPosts.md index 84b9cdacb2f..30d8ff7b07d 100644 --- a/docs/talawa-mobile-docs/services_post_service/PostService/getPosts.md +++ b/docs/talawa-mobile-docs/services_post_service/PostService/getPosts.md @@ -10,41 +10,41 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> getPosts +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> getPosts () -

This function used to get all posts of an organization. -The function reference the organization Id from _currentOrg.

+\This function used to get all posts of an organization. +The function reference the organization Id from \_currentOrg\.\ ## Implementation ```dart -Future getPosts() async { - // variables +Future\ getPosts() async \{ + variables final String currentOrgID = _currentOrg.id!; final String query = PostQueries().getPostsById(currentOrgID); final result = await _dbFunctions.gqlAuthQuery(query); - //Checking if the dbFunctions return the postJSON, if not return. + Checking if the dbFunctions return the postJSON, if not return. if (result.data!['postsByOrganization'] == null) return; final List postsJson = result.data!['postsByOrganization'] as List; - postsJson.forEach((postJson) { - final Post post = Post.fromJson(postJson as Map); - if (!_renderedPostID.contains(post.sId)) { + postsJson.forEach((postJson) \{ + final Post post = Post.fromJson(postJson as Map\); + if (!_renderedPostID.contains(post.sId)) \{ _posts.insert(0, post); _renderedPostID.add(post.sId); - } - }); + \} + \}); _postStreamController.add(_posts); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_post_service/PostService/postStream.md b/docs/talawa-mobile-docs/services_post_service/PostService/postStream.md index 80065aede13..b95e9c61dc1 100644 --- a/docs/talawa-mobile-docs/services_post_service/PostService/postStream.md +++ b/docs/talawa-mobile-docs/services_post_service/PostService/postStream.md @@ -11,7 +11,7 @@ -[Stream](https://api.flutter.dev/flutter/dart-async/Stream-class.html)<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)>> postStream +[Stream](https:api.flutter.dev/flutter/dart-async/Stream-class.html)<[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)\>\> postStream @@ -23,7 +23,7 @@ ## Implementation ```dart -Stream> get postStream => _postStream; +Stream\\> get postStream =\> _postStream; ``` diff --git a/docs/talawa-mobile-docs/services_post_service/PostService/removeLike.md b/docs/talawa-mobile-docs/services_post_service/PostService/removeLike.md index fed21d0195c..4d6cc71aad5 100644 --- a/docs/talawa-mobile-docs/services_post_service/PostService/removeLike.md +++ b/docs/talawa-mobile-docs/services_post_service/PostService/removeLike.md @@ -10,32 +10,32 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> removeLike -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) postID) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> removeLike +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) postID) -

This function is used to remove like from the Post.

-

params:

-
    -
  • postId : id of the post where like need to be removed.
  • -
+\This function is used to remove like from the Post.\ +\params:\ +\ +\\postId\ : id of the post where like need to be removed.\ +\ ## Implementation ```dart -Future removeLike(String postID) async { +Future\ removeLike(String postID) async \{ _removeLocal(postID); final String mutation = PostQueries().removeLike(); final result = await _dbFunctions - .gqlAuthMutation(mutation, variables: {"postID": postID}); + .gqlAuthMutation(mutation, variables: \{"postID": postID\}); print(result); return result; -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_post_service/PostService/setOrgStreamSubscription.md b/docs/talawa-mobile-docs/services_post_service/PostService/setOrgStreamSubscription.md index f4ee899b494..a91727e5fab 100644 --- a/docs/talawa-mobile-docs/services_post_service/PostService/setOrgStreamSubscription.md +++ b/docs/talawa-mobile-docs/services_post_service/PostService/setOrgStreamSubscription.md @@ -23,16 +23,16 @@ void setOrgStreamSubscription ## Implementation ```dart -void setOrgStreamSubscription() { - _userConfig.currentOrgInfoStream.listen((updatedOrganization) { - if (updatedOrganization != _currentOrg) { +void setOrgStreamSubscription() \{ + _userConfig.currentOrgInfoStream.listen((updatedOrganization) \{ + if (updatedOrganization != _currentOrg) \{ print("org changes from post service"); _renderedPostID.clear(); _currentOrg = updatedOrganization; getPosts(); - } - }); -} + \} + \}); +\} ``` diff --git a/docs/talawa-mobile-docs/services_post_service/PostService/updatedPostStream.md b/docs/talawa-mobile-docs/services_post_service/PostService/updatedPostStream.md index 3048a2fe6d8..a6fe027a5c7 100644 --- a/docs/talawa-mobile-docs/services_post_service/PostService/updatedPostStream.md +++ b/docs/talawa-mobile-docs/services_post_service/PostService/updatedPostStream.md @@ -11,7 +11,7 @@ -[Stream](https://api.flutter.dev/flutter/dart-async/Stream-class.html)<[Post](../../models_post_post_model/Post-class.md)> updatedPostStream +[Stream](https:api.flutter.dev/flutter/dart-async/Stream-class.html)<[Post](../../models_post_post_model/Post-class.md)\> updatedPostStream @@ -23,7 +23,7 @@ ## Implementation ```dart -Stream get updatedPostStream => _updatedPostStream; +Stream\ get updatedPostStream =\> _updatedPostStream; ``` diff --git a/docs/talawa-mobile-docs/services_size_config/SizeConfig-class.md b/docs/talawa-mobile-docs/services_size_config/SizeConfig-class.md index d0897bbeb2b..207571b4a59 100644 --- a/docs/talawa-mobile-docs/services_size_config/SizeConfig-class.md +++ b/docs/talawa-mobile-docs/services_size_config/SizeConfig-class.md @@ -11,7 +11,7 @@ -

SizeConfig class is used to initialise the height and width of the media.

+\SizeConfig class is used to initialise the height and width of the media.\ @@ -25,21 +25,21 @@ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -47,7 +47,7 @@ _read-onlyinherited_ ## Methods -##### [init](../services_size_config/SizeConfig/init.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) void +##### [init](../services_size_config/SizeConfig/init.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) void @@ -56,12 +56,12 @@ _read-onlyinherited_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ @@ -74,12 +74,12 @@ _inherited_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -87,12 +87,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ @@ -100,66 +100,66 @@ _inherited_ ## Static Properties -##### [blockSizeHorizontal](../services_size_config/SizeConfig/blockSizeHorizontal.md) ↔ [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? +##### [blockSizeHorizontal](../services_size_config/SizeConfig/blockSizeHorizontal.md) ↔ [double](https:api.flutter.dev/flutter/dart-core/double-class.html)? -_read / write_ +_\read / write\_ -##### [blockSizeVertical](../services_size_config/SizeConfig/blockSizeVertical.md) ↔ [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? +##### [blockSizeVertical](../services_size_config/SizeConfig/blockSizeVertical.md) ↔ [double](https:api.flutter.dev/flutter/dart-core/double-class.html)? -_read / write_ +_\read / write\_ -##### [paddingTop](../services_size_config/SizeConfig/paddingTop.md) ↔ [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? +##### [paddingTop](../services_size_config/SizeConfig/paddingTop.md) ↔ [double](https:api.flutter.dev/flutter/dart-core/double-class.html)? -_read / write_ +_\read / write\_ -##### [safeBlockHorizontal](../services_size_config/SizeConfig/safeBlockHorizontal.md) ↔ [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? +##### [safeBlockHorizontal](../services_size_config/SizeConfig/safeBlockHorizontal.md) ↔ [double](https:api.flutter.dev/flutter/dart-core/double-class.html)? -_read / write_ +_\read / write\_ -##### [safeBlockVertical](../services_size_config/SizeConfig/safeBlockVertical.md) ↔ [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? +##### [safeBlockVertical](../services_size_config/SizeConfig/safeBlockVertical.md) ↔ [double](https:api.flutter.dev/flutter/dart-core/double-class.html)? -_read / write_ +_\read / write\_ -##### [screenHeight](../services_size_config/SizeConfig/screenHeight.md) ↔ [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? +##### [screenHeight](../services_size_config/SizeConfig/screenHeight.md) ↔ [double](https:api.flutter.dev/flutter/dart-core/double-class.html)? -_read / write_ +_\read / write\_ -##### [screenWidth](../services_size_config/SizeConfig/screenWidth.md) ↔ [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? +##### [screenWidth](../services_size_config/SizeConfig/screenWidth.md) ↔ [double](https:api.flutter.dev/flutter/dart-core/double-class.html)? -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/services_size_config/SizeConfig/blockSizeHorizontal.md b/docs/talawa-mobile-docs/services_size_config/SizeConfig/blockSizeHorizontal.md index c497d83ad21..9d36598aa75 100644 --- a/docs/talawa-mobile-docs/services_size_config/SizeConfig/blockSizeHorizontal.md +++ b/docs/talawa-mobile-docs/services_size_config/SizeConfig/blockSizeHorizontal.md @@ -9,9 +9,9 @@ -[double](https://api.flutter.dev/flutter/dart-core/double-class.html)? blockSizeHorizontal +[double](https:api.flutter.dev/flutter/dart-core/double-class.html)? blockSizeHorizontal -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/services_size_config/SizeConfig/blockSizeVertical.md b/docs/talawa-mobile-docs/services_size_config/SizeConfig/blockSizeVertical.md index 1d691b2cfb7..19707c6b9cc 100644 --- a/docs/talawa-mobile-docs/services_size_config/SizeConfig/blockSizeVertical.md +++ b/docs/talawa-mobile-docs/services_size_config/SizeConfig/blockSizeVertical.md @@ -9,9 +9,9 @@ -[double](https://api.flutter.dev/flutter/dart-core/double-class.html)? blockSizeVertical +[double](https:api.flutter.dev/flutter/dart-core/double-class.html)? blockSizeVertical -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/services_size_config/SizeConfig/init.md b/docs/talawa-mobile-docs/services_size_config/SizeConfig/init.md index 79388033906..20c0e7e51c2 100644 --- a/docs/talawa-mobile-docs/services_size_config/SizeConfig/init.md +++ b/docs/talawa-mobile-docs/services_size_config/SizeConfig/init.md @@ -11,7 +11,7 @@ void init -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) @@ -23,7 +23,7 @@ void init ## Implementation ```dart -void init(BuildContext context) { +void init(BuildContext context) \{ _mediaQueryData = MediaQuery.of(context); screenWidth = _mediaQueryData.size.width; screenHeight = _mediaQueryData.size.height; @@ -38,7 +38,7 @@ void init(BuildContext context) { safeBlockVertical = (screenHeight! - _safeAreaVertical) / 100; debugPrint("safeBlockHorizontal: $safeBlockHorizontal"); debugPrint("safeBlockVertical: $safeBlockVertical"); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_size_config/SizeConfig/paddingTop.md b/docs/talawa-mobile-docs/services_size_config/SizeConfig/paddingTop.md index 28987e0b3ed..b74679c7fb2 100644 --- a/docs/talawa-mobile-docs/services_size_config/SizeConfig/paddingTop.md +++ b/docs/talawa-mobile-docs/services_size_config/SizeConfig/paddingTop.md @@ -9,9 +9,9 @@ -[double](https://api.flutter.dev/flutter/dart-core/double-class.html)? paddingTop +[double](https:api.flutter.dev/flutter/dart-core/double-class.html)? paddingTop -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/services_size_config/SizeConfig/safeBlockHorizontal.md b/docs/talawa-mobile-docs/services_size_config/SizeConfig/safeBlockHorizontal.md index 296f95581e4..e98b4572168 100644 --- a/docs/talawa-mobile-docs/services_size_config/SizeConfig/safeBlockHorizontal.md +++ b/docs/talawa-mobile-docs/services_size_config/SizeConfig/safeBlockHorizontal.md @@ -9,9 +9,9 @@ -[double](https://api.flutter.dev/flutter/dart-core/double-class.html)? safeBlockHorizontal +[double](https:api.flutter.dev/flutter/dart-core/double-class.html)? safeBlockHorizontal -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/services_size_config/SizeConfig/safeBlockVertical.md b/docs/talawa-mobile-docs/services_size_config/SizeConfig/safeBlockVertical.md index aa09b2ba74d..ff22fc2b67e 100644 --- a/docs/talawa-mobile-docs/services_size_config/SizeConfig/safeBlockVertical.md +++ b/docs/talawa-mobile-docs/services_size_config/SizeConfig/safeBlockVertical.md @@ -9,9 +9,9 @@ -[double](https://api.flutter.dev/flutter/dart-core/double-class.html)? safeBlockVertical +[double](https:api.flutter.dev/flutter/dart-core/double-class.html)? safeBlockVertical -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/services_size_config/SizeConfig/screenHeight.md b/docs/talawa-mobile-docs/services_size_config/SizeConfig/screenHeight.md index 4aab01da1d6..60695772482 100644 --- a/docs/talawa-mobile-docs/services_size_config/SizeConfig/screenHeight.md +++ b/docs/talawa-mobile-docs/services_size_config/SizeConfig/screenHeight.md @@ -9,9 +9,9 @@ -[double](https://api.flutter.dev/flutter/dart-core/double-class.html)? screenHeight +[double](https:api.flutter.dev/flutter/dart-core/double-class.html)? screenHeight -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/services_size_config/SizeConfig/screenWidth.md b/docs/talawa-mobile-docs/services_size_config/SizeConfig/screenWidth.md index 5f14d7c9535..b31b4bfdf9c 100644 --- a/docs/talawa-mobile-docs/services_size_config/SizeConfig/screenWidth.md +++ b/docs/talawa-mobile-docs/services_size_config/SizeConfig/screenWidth.md @@ -9,9 +9,9 @@ -[double](https://api.flutter.dev/flutter/dart-core/double-class.html)? screenWidth +[double](https:api.flutter.dev/flutter/dart-core/double-class.html)? screenWidth -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/services_size_config/SizeConfig/test.md b/docs/talawa-mobile-docs/services_size_config/SizeConfig/test.md index 1f2a3819edd..602b3ae4b79 100644 --- a/docs/talawa-mobile-docs/services_size_config/SizeConfig/test.md +++ b/docs/talawa-mobile-docs/services_size_config/SizeConfig/test.md @@ -23,7 +23,7 @@ void test ## Implementation ```dart -void test() { +void test() \{ _mediaQueryData = const MediaQueryData(size: Size(360, 684), padding: EdgeInsets.zero); screenWidth = _mediaQueryData.size.width; @@ -37,7 +37,7 @@ void test() { _mediaQueryData.padding.top + _mediaQueryData.padding.bottom; safeBlockHorizontal = (screenWidth! - _safeAreaHorizontal) / 100; safeBlockVertical = (screenHeight! - _safeAreaVertical) / 100; -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_task_service/TaskService-class.md b/docs/talawa-mobile-docs/services_task_service/TaskService-class.md index 12a51accd43..256abee8935 100644 --- a/docs/talawa-mobile-docs/services_task_service/TaskService-class.md +++ b/docs/talawa-mobile-docs/services_task_service/TaskService-class.md @@ -11,15 +11,15 @@ -

PostService class provides functions in the context of a Task.

-

Services include:

-
    -
  • getTasksForEvent : to get the task for the event.
  • -
  • getTasksByUser : to get the task added by the user.
  • -
  • editTask : to edit the task added by the user.
  • -
  • createTask : to create the task for the event.
  • -
  • deleteTask : to delete the task added by the user.
  • -
+\PostService class provides functions in the context of a Task.\ +\Services include:\ +\ +\\getTasksForEvent\ : to get the task for the event.\ +\\getTasksByUser\ : to get the task added by the user.\ +\\editTask\ : to edit the task added by the user.\ +\\createTask\ : to create the task for the event.\ +\\deleteTask\ : to delete the task added by the user.\ +\ @@ -33,39 +33,39 @@ ## Properties -##### [callbackNotifyListeners](../services_task_service/TaskService/callbackNotifyListeners.md) ↔ [VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) +##### [callbackNotifyListeners](../services_task_service/TaskService/callbackNotifyListeners.md) ↔ [VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) -_read / write_ +_\read / write\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [tasks](../services_task_service/TaskService/tasks.md) → [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Task](../models_task_task_model/Task-class.md)> +##### [tasks](../services_task_service/TaskService/tasks.md) → [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Task](../models_task_task_model/Task-class.md)\> -_read-only_ +_\read-only\_ @@ -73,7 +73,7 @@ _read-only_ ## Methods -##### [createTask](../services_task_service/TaskService/createTask.md)({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) title, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) description, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) deadline, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)> +##### [createTask](../services_task_service/TaskService/createTask.md)(\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) title, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) description, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) deadline, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)\> @@ -82,7 +82,7 @@ This function is used to create a new task for the event. -##### [deleteTask](../services_task_service/TaskService/deleteTask.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) taskId, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) creatorId) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [deleteTask](../services_task_service/TaskService/deleteTask.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) taskId, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) creatorId) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -91,7 +91,7 @@ This function is used to delete a task. -##### [editTask](../services_task_service/TaskService/editTask.md)({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) title, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) description, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) deadline, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) taskId}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)> +##### [editTask](../services_task_service/TaskService/editTask.md)(\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) title, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) description, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) deadline, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) taskId\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)\> @@ -100,7 +100,7 @@ This function is used to edit the task created by the user. -##### [getTasksByUser](../services_task_service/TaskService/getTasksByUser.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [getTasksByUser](../services_task_service/TaskService/getTasksByUser.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -109,7 +109,7 @@ This function is used to fetch and return all tasks added by the current user. -##### [getTasksForEvent](../services_task_service/TaskService/getTasksForEvent.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [getTasksForEvent](../services_task_service/TaskService/getTasksForEvent.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -118,21 +118,21 @@ This function is used to get all the tasks for the event. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -140,12 +140,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/services_task_service/TaskService/callbackNotifyListeners.md b/docs/talawa-mobile-docs/services_task_service/TaskService/callbackNotifyListeners.md index 13f1edc6f2a..3250e51d380 100644 --- a/docs/talawa-mobile-docs/services_task_service/TaskService/callbackNotifyListeners.md +++ b/docs/talawa-mobile-docs/services_task_service/TaskService/callbackNotifyListeners.md @@ -9,9 +9,9 @@ -[VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) callbackNotifyListeners +[VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) callbackNotifyListeners -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/services_task_service/TaskService/createTask.md b/docs/talawa-mobile-docs/services_task_service/TaskService/createTask.md index 3e08ed9d61b..45ae070d277 100644 --- a/docs/talawa-mobile-docs/services_task_service/TaskService/createTask.md +++ b/docs/talawa-mobile-docs/services_task_service/TaskService/createTask.md @@ -10,33 +10,33 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)> createTask -({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) title, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) description, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) deadline, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId}) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)\> createTask +(\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) title, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) description, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) deadline, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId\}) -

This function is used to create a new task for the event.

-

params:

-
    -
  • title : task title.
  • -
  • description : task description.
  • -
  • deadline : task deadline.
  • -
  • eventId : Event for which task need to be create.
  • -
+\This function is used to create a new task for the event.\ +\params:\ +\ +\\title\ : task title.\ +\\description\ : task description.\ +\\deadline\ : task deadline.\ +\\eventId\ : Event for which task need to be create.\ +\ ## Implementation ```dart -Future createTask({ +Future\ createTask(\{ required String title, required String description, required String deadline, required String eventId, -}) async { +\}) async \{ _databaseMutationFunctions .refreshAccessToken(_userConfig.currentUser.refreshToken!); final res = await _databaseMutationFunctions.gqlAuthMutation( @@ -48,14 +48,14 @@ Future createTask({ ), ); - if (res != null) { - final task = res.data!['createTask'] as Map; + if (res != null) \{ + final task = res.data!['createTask'] as Map\; _tasks.add(Task.fromJson(task)); callbackNotifyListeners(); return true; - } + \} return false; -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_task_service/TaskService/deleteTask.md b/docs/talawa-mobile-docs/services_task_service/TaskService/deleteTask.md index 2487482bc9f..115aae962a5 100644 --- a/docs/talawa-mobile-docs/services_task_service/TaskService/deleteTask.md +++ b/docs/talawa-mobile-docs/services_task_service/TaskService/deleteTask.md @@ -10,34 +10,34 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> deleteTask -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) taskId, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) creatorId) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> deleteTask +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) taskId, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) creatorId) -

This function is used to delete a task.

-

params:

-
    -
  • taskId : id of a task need to be deleted.
  • -
  • creatorId : id of the task creator.
  • -
+\This function is used to delete a task.\ +\params:\ +\ +\\taskId\ : id of a task need to be deleted.\ +\\creatorId\ : id of the task creator.\ +\ ## Implementation ```dart -Future deleteTask(String taskId, String creatorId) async { - if (creatorId == _userConfig.currentUser.id) { +Future\ deleteTask(String taskId, String creatorId) async \{ + if (creatorId == _userConfig.currentUser.id) \{ await _databaseMutationFunctions .refreshAccessToken(_userConfig.currentUser.refreshToken!); final res = await _databaseMutationFunctions .gqlAuthMutation(TaskQueries.deleteTask(taskId)); - if (res != null) _tasks.removeWhere((task) => task.id == taskId); - } -} + if (res != null) _tasks.removeWhere((task) =\> task.id == taskId); + \} +\} ``` diff --git a/docs/talawa-mobile-docs/services_task_service/TaskService/editTask.md b/docs/talawa-mobile-docs/services_task_service/TaskService/editTask.md index e0ff4bf2c2b..d4d4b40b71c 100644 --- a/docs/talawa-mobile-docs/services_task_service/TaskService/editTask.md +++ b/docs/talawa-mobile-docs/services_task_service/TaskService/editTask.md @@ -10,33 +10,33 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)> editTask -({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) title, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) description, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) deadline, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) taskId}) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)\> editTask +(\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) title, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) description, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) deadline, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) taskId\}) -

This function is used to edit the task created by the user.

-

params:

-
    -
  • title : task title.
  • -
  • description : task description.
  • -
  • deadline : task deadline.
  • -
  • taskId : task Id.
  • -
+\This function is used to edit the task created by the user.\ +\params:\ +\ +\\title\ : task title.\ +\\description\ : task description.\ +\\deadline\ : task deadline.\ +\\taskId\ : task Id.\ +\ ## Implementation ```dart -Future editTask({ +Future\ editTask(\{ required String title, required String description, required String deadline, required String taskId, -}) async { +\}) async \{ _databaseMutationFunctions .refreshAccessToken(_userConfig.currentUser.refreshToken!); final res = await _databaseMutationFunctions.gqlAuthMutation( @@ -48,20 +48,20 @@ Future editTask({ ), ); - // if res is not null. - if (res != null) { - final updatedtaskJson = res.data!['updateTask'] as Map; - final index = _tasks.indexWhere((task) => task.id == taskId); + if res is not null. + if (res != null) \{ + final updatedtaskJson = res.data!['updateTask'] as Map\; + final index = _tasks.indexWhere((task) =\> task.id == taskId); if (index == -1) return false; final updatedtask = Task.fromJson(updatedtaskJson); updatedtask.event.title = _tasks[index].event.title; _tasks[index] = updatedtask; callbackNotifyListeners(); - // if successfully updated then return true. + if successfully updated then return true. return true; - } + \} return false; -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_task_service/TaskService/getTasksByUser.md b/docs/talawa-mobile-docs/services_task_service/TaskService/getTasksByUser.md index ce9e59af3c6..a3b97b6b0d1 100644 --- a/docs/talawa-mobile-docs/services_task_service/TaskService/getTasksByUser.md +++ b/docs/talawa-mobile-docs/services_task_service/TaskService/getTasksByUser.md @@ -10,34 +10,34 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> getTasksByUser +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> getTasksByUser () -

This function is used to fetch and return all tasks added by the current user.

+\This function is used to fetch and return all tasks added by the current user.\ ## Implementation ```dart -Future getTasksByUser() async { +Future\ getTasksByUser() async \{ await _databaseMutationFunctions .refreshAccessToken(_userConfig.currentUser.refreshToken!); final res = await _databaseMutationFunctions .gqlNonAuthQuery(TaskQueries.userTasks(_userConfig.currentUser.id!)); - if (res != null) { + if (res != null) \{ _tasks.clear(); final tasksList = res.data!['tasksByUser'] as List; - tasksList.forEach((task) { - _tasks.add(Task.fromJson(task as Map)); - }); - } -} + tasksList.forEach((task) \{ + _tasks.add(Task.fromJson(task as Map\)); + \}); + \} +\} ``` diff --git a/docs/talawa-mobile-docs/services_task_service/TaskService/getTasksForEvent.md b/docs/talawa-mobile-docs/services_task_service/TaskService/getTasksForEvent.md index 21536bf75fb..1798cb17596 100644 --- a/docs/talawa-mobile-docs/services_task_service/TaskService/getTasksForEvent.md +++ b/docs/talawa-mobile-docs/services_task_service/TaskService/getTasksForEvent.md @@ -10,38 +10,38 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> getTasksForEvent -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> getTasksForEvent +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId) -

This function is used to get all the tasks for the event.

-

params:

-
    -
  • eventId : id of an event for which tasks need to fetched,
  • -
+\This function is used to get all the tasks for the event.\ +\params:\ +\ +\\eventId\ : id of an event for which tasks need to fetched,\ +\ ## Implementation ```dart -Future getTasksForEvent(String eventId) async { +Future\ getTasksForEvent(String eventId) async \{ await _databaseMutationFunctions .refreshAccessToken(_userConfig.currentUser.refreshToken!); final res = await _databaseMutationFunctions .gqlNonAuthQuery(TaskQueries.eventTasks(eventId)); - if (res != null) { + if (res != null) \{ _tasks.clear(); final tasksList = res.data!['tasksByEvent'] as List; - tasksList.forEach((task) { - _tasks.add(Task.fromJson(task as Map)); - }); - } -} + tasksList.forEach((task) \{ + _tasks.add(Task.fromJson(task as Map\)); + \}); + \} +\} ``` diff --git a/docs/talawa-mobile-docs/services_task_service/TaskService/tasks.md b/docs/talawa-mobile-docs/services_task_service/TaskService/tasks.md index aad6505b3b7..d0e178425df 100644 --- a/docs/talawa-mobile-docs/services_task_service/TaskService/tasks.md +++ b/docs/talawa-mobile-docs/services_task_service/TaskService/tasks.md @@ -11,7 +11,7 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Task](../../models_task_task_model/Task-class.md)> tasks +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Task](../../models_task_task_model/Task-class.md)\> tasks @@ -23,7 +23,7 @@ ## Implementation ```dart -List get tasks => _tasks; +List\ get tasks =\> _tasks; ``` diff --git a/docs/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService-class.md b/docs/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService-class.md index 318a00e2358..132b4f2622f 100644 --- a/docs/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService-class.md +++ b/docs/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService-class.md @@ -11,13 +11,13 @@ -

This is a third party service which provide the service to select the image from.

-

gallery and then image can be cropped as well.

-

Services include:

-
    -
  • getPhotoFromGallery - Used to select photo from gallery.
  • -
  • cropImage - Used to crop the selected image.
  • -
+\This is a third party service which provide the service to select the image from.\ +\gallery and then image can be cropped as well.\ +\Services include:\ +\ +\\getPhotoFromGallery\ - Used to select photo from gallery.\ +\\cropImage\ - Used to crop the selected image.\ +\ @@ -31,30 +31,30 @@ ## Properties -##### [fileStream](../services_third_party_service_multi_media_pick_service/MultiMediaPickerService/fileStream.md) → [Stream](https://api.flutter.dev/flutter/dart-async/Stream-class.html) +##### [fileStream](../services_third_party_service_multi_media_pick_service/MultiMediaPickerService/fileStream.md) → [Stream](https:api.flutter.dev/flutter/dart-async/Stream-class.html) This function returns the stream of files. -_read-only_ +_\read-only\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -62,7 +62,7 @@ _read-onlyinherited_ ## Methods -##### [cropImage](../services_third_party_service_multi_media_pick_service/MultiMediaPickerService/cropImage.md)({required [File](https://api.flutter.dev/flutter/dart-io/File-class.html) imageFile}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[File](https://api.flutter.dev/flutter/dart-io/File-class.html)?> +##### [cropImage](../services_third_party_service_multi_media_pick_service/MultiMediaPickerService/cropImage.md)(\{required [File](https:api.flutter.dev/flutter/dart-io/File-class.html) imageFile\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[File](https:api.flutter.dev/flutter/dart-io/File-class.html)?\> @@ -71,7 +71,7 @@ This function is used to crop the image selected by the user. -##### [getPhotoFromGallery](../services_third_party_service_multi_media_pick_service/MultiMediaPickerService/getPhotoFromGallery.md)({[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) camera = false}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[File](https://api.flutter.dev/flutter/dart-io/File-class.html)?> +##### [getPhotoFromGallery](../services_third_party_service_multi_media_pick_service/MultiMediaPickerService/getPhotoFromGallery.md)(\{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) camera = false\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[File](https:api.flutter.dev/flutter/dart-io/File-class.html)?\> @@ -80,21 +80,21 @@ This function is used to pick the image from gallery or to click the image from -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -102,12 +102,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/MultiMediaPickerService.md b/docs/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/MultiMediaPickerService.md index 28c50264b93..457e0c384b1 100644 --- a/docs/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/MultiMediaPickerService.md +++ b/docs/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/MultiMediaPickerService.md @@ -18,10 +18,10 @@ MultiMediaPickerService() ## Implementation ```dart -MultiMediaPickerService() { - _picker = locator(); +MultiMediaPickerService() \{ + _picker = locator\(); _fileStream = _fileStreamController.stream.asBroadcastStream(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/cropImage.md b/docs/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/cropImage.md index fdff8f3c195..2dc171fddd5 100644 --- a/docs/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/cropImage.md +++ b/docs/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/cropImage.md @@ -10,33 +10,33 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[File](https://api.flutter.dev/flutter/dart-io/File-class.html)?> cropImage -({required [File](https://api.flutter.dev/flutter/dart-io/File-class.html) imageFile}) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[File](https:api.flutter.dev/flutter/dart-io/File-class.html)?\> cropImage +(\{required [File](https:api.flutter.dev/flutter/dart-io/File-class.html) imageFile\}) -

This function is used to crop the image selected by the user.

-

The function accepts a File type image and returns File type of cropped image.

-

params:

-
    -
  • imageFile: the image file to be cropped.
  • -
-

returns:

-
    -
  • Future<File?>: the image after been cropped.
  • -
+\This function is used to crop the image selected by the user.\ +\The function accepts a \File\ type image and returns \File\ type of cropped image.\ +\\params\:\ +\ +\\imageFile\: the image file to be cropped.\ +\ +\\returns\:\ +\ +\\Future<File?>\: the image after been cropped.\ +\ ## Implementation ```dart -Future cropImage({required File imageFile}) async { - // try, to crop the image and returns a File with cropped image path. - try { - final CroppedFile? croppedImage = await locator().cropImage( +Future\ cropImage(\{required File imageFile\}) async \{ + try, to crop the image and returns a File with cropped image path. + try \{ + final CroppedFile? croppedImage = await locator\().cropImage( sourcePath: imageFile.path, aspectRatioPresets: [ CropAspectRatioPreset.square, @@ -57,16 +57,16 @@ Future cropImage({required File imageFile}) async { ) ], ); - if (croppedImage != null) { + if (croppedImage != null) \{ return File(croppedImage.path); - } - } catch (e) { + \} + \} catch (e) \{ print( "MultiMediaPickerService : Exception occurred while cropping Image", ); - } + \} return null; -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/fileStream.md b/docs/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/fileStream.md index 71d2ea7a2f9..d2508db677d 100644 --- a/docs/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/fileStream.md +++ b/docs/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/fileStream.md @@ -11,26 +11,26 @@ -[Stream](https://api.flutter.dev/flutter/dart-async/Stream-class.html) fileStream +[Stream](https:api.flutter.dev/flutter/dart-async/Stream-class.html) fileStream -

This function returns the stream of files.

-

params: -None.

-

returns:

-
    -
  • Stream<dynamic>: Stream of files.
  • -
+\This function returns the stream of files.\ +\params: +None.\ +\returns:\ +\ +\\Stream<dynamic>\: Stream of files.\ +\ ## Implementation ```dart -Stream get fileStream => _fileStream; +Stream get fileStream =\> _fileStream; ``` diff --git a/docs/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/getPhotoFromGallery.md b/docs/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/getPhotoFromGallery.md index d97759f541a..50ec074599a 100644 --- a/docs/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/getPhotoFromGallery.md +++ b/docs/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/getPhotoFromGallery.md @@ -10,64 +10,64 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[File](https://api.flutter.dev/flutter/dart-io/File-class.html)?> getPhotoFromGallery -({[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) camera = false}) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[File](https:api.flutter.dev/flutter/dart-io/File-class.html)?\> getPhotoFromGallery +(\{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) camera = false\}) -

This function is used to pick the image from gallery or to click the image from user's camera.

-

The function first ask for the permission to access the camera, if denied then returns a message in.

-

custom Dialog Box. This function returns a File type for which camera variable is false by default.

-

params:

-
    -
  • camera: if true then open camera for image, else open gallery to select image.
  • -
-

returns:

-
    -
  • Future<File?>: the image the user choosed.
  • -
+\This function is used to pick the image from gallery or to click the image from user's camera.\ +\The function first ask for the permission to access the camera, if denied then returns a message in.\ +\custom Dialog Box. This function returns a File type for which \camera\ variable is false by default.\ +\\params\:\ +\ +\\camera\: if true then open camera for image, else open gallery to select image.\ +\ +\\returns\:\ +\ +\\Future<File?>\: the image the user choosed.\ +\ ## Implementation ```dart -Future getPhotoFromGallery({bool camera = false}) async { - // asking for user's camera access permission. - try { - // checking for the image source, it could be camera or gallery. +Future\ getPhotoFromGallery(\{bool camera = false\}) async \{ + asking for user's camera access permission. + try \{ + checking for the image source, it could be camera or gallery. final image = await _picker.pickImage( source: camera ? ImageSource.camera : ImageSource.gallery, ); - // if image is selected or not null, call the cropImage function that provide service to crop the selected image. - if (image != null) { + if image is selected or not null, call the cropImage function that provide service to crop the selected image. + if (image != null) \{ return await cropImage(imageFile: File(image.path)); - } - } catch (e) { - // if the permission denied or error occurs. - if (e is PlatformException && e.code == 'camera_access_denied') { - // push the dialog alert with the message. - locator().pushDialog( + \} + \} catch (e) \{ + if the permission denied or error occurs. + if (e is PlatformException && e.code == 'camera_access_denied') \{ + push the dialog alert with the message. + locator\().pushDialog( CustomAlertDialog( - success: () { - locator().pop(); + success: () \{ + locator\().pop(); openAppSettings(); - }, + \}, dialogTitle: 'Permission Denied', successText: 'SETTINGS', dialogSubTitle: "Camera permission is required, to use this feature, give permission from app settings", ), ); - } + \} print( "MultiMediaPickerService : Exception occurred while choosing photo from the gallery $e", ); - } + \} return null; -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_user_config/UserConfig-class.md b/docs/talawa-mobile-docs/services_user_config/UserConfig-class.md index 01c67b0d42b..673583472a4 100644 --- a/docs/talawa-mobile-docs/services_user_config/UserConfig-class.md +++ b/docs/talawa-mobile-docs/services_user_config/UserConfig-class.md @@ -11,17 +11,17 @@ -

UserConfig class provides different services in the context of the User.

-

Services include:

-
    -
  • userLoggedIn : helps to make user logged in to the application.
  • -
  • updateUserJoinedOrg : helps to update the user joined organization.
  • -
  • updateUserCreatedOrg : helps to update the user created organization.
  • -
  • updateUserMemberRequestOrg : helps to update the User membership request for the organization.
  • -
  • updateUserAdminOrg : helps to update the Admin of the Organization.
  • -
  • updateAccessToken : helps to update the access token of an user.
  • -
  • updateUser : helps to update the user.
  • -
+\UserConfig class provides different services in the context of the User.\ +\Services include:\ +\ +\\userLoggedIn\ : helps to make user logged in to the application.\ +\\updateUserJoinedOrg\ : helps to update the user joined organization.\ +\\updateUserCreatedOrg\ : helps to update the user created organization.\ +\\updateUserMemberRequestOrg\ : helps to update the User membership request for the organization.\ +\\updateUserAdminOrg\ : helps to update the Admin of the Organization.\ +\\updateAccessToken\ : helps to update the access token of an user.\ +\\updateUser\ : helps to update the user.\ +\ @@ -40,34 +40,34 @@ -_read / write_ +_\read / write\_ -##### [currentOrgInfoController](../services_user_config/UserConfig/currentOrgInfoController.md) → [StreamController](https://api.flutter.dev/flutter/dart-async/StreamController-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)> +##### [currentOrgInfoController](../services_user_config/UserConfig/currentOrgInfoController.md) → [StreamController](https:api.flutter.dev/flutter/dart-async/StreamController-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)\> -_read-only_ +_\read-only\_ -##### [currentOrgInfoStream](../services_user_config/UserConfig/currentOrgInfoStream.md) → [Stream](https://api.flutter.dev/flutter/dart-async/Stream-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)> +##### [currentOrgInfoStream](../services_user_config/UserConfig/currentOrgInfoStream.md) → [Stream](https:api.flutter.dev/flutter/dart-async/Stream-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)\> -_read-only_ +_\read-only\_ -##### [currentOrgName](../services_user_config/UserConfig/currentOrgName.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [currentOrgName](../services_user_config/UserConfig/currentOrgName.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_read-only_ +_\read-only\_ @@ -76,25 +76,25 @@ _read-only_ -_read / write_ +_\read / write\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -111,12 +111,12 @@ _read-onlyinherited_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ @@ -138,16 +138,16 @@ _inherited_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [updateAccessToken](../services_user_config/UserConfig/updateAccessToken.md)({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) accessToken, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) refreshToken}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) +##### [updateAccessToken](../services_user_config/UserConfig/updateAccessToken.md)(\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) accessToken, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) refreshToken\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) @@ -156,7 +156,7 @@ This function is used to updated the access token of the user. -##### [updateUser](../services_user_config/UserConfig/updateUser.md)([User](../models_user_user_info/User-class.md) updatedUserDetails) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)> +##### [updateUser](../services_user_config/UserConfig/updateUser.md)([User](../models_user_user_info/User-class.md) updatedUserDetails) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)\> @@ -165,7 +165,7 @@ This function is used to update the user details. -##### [updateUserAdminOrg](../services_user_config/UserConfig/updateUserAdminOrg.md)([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)> orgDetails) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) +##### [updateUserAdminOrg](../services_user_config/UserConfig/updateUserAdminOrg.md)([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)\> orgDetails) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) @@ -174,7 +174,7 @@ This function is used to update the organization admin. -##### [updateUserCreatedOrg](../services_user_config/UserConfig/updateUserCreatedOrg.md)([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)> orgDetails) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) +##### [updateUserCreatedOrg](../services_user_config/UserConfig/updateUserCreatedOrg.md)([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)\> orgDetails) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) @@ -183,7 +183,7 @@ This function is used to update the user created organization. -##### [updateUserJoinedOrg](../services_user_config/UserConfig/updateUserJoinedOrg.md)([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)> orgDetails) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) +##### [updateUserJoinedOrg](../services_user_config/UserConfig/updateUserJoinedOrg.md)([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)\> orgDetails) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) @@ -192,7 +192,7 @@ This function is used to update the user joined organization. -##### [updateUserMemberRequestOrg](../services_user_config/UserConfig/updateUserMemberRequestOrg.md)([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)> orgDetails) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) +##### [updateUserMemberRequestOrg](../services_user_config/UserConfig/updateUserMemberRequestOrg.md)([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)\> orgDetails) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) @@ -201,7 +201,7 @@ This function is used to update the user request to join the organization. -##### [userLoggedIn](../services_user_config/UserConfig/userLoggedIn.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)> +##### [userLoggedIn](../services_user_config/UserConfig/userLoggedIn.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)\> @@ -214,12 +214,12 @@ This function is used to log in the user. ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/services_user_config/UserConfig/currentOrg.md b/docs/talawa-mobile-docs/services_user_config/UserConfig/currentOrg.md index a83a2ef4967..33f215df3ce 100644 --- a/docs/talawa-mobile-docs/services_user_config/UserConfig/currentOrg.md +++ b/docs/talawa-mobile-docs/services_user_config/UserConfig/currentOrg.md @@ -23,7 +23,7 @@ ## Implementation ```dart -OrgInfo get currentOrg => _currentOrg!; +OrgInfo get currentOrg =\> _currentOrg!; ``` @@ -42,7 +42,7 @@ currentOrg= ## Implementation ```dart -set currentOrg(OrgInfo org) => _currentOrg = org; +set currentOrg(OrgInfo org) =\> _currentOrg = org; ``` diff --git a/docs/talawa-mobile-docs/services_user_config/UserConfig/currentOrgInfoController.md b/docs/talawa-mobile-docs/services_user_config/UserConfig/currentOrgInfoController.md index 6fccf53f6c3..7383ebbb810 100644 --- a/docs/talawa-mobile-docs/services_user_config/UserConfig/currentOrgInfoController.md +++ b/docs/talawa-mobile-docs/services_user_config/UserConfig/currentOrgInfoController.md @@ -11,7 +11,7 @@ -[StreamController](https://api.flutter.dev/flutter/dart-async/StreamController-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)> currentOrgInfoController +[StreamController](https:api.flutter.dev/flutter/dart-async/StreamController-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)\> currentOrgInfoController @@ -23,7 +23,7 @@ ## Implementation ```dart -StreamController get currentOrgInfoController => +StreamController\ get currentOrgInfoController =\> _currentOrgInfoController; ``` diff --git a/docs/talawa-mobile-docs/services_user_config/UserConfig/currentOrgInfoStream.md b/docs/talawa-mobile-docs/services_user_config/UserConfig/currentOrgInfoStream.md index 4a2a60ece5b..6690fe90b58 100644 --- a/docs/talawa-mobile-docs/services_user_config/UserConfig/currentOrgInfoStream.md +++ b/docs/talawa-mobile-docs/services_user_config/UserConfig/currentOrgInfoStream.md @@ -11,7 +11,7 @@ -[Stream](https://api.flutter.dev/flutter/dart-async/Stream-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)> currentOrgInfoStream +[Stream](https:api.flutter.dev/flutter/dart-async/Stream-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)\> currentOrgInfoStream @@ -23,7 +23,7 @@ ## Implementation ```dart -Stream get currentOrgInfoStream => _currentOrgInfoStream; +Stream\ get currentOrgInfoStream =\> _currentOrgInfoStream; ``` diff --git a/docs/talawa-mobile-docs/services_user_config/UserConfig/currentOrgName.md b/docs/talawa-mobile-docs/services_user_config/UserConfig/currentOrgName.md index 64d6a00c58c..45a96db6f88 100644 --- a/docs/talawa-mobile-docs/services_user_config/UserConfig/currentOrgName.md +++ b/docs/talawa-mobile-docs/services_user_config/UserConfig/currentOrgName.md @@ -11,7 +11,7 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) currentOrgName +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) currentOrgName @@ -23,7 +23,7 @@ ## Implementation ```dart -String get currentOrgName => _currentOrg!.name!; +String get currentOrgName =\> _currentOrg!.name!; ``` diff --git a/docs/talawa-mobile-docs/services_user_config/UserConfig/currentUser.md b/docs/talawa-mobile-docs/services_user_config/UserConfig/currentUser.md index 77f70037a9b..d277baa9a23 100644 --- a/docs/talawa-mobile-docs/services_user_config/UserConfig/currentUser.md +++ b/docs/talawa-mobile-docs/services_user_config/UserConfig/currentUser.md @@ -23,7 +23,7 @@ ## Implementation ```dart -User get currentUser => _currentUser!; +User get currentUser =\> _currentUser!; ``` @@ -42,9 +42,9 @@ currentUser= ## Implementation ```dart -set currentUser(User user) { +set currentUser(User user) \{ _currentUser = user; -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_user_config/UserConfig/initialiseStream.md b/docs/talawa-mobile-docs/services_user_config/UserConfig/initialiseStream.md index 0fda93269ca..0fe0c40b5e0 100644 --- a/docs/talawa-mobile-docs/services_user_config/UserConfig/initialiseStream.md +++ b/docs/talawa-mobile-docs/services_user_config/UserConfig/initialiseStream.md @@ -23,10 +23,10 @@ void initialiseStream ## Implementation ```dart -void initialiseStream() { +void initialiseStream() \{ _currentOrgInfoStream = _currentOrgInfoController.stream.asBroadcastStream(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_user_config/UserConfig/saveCurrentOrgInHive.md b/docs/talawa-mobile-docs/services_user_config/UserConfig/saveCurrentOrgInHive.md index 6eb038ac899..982e5635ed9 100644 --- a/docs/talawa-mobile-docs/services_user_config/UserConfig/saveCurrentOrgInHive.md +++ b/docs/talawa-mobile-docs/services_user_config/UserConfig/saveCurrentOrgInHive.md @@ -23,16 +23,16 @@ void saveCurrentOrgInHive ## Implementation ```dart -void saveCurrentOrgInHive(OrgInfo saveOrgAsCurrent) { +void saveCurrentOrgInHive(OrgInfo saveOrgAsCurrent) \{ _currentOrg = saveOrgAsCurrent; _currentOrgInfoController.add(_currentOrg!); - final box = Hive.box('currentOrg'); - if (box.get('org') == null) { + final box = Hive.box\('currentOrg'); + if (box.get('org') == null) \{ box.put('org', _currentOrg!); - } else { + \} else \{ box.put('org', _currentOrg!); - } -} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/services_user_config/UserConfig/saveUserInHive.md b/docs/talawa-mobile-docs/services_user_config/UserConfig/saveUserInHive.md index 53dcd9a8abf..012181b72fc 100644 --- a/docs/talawa-mobile-docs/services_user_config/UserConfig/saveUserInHive.md +++ b/docs/talawa-mobile-docs/services_user_config/UserConfig/saveUserInHive.md @@ -23,14 +23,14 @@ void saveUserInHive ## Implementation ```dart -void saveUserInHive() { - final box = Hive.box('currentUser'); - if (box.get('user') == null) { +void saveUserInHive() \{ + final box = Hive.box\('currentUser'); + if (box.get('user') == null) \{ box.put('user', _currentUser!); - } else { + \} else \{ box.put('user', _currentUser!); - } -} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/services_user_config/UserConfig/updateAccessToken.md b/docs/talawa-mobile-docs/services_user_config/UserConfig/updateAccessToken.md index 7d38a3491e0..98e9dfd3c6a 100644 --- a/docs/talawa-mobile-docs/services_user_config/UserConfig/updateAccessToken.md +++ b/docs/talawa-mobile-docs/services_user_config/UserConfig/updateAccessToken.md @@ -10,33 +10,33 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) updateAccessToken -({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) accessToken, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) refreshToken}) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) updateAccessToken +(\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) accessToken, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) refreshToken\}) -

This function is used to updated the access token of the user.

-

params:

-
    -
  • accessToken
  • -
  • refreshToken
  • -
+\This function is used to updated the access token of the user.\ +\params:\ +\ +\\accessToken\\ +\\refreshToken\\ +\ ## Implementation ```dart -Future updateAccessToken({ +Future updateAccessToken(\{ required String accessToken, required String refreshToken, -}) async { +\}) async \{ _currentUser!.refreshToken = refreshToken; _currentUser!.authToken = accessToken; saveUserInHive(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_user_config/UserConfig/updateUser.md b/docs/talawa-mobile-docs/services_user_config/UserConfig/updateUser.md index d10b9600b2d..c6312c18de1 100644 --- a/docs/talawa-mobile-docs/services_user_config/UserConfig/updateUser.md +++ b/docs/talawa-mobile-docs/services_user_config/UserConfig/updateUser.md @@ -10,36 +10,36 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)> updateUser +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)\> updateUser ([User](../../models_user_user_info/User-class.md) updatedUserDetails) -

This function is used to update the user details.

-

params:

-
    -
  • updatedUserDetails : User type variable containing all the details of an user need to be updated.
  • -
+\This function is used to update the user details.\ +\params:\ +\ +\\updatedUserDetails\ : \User\ type variable containing all the details of an user need to be updated.\ +\ ## Implementation ```dart -Future updateUser(User updatedUserDetails) async { - try { +Future\ updateUser(User updatedUserDetails) async \{ + try \{ _currentUser = updatedUserDetails; saveUserInHive(); graphqlConfig.getToken(); databaseFunctions.init(); return true; - } on Exception catch (e) { + \} on Exception catch (e) \{ debugPrint(e.toString()); return false; - } -} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/services_user_config/UserConfig/updateUserAdminOrg.md b/docs/talawa-mobile-docs/services_user_config/UserConfig/updateUserAdminOrg.md index 399b73f5edf..f0159c42987 100644 --- a/docs/talawa-mobile-docs/services_user_config/UserConfig/updateUserAdminOrg.md +++ b/docs/talawa-mobile-docs/services_user_config/UserConfig/updateUserAdminOrg.md @@ -10,28 +10,28 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) updateUserAdminOrg -([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)> orgDetails) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) updateUserAdminOrg +([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)\> orgDetails) -

This function is used to update the organization admin.

-

params:

-
    -
  • orgDetails : details of the organization.
  • -
+\This function is used to update the organization admin.\ +\params:\ +\ +\\orgDetails\ : details of the organization.\ +\ ## Implementation ```dart -Future updateUserAdminOrg(List orgDetails) async { +Future updateUserAdminOrg(List\ orgDetails) async \{ _currentUser!.updateAdminFor(orgDetails); saveUserInHive(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_user_config/UserConfig/updateUserCreatedOrg.md b/docs/talawa-mobile-docs/services_user_config/UserConfig/updateUserCreatedOrg.md index 36ff305c0bf..35b6f662769 100644 --- a/docs/talawa-mobile-docs/services_user_config/UserConfig/updateUserCreatedOrg.md +++ b/docs/talawa-mobile-docs/services_user_config/UserConfig/updateUserCreatedOrg.md @@ -10,28 +10,28 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) updateUserCreatedOrg -([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)> orgDetails) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) updateUserCreatedOrg +([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)\> orgDetails) -

This function is used to update the user created organization.

-

params:

-
    -
  • orgDetails : details of the organization that user created.
  • -
+\This function is used to update the user created organization.\ +\params:\ +\ +\\orgDetails\ : details of the organization that user created.\ +\ ## Implementation ```dart -Future updateUserCreatedOrg(List orgDetails) async { +Future updateUserCreatedOrg(List\ orgDetails) async \{ _currentUser!.updateCreatedOrg(orgDetails); saveUserInHive(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_user_config/UserConfig/updateUserJoinedOrg.md b/docs/talawa-mobile-docs/services_user_config/UserConfig/updateUserJoinedOrg.md index 2b99aa06aed..ff7e96173b3 100644 --- a/docs/talawa-mobile-docs/services_user_config/UserConfig/updateUserJoinedOrg.md +++ b/docs/talawa-mobile-docs/services_user_config/UserConfig/updateUserJoinedOrg.md @@ -10,28 +10,28 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) updateUserJoinedOrg -([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)> orgDetails) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) updateUserJoinedOrg +([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)\> orgDetails) -

This function is used to update the user joined organization.

-

params:

-
    -
  • orgDetails : details of the organization that user joined.
  • -
+\This function is used to update the user joined organization.\ +\params:\ +\ +\\orgDetails\ : details of the organization that user joined.\ +\ ## Implementation ```dart -Future updateUserJoinedOrg(List orgDetails) async { +Future updateUserJoinedOrg(List\ orgDetails) async \{ _currentUser!.updateJoinedOrg(orgDetails); saveUserInHive(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_user_config/UserConfig/updateUserMemberRequestOrg.md b/docs/talawa-mobile-docs/services_user_config/UserConfig/updateUserMemberRequestOrg.md index 8cef35b6af9..39f09c426a0 100644 --- a/docs/talawa-mobile-docs/services_user_config/UserConfig/updateUserMemberRequestOrg.md +++ b/docs/talawa-mobile-docs/services_user_config/UserConfig/updateUserMemberRequestOrg.md @@ -10,28 +10,28 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) updateUserMemberRequestOrg -([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)> orgDetails) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) updateUserMemberRequestOrg +([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)\> orgDetails) -

This function is used to update the user request to join the organization.

-

params:

-
    -
  • orgDetails : details of the organization that user requested to join.
  • -
+\This function is used to update the user request to join the organization.\ +\params:\ +\ +\\orgDetails\ : details of the organization that user requested to join.\ +\ ## Implementation ```dart -Future updateUserMemberRequestOrg(List orgDetails) async { +Future updateUserMemberRequestOrg(List\ orgDetails) async \{ _currentUser!.updateMemberRequestOrg(orgDetails); saveUserInHive(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/services_user_config/UserConfig/userLoggedIn.md b/docs/talawa-mobile-docs/services_user_config/UserConfig/userLoggedIn.md index 7ff776029e4..0221ab680b8 100644 --- a/docs/talawa-mobile-docs/services_user_config/UserConfig/userLoggedIn.md +++ b/docs/talawa-mobile-docs/services_user_config/UserConfig/userLoggedIn.md @@ -10,44 +10,44 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)> userLoggedIn +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)\> userLoggedIn () -

This function is used to log in the user.

+\This function is used to log in the user.\ ## Implementation ```dart -Future userLoggedIn() async { +Future\ userLoggedIn() async \{ initialiseStream(); - final boxUser = Hive.box('currentUser'); - final boxOrg = Hive.box('currentOrg'); + final boxUser = Hive.box\('currentUser'); + final boxOrg = Hive.box\('currentOrg'); _currentOrg = boxOrg.get('org') ?? OrgInfo(name: 'Organization Name', id: 'null'); _currentOrgInfoController.add(_currentOrg!); _currentUser = boxUser.get('user'); - // if there is not currentUser then returns false. - if (_currentUser == null) { + if there is not currentUser then returns false. + if (_currentUser == null) \{ _currentUser = User(id: 'null', authToken: 'null'); return false; - } - // generate access token - graphqlConfig.getToken().then((value) async { + \} + generate access token + graphqlConfig.getToken().then((value) async \{ databaseFunctions.init(); - try { + try \{ final QueryResult result = await databaseFunctions.gqlAuthQuery( queries.fetchUserInfo, - variables: {'id': currentUser.id}, + variables: \{'id': currentUser.id\}, ) as QueryResult; final User userInfo = User.fromJson( - result.data!['users'][0] as Map, + result.data!['users'][0] as Map\, fromOrg: true, ); userInfo.authToken = userConfig.currentUser.authToken; @@ -58,16 +58,16 @@ Future userLoggedIn() async { saveUserInHive(); return true; - } on Exception catch (e) { + \} on Exception catch (e) \{ print(e); navigationService.showTalawaErrorSnackBar( "Couldn't update User details", MessageType.error, ); - } - }); + \} + \}); return true; -} +\} ``` diff --git a/docs/talawa-mobile-docs/splash_screen/SplashScreen-class.md b/docs/talawa-mobile-docs/splash_screen/SplashScreen-class.md index ec5863795fc..e538d59a339 100644 --- a/docs/talawa-mobile-docs/splash_screen/SplashScreen-class.md +++ b/docs/talawa-mobile-docs/splash_screen/SplashScreen-class.md @@ -11,17 +11,17 @@ -

This widget return the SplashScreen. Splash Screen is the first screen that -we see when we run our application. It is also known as Launch Screen.

+\This widget return the SplashScreen. Splash Screen is the first screen that +we see when we run our application. It is also known as Launch Screen.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html) - SplashScreen @@ -33,46 +33,46 @@ we see when we run our application. It is also known as Launch Screen.

## Constructors -[SplashScreen](../splash_screen/SplashScreen/SplashScreen.md) ({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key, [int](https://api.flutter.dev/flutter/dart-core/int-class.html) mainScreenIndex = 0}) +[SplashScreen](../splash_screen/SplashScreen/SplashScreen.md) (\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key, [int](https:api.flutter.dev/flutter/dart-core/int-class.html) mainScreenIndex = 0\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [mainScreenIndex](../splash_screen/SplashScreen/mainScreenIndex.md) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [mainScreenIndex](../splash_screen/SplashScreen/mainScreenIndex.md) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -80,12 +80,12 @@ _read-onlyinherited_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a
StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ @@ -94,81 +94,81 @@ _inherited_ Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -176,12 +176,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/splash_screen/SplashScreen/SplashScreen.md b/docs/talawa-mobile-docs/splash_screen/SplashScreen/SplashScreen.md index f1eb432e839..8f5bf7d6c76 100644 --- a/docs/talawa-mobile-docs/splash_screen/SplashScreen/SplashScreen.md +++ b/docs/talawa-mobile-docs/splash_screen/SplashScreen/SplashScreen.md @@ -9,7 +9,7 @@ const -SplashScreen({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key, [int](https://api.flutter.dev/flutter/dart-core/int-class.html) mainScreenIndex = 0}) +SplashScreen(\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key, [int](https:api.flutter.dev/flutter/dart-core/int-class.html) mainScreenIndex = 0\}) @@ -18,7 +18,7 @@ SplashScreen({required [Key](https://api.flutter.dev/flutter/foundation/Key-clas ## Implementation ```dart -const SplashScreen({required Key key, this.mainScreenIndex = 0}) +const SplashScreen(\{required Key key, this.mainScreenIndex = 0\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/splash_screen/SplashScreen/createState.md b/docs/talawa-mobile-docs/splash_screen/SplashScreen/createState.md index 23428f6f61e..b8fd4f99ea3 100644 --- a/docs/talawa-mobile-docs/splash_screen/SplashScreen/createState.md +++ b/docs/talawa-mobile-docs/splash_screen/SplashScreen/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) _SplashScreenState createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations-class.md b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations-class.md index d54ee7ff25e..61f065c1bdd 100644 --- a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations-class.md +++ b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations-class.md @@ -11,54 +11,54 @@ -

This class provides methods to localize the application so that it can be available -to users with different languages.

+\This class provides methods to localize the application so that it can be available +to users with different languages.\ ## Constructors -[AppLocalizations](../utils_app_localization/AppLocalizations/AppLocalizations.md) ([Locale](https://api.flutter.dev/flutter/dart-ui/Locale-class.html) locale, {[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isTest = false}) +[AppLocalizations](../utils_app_localization/AppLocalizations/AppLocalizations.md) ([Locale](https:api.flutter.dev/flutter/dart-ui/Locale-class.html) locale, \{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isTest = false\}) ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isTest](../utils_app_localization/AppLocalizations/isTest.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isTest](../utils_app_localization/AppLocalizations/isTest.md) ↔ [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read / write_ +_\read / write\_ -##### [locale](../utils_app_localization/AppLocalizations/locale.md) → [Locale](https://api.flutter.dev/flutter/dart-ui/Locale-class.html) +##### [locale](../utils_app_localization/AppLocalizations/locale.md) → [Locale](https:api.flutter.dev/flutter/dart-ui/Locale-class.html) -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -66,7 +66,7 @@ _read-onlyinherited_ ## Methods -##### [load](../utils_app_localization/AppLocalizations/load.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)> +##### [load](../utils_app_localization/AppLocalizations/load.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)\> @@ -75,7 +75,7 @@ _read-onlyinherited_ -##### [loadTest](../utils_app_localization/AppLocalizations/loadTest.md)([Locale](https://api.flutter.dev/flutter/dart-ui/Locale-class.html) locale) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[AppLocalizations](../utils_app_localization/AppLocalizations-class.md)> +##### [loadTest](../utils_app_localization/AppLocalizations/loadTest.md)([Locale](https:api.flutter.dev/flutter/dart-ui/Locale-class.html) locale) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[AppLocalizations](../utils_app_localization/AppLocalizations-class.md)\> @@ -84,16 +84,16 @@ _read-onlyinherited_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [strictTranslate](../utils_app_localization/AppLocalizations/strictTranslate.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) key) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [strictTranslate](../utils_app_localization/AppLocalizations/strictTranslate.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) key) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -102,16 +102,16 @@ _inherited_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [translate](../utils_app_localization/AppLocalizations/translate.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html)? key) [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [translate](../utils_app_localization/AppLocalizations/translate.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html)? key) [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? @@ -124,12 +124,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ @@ -139,7 +139,7 @@ _inherited_ ## Static Methods -##### [of](../utils_app_localization/AppLocalizations/of.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [AppLocalizations](../utils_app_localization/AppLocalizations-class.md)? +##### [of](../utils_app_localization/AppLocalizations/of.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [AppLocalizations](../utils_app_localization/AppLocalizations-class.md)? @@ -153,7 +153,7 @@ _inherited_ ## Constants -##### [delegate](../utils_app_localization/AppLocalizations/delegate-constant.md) const [LocalizationsDelegate](https://api.flutter.dev/flutter/widgets/LocalizationsDelegate-class.html)<[AppLocalizations](../utils_app_localization/AppLocalizations-class.md)> +##### [delegate](../utils_app_localization/AppLocalizations/delegate-constant.md) const [LocalizationsDelegate](https:api.flutter.dev/flutter/widgets/LocalizationsDelegate-class.html)<[AppLocalizations](../utils_app_localization/AppLocalizations-class.md)\> diff --git a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/AppLocalizations.md b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/AppLocalizations.md index bb06e087a76..fa3c35a7e5f 100644 --- a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/AppLocalizations.md +++ b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/AppLocalizations.md @@ -9,7 +9,7 @@ -AppLocalizations([Locale](https://api.flutter.dev/flutter/dart-ui/Locale-class.html) locale, {[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isTest = false}) +AppLocalizations([Locale](https:api.flutter.dev/flutter/dart-ui/Locale-class.html) locale, \{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isTest = false\}) @@ -19,9 +19,9 @@ AppLocalizations([Locale](https://api.flutter.dev/flutter/dart-ui/Locale-class.h ```dart AppLocalizations( - this.locale, { + this.locale, \{ this.isTest = false, -}); +\}); ``` diff --git a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/delegate-constant.md b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/delegate-constant.md index 3725a88e1bf..c23792a7e62 100644 --- a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/delegate-constant.md +++ b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/delegate-constant.md @@ -9,7 +9,7 @@ -[LocalizationsDelegate](https://api.flutter.dev/flutter/widgets/LocalizationsDelegate-class.html)<[AppLocalizations](../../utils_app_localization/AppLocalizations-class.md)> const delegate +[LocalizationsDelegate](https:api.flutter.dev/flutter/widgets/LocalizationsDelegate-class.html)<[AppLocalizations](../../utils_app_localization/AppLocalizations-class.md)\> const delegate @@ -21,7 +21,7 @@ ## Implementation ```dart -static const LocalizationsDelegate delegate = +static const LocalizationsDelegate\ delegate = AppLocalizationsDelegate(); ``` diff --git a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/isTest.md b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/isTest.md index 9f3b4dc752c..5759752cfe5 100644 --- a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/isTest.md +++ b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/isTest.md @@ -9,9 +9,9 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isTest +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isTest -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/load.md b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/load.md index 9cfd30ec164..3f5aa2a9634 100644 --- a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/load.md +++ b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/load.md @@ -10,7 +10,7 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)> load +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)\> load () @@ -23,19 +23,19 @@ ## Implementation ```dart -Future load() async { - // Load the language JSON file from the "lang" folder +Future\ load() async \{ + Load the language JSON file from the "lang" folder final String jsonString = - await rootBundle.loadString('lang/${locale.languageCode}.json'); - final Map jsonMap = - json.decode(jsonString) as Map; + await rootBundle.loadString('lang/$\{locale.languageCode\}.json'); + final Map\ jsonMap = + json.decode(jsonString) as Map\; - _localizedStrings = jsonMap.map((key, value) { + _localizedStrings = jsonMap.map((key, value) \{ return MapEntry(key, value.toString()); - }); + \}); return true; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/loadTest.md b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/loadTest.md index 4f4197b0605..0de3b8bbcf6 100644 --- a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/loadTest.md +++ b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/loadTest.md @@ -10,8 +10,8 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[AppLocalizations](../../utils_app_localization/AppLocalizations-class.md)> loadTest -([Locale](https://api.flutter.dev/flutter/dart-ui/Locale-class.html) locale) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[AppLocalizations](../../utils_app_localization/AppLocalizations-class.md)\> loadTest +([Locale](https:api.flutter.dev/flutter/dart-ui/Locale-class.html) locale) @@ -23,9 +23,9 @@ ## Implementation ```dart -Future loadTest(Locale locale) async { +Future\ loadTest(Locale locale) async \{ return AppLocalizations(locale); -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/locale.md b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/locale.md index ba00de7965d..02e5e3fd405 100644 --- a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/locale.md +++ b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/locale.md @@ -9,9 +9,9 @@ -[Locale](https://api.flutter.dev/flutter/dart-ui/Locale-class.html) locale +[Locale](https:api.flutter.dev/flutter/dart-ui/Locale-class.html) locale -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/of.md b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/of.md index 492424bf7c9..b62a94ef3b7 100644 --- a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/of.md +++ b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/of.md @@ -11,7 +11,7 @@ [AppLocalizations](../../utils_app_localization/AppLocalizations-class.md)? of -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) @@ -23,9 +23,9 @@ ## Implementation ```dart -static AppLocalizations? of(BuildContext context) { - return Localizations.of(context, AppLocalizations); -} +static AppLocalizations? of(BuildContext context) \{ + return Localizations.of\(context, AppLocalizations); +\} ``` diff --git a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/strictTranslate.md b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/strictTranslate.md index e05a4107d42..b42d62613c5 100644 --- a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/strictTranslate.md +++ b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/strictTranslate.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) strictTranslate -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) key) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) strictTranslate +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) key) @@ -23,17 +23,17 @@ ## Implementation ```dart -String strictTranslate(String key) { +String strictTranslate(String key) \{ if (isTest) return key; - // ignore: unnecessary_null_comparison - if (key == null) { + ignore: unnecessary_null_comparison + if (key == null) \{ return '...'; - } + \} final String translate = _localizedStrings[key] ?? key; return translate; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/translate.md b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/translate.md index 0b741212277..06cf7785d39 100644 --- a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/translate.md +++ b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizations/translate.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? translate -([String](https://api.flutter.dev/flutter/dart-core/String-class.html)? key) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? translate +([String](https:api.flutter.dev/flutter/dart-core/String-class.html)? key) @@ -23,15 +23,15 @@ ## Implementation ```dart -String? translate(String? key) { +String? translate(String? key) \{ if (isTest) return key; - // ignore: unnecessary_null_comparison - if (key == null) { + ignore: unnecessary_null_comparison + if (key == null) \{ return '...'; - } + \} return _localizedStrings[key]; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate-class.md b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate-class.md index 0c6f3c2d004..8b18d40a674 100644 --- a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate-class.md +++ b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate-class.md @@ -16,8 +16,8 @@ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [LocalizationsDelegate](https://api.flutter.dev/flutter/widgets/LocalizationsDelegate-class.html)<[AppLocalizations](../utils_app_localization/AppLocalizations-class.md)> +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [LocalizationsDelegate](https:api.flutter.dev/flutter/widgets/LocalizationsDelegate-class.html)<[AppLocalizations](../utils_app_localization/AppLocalizations-class.md)\> - AppLocalizationsDelegate @@ -29,46 +29,46 @@ ## Constructors -[AppLocalizationsDelegate](../utils_app_localization/AppLocalizationsDelegate/AppLocalizationsDelegate.md) ({[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isTest = false}) +[AppLocalizationsDelegate](../utils_app_localization/AppLocalizationsDelegate/AppLocalizationsDelegate.md) (\{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isTest = false\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isTest](../utils_app_localization/AppLocalizationsDelegate/isTest.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isTest](../utils_app_localization/AppLocalizationsDelegate/isTest.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [type](https://api.flutter.dev/flutter/widgets/LocalizationsDelegate/type.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [type](https:api.flutter.dev/flutter/widgets/LocalizationsDelegate/type.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) -The type of the object returned by the
load method, T by default. -_read-onlyinherited_ +The type of the object returned by the \load\ method, T by default. +_\read-only\\inherited\_ @@ -76,50 +76,50 @@ _read-onlyinherited_ ## Methods -##### [isSupported](../utils_app_localization/AppLocalizationsDelegate/isSupported.md)([Locale](https://api.flutter.dev/flutter/dart-ui/Locale-class.html) locale) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isSupported](../utils_app_localization/AppLocalizationsDelegate/isSupported.md)([Locale](https:api.flutter.dev/flutter/dart-ui/Locale-class.html) locale) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether resources for the given locale can be loaded by this delegate. -_override_ +_\override\_ -##### [load](../utils_app_localization/AppLocalizationsDelegate/load.md)([Locale](https://api.flutter.dev/flutter/dart-ui/Locale-class.html) locale) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[AppLocalizations](../utils_app_localization/AppLocalizations-class.md)> +##### [load](../utils_app_localization/AppLocalizationsDelegate/load.md)([Locale](https:api.flutter.dev/flutter/dart-ui/Locale-class.html) locale) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[AppLocalizations](../utils_app_localization/AppLocalizations-class.md)\> -Start loading the resources for locale. The returned future completes +Start loading the resources for \locale\. The returned future completes when the resources have finished loading. -_override_ +_\override\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [shouldReload](../utils_app_localization/AppLocalizationsDelegate/shouldReload.md)(covariant [AppLocalizationsDelegate](../utils_app_localization/AppLocalizationsDelegate-class.md) old) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [shouldReload](../utils_app_localization/AppLocalizationsDelegate/shouldReload.md)(covariant [AppLocalizationsDelegate](../utils_app_localization/AppLocalizationsDelegate-class.md) old) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Returns true if the resources for this delegate should be loaded -again by calling the load method. -_override_ +again by calling the \load\ method. +_\override\_ -##### [toString](https://api.flutter.dev/flutter/widgets/LocalizationsDelegate/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/widgets/LocalizationsDelegate/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -127,12 +127,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/AppLocalizationsDelegate.md b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/AppLocalizationsDelegate.md index 3f42f908e1f..568fd792a43 100644 --- a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/AppLocalizationsDelegate.md +++ b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/AppLocalizationsDelegate.md @@ -9,7 +9,7 @@ const -AppLocalizationsDelegate({[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isTest = false}) +AppLocalizationsDelegate(\{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isTest = false\}) @@ -18,9 +18,9 @@ AppLocalizationsDelegate({[bool](https://api.flutter.dev/flutter/dart-core/bool- ## Implementation ```dart -const AppLocalizationsDelegate({ +const AppLocalizationsDelegate(\{ this.isTest = false, -}); +\}); ``` diff --git a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/isSupported.md b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/isSupported.md index e2529fec19d..d4c2a7e6644 100644 --- a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/isSupported.md +++ b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/isSupported.md @@ -9,18 +9,18 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isSupported -([Locale](https://api.flutter.dev/flutter/dart-ui/Locale-class.html) locale) +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isSupported +([Locale](https:api.flutter.dev/flutter/dart-ui/Locale-class.html) locale) -_override_ +_\override\_ -

Whether resources for the given locale can be loaded by this delegate.

-

Return true if the instance of T loaded by this delegate's load -method supports the given locale's language.

+\Whether resources for the given locale can be loaded by this delegate.\ +\Return true if the instance of \T\ loaded by this delegate's \load\ +method supports the given \locale\'s language.\ @@ -28,11 +28,11 @@ method supports the given locale's language.

```dart @override -bool isSupported(Locale locale) { - // Include all of your supported language codes here +bool isSupported(Locale locale) \{ + Include all of your supported language codes here return ['en', 'es', 'fr', 'hi', 'zh', 'de', 'ja', 'pt'] .contains(locale.languageCode); -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/isTest.md b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/isTest.md index e6e920cdab2..228df70eb7e 100644 --- a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/isTest.md +++ b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/isTest.md @@ -9,9 +9,9 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isTest +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isTest -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/load.md b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/load.md index 0e0684946e8..b5dee0adfb3 100644 --- a/docs/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/load.md +++ b/docs/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/load.md @@ -9,20 +9,20 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[AppLocalizations](../../utils_app_localization/AppLocalizations-class.md)> load -([Locale](https://api.flutter.dev/flutter/dart-ui/Locale-class.html) locale) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[AppLocalizations](../../utils_app_localization/AppLocalizations-class.md)\> load +([Locale](https:api.flutter.dev/flutter/dart-ui/Locale-class.html) locale) -_override_ +_\override\_ -

Start loading the resources for locale. The returned future completes -when the resources have finished loading.

-

It's assumed that this method will return an object that contains a +\Start loading the resources for \locale\. The returned future completes +when the resources have finished loading.\ +\It's assumed that this method will return an object that contains a collection of related string resources (typically defined with one method -per resource). The object will be retrieved with Localizations.of.

+per resource). The object will be retrieved with \Localizations.of\.\ @@ -30,18 +30,18 @@ per resource). The object will be retrieved with override_ +_\override\_ -

Returns true if the resources for this delegate should be loaded -again by calling the load method.

-

This method is called whenever its Localizations widget is +\Returns true if the resources for this delegate should be loaded +again by calling the \load\ method.\ +\This method is called whenever its \Localizations\ widget is rebuilt. If it returns true then dependent widgets will be rebuilt -after load has completed.

+after \load\ has completed.\ @@ -30,7 +30,7 @@ after lo ```dart @override -bool shouldReload(AppLocalizationsDelegate old) => false; +bool shouldReload(AppLocalizationsDelegate old) =\> false; ``` diff --git a/docs/talawa-mobile-docs/utils_chat_queries/ChatQueries-class.md b/docs/talawa-mobile-docs/utils_chat_queries/ChatQueries-class.md index 3c20eb991df..b44daf3e17d 100644 --- a/docs/talawa-mobile-docs/utils_chat_queries/ChatQueries-class.md +++ b/docs/talawa-mobile-docs/utils_chat_queries/ChatQueries-class.md @@ -11,7 +11,7 @@ -

This class creates the queries dealing with chats.

+\This class creates the queries dealing with chats.\ @@ -25,30 +25,30 @@ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [messageSentToDirectChatsubscription](../utils_chat_queries/ChatQueries/messageSentToDirectChatsubscription.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [messageSentToDirectChatsubscription](../utils_chat_queries/ChatQueries/messageSentToDirectChatsubscription.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_read-only_ +_\read-only\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -56,7 +56,7 @@ _read-onlyinherited_ ## Methods -##### [fetchDirectChatMessagesByChatId](../utils_chat_queries/ChatQueries/fetchDirectChatMessagesByChatId.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) chatId) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [fetchDirectChatMessagesByChatId](../utils_chat_queries/ChatQueries/fetchDirectChatMessagesByChatId.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) chatId) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -65,7 +65,7 @@ _read-onlyinherited_ -##### [fetchDirectChatsByUserId](../utils_chat_queries/ChatQueries/fetchDirectChatsByUserId.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) userId) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [fetchDirectChatsByUserId](../utils_chat_queries/ChatQueries/fetchDirectChatsByUserId.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) userId) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -74,16 +74,16 @@ _read-onlyinherited_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [sendMessageToDirectChat](../utils_chat_queries/ChatQueries/sendMessageToDirectChat.md)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [sendMessageToDirectChat](../utils_chat_queries/ChatQueries/sendMessageToDirectChat.md)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -92,12 +92,12 @@ _inherited_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -105,12 +105,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/utils_chat_queries/ChatQueries/fetchDirectChatMessagesByChatId.md b/docs/talawa-mobile-docs/utils_chat_queries/ChatQueries/fetchDirectChatMessagesByChatId.md index c18224b70cc..572f31680f1 100644 --- a/docs/talawa-mobile-docs/utils_chat_queries/ChatQueries/fetchDirectChatMessagesByChatId.md +++ b/docs/talawa-mobile-docs/utils_chat_queries/ChatQueries/fetchDirectChatMessagesByChatId.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) fetchDirectChatMessagesByChatId -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) chatId) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) fetchDirectChatMessagesByChatId +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) chatId) @@ -23,26 +23,26 @@ ## Implementation ```dart -String fetchDirectChatMessagesByChatId(String chatId) { +String fetchDirectChatMessagesByChatId(String chatId) \{ return ''' - query { - directChatsMessagesByChatID(id: "$chatId") { + query \{ + directChatsMessagesByChatID(id: "$chatId") \{ _id messageContent - sender { + sender \{ _id firstName image - } - receiver { + \} + receiver \{ _id firstName image - } - } - } + \} + \} + \} '''; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_chat_queries/ChatQueries/fetchDirectChatsByUserId.md b/docs/talawa-mobile-docs/utils_chat_queries/ChatQueries/fetchDirectChatsByUserId.md index 37412a513ba..050fcef45a3 100644 --- a/docs/talawa-mobile-docs/utils_chat_queries/ChatQueries/fetchDirectChatsByUserId.md +++ b/docs/talawa-mobile-docs/utils_chat_queries/ChatQueries/fetchDirectChatsByUserId.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) fetchDirectChatsByUserId -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) userId) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) fetchDirectChatsByUserId +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) userId) @@ -23,20 +23,20 @@ ## Implementation ```dart -String fetchDirectChatsByUserId(String userId) { +String fetchDirectChatsByUserId(String userId) \{ return ''' - query { - directChatsByUserID(id: "$userId") { + query \{ + directChatsByUserID(id: "$userId") \{ _id - users{ + users\{ _id firstName email - } - } - } + \} + \} + \} '''; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_chat_queries/ChatQueries/messageSentToDirectChatsubscription.md b/docs/talawa-mobile-docs/utils_chat_queries/ChatQueries/messageSentToDirectChatsubscription.md index 9a57c45daf2..0c8ba75f2f3 100644 --- a/docs/talawa-mobile-docs/utils_chat_queries/ChatQueries/messageSentToDirectChatsubscription.md +++ b/docs/talawa-mobile-docs/utils_chat_queries/ChatQueries/messageSentToDirectChatsubscription.md @@ -11,7 +11,7 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) messageSentToDirectChatsubscription +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) messageSentToDirectChatsubscription @@ -23,23 +23,23 @@ ## Implementation ```dart -String get messageSentToDirectChatsubscription => ''' - subscription{ - messageSentToDirectChat{ +String get messageSentToDirectChatsubscription =\> ''' + subscription\{ + messageSentToDirectChat\{ _id messageContent - sender { + sender \{ _id firstName image - } - receiver { + \} + receiver \{ _id firstName image - } - } - } + \} + \} + \} '''; ``` diff --git a/docs/talawa-mobile-docs/utils_chat_queries/ChatQueries/sendMessageToDirectChat.md b/docs/talawa-mobile-docs/utils_chat_queries/ChatQueries/sendMessageToDirectChat.md index 55f02800438..df94074c31c 100644 --- a/docs/talawa-mobile-docs/utils_chat_queries/ChatQueries/sendMessageToDirectChat.md +++ b/docs/talawa-mobile-docs/utils_chat_queries/ChatQueries/sendMessageToDirectChat.md @@ -10,7 +10,7 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) sendMessageToDirectChat +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) sendMessageToDirectChat () @@ -23,27 +23,27 @@ ## Implementation ```dart -String sendMessageToDirectChat() { +String sendMessageToDirectChat() \{ return ''' mutation sendMessageToDirectChat( \$chatId: ID! \$messageContent: String! - ){ + )\{ sendMessageToDirectChat( chatId: \$chatId messageContent: \$messageContent - ) { + ) \{ messageContent - sender{ + sender\{ firstName - } - receiver{ + \} + receiver\{ firstName - } - } - } + \} + \} + \} '''; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_comment_queries/CommentQueries-class.md b/docs/talawa-mobile-docs/utils_comment_queries/CommentQueries-class.md index f3218294785..3d0578b7dfc 100644 --- a/docs/talawa-mobile-docs/utils_comment_queries/CommentQueries-class.md +++ b/docs/talawa-mobile-docs/utils_comment_queries/CommentQueries-class.md @@ -11,7 +11,7 @@ -

This class creates the queries dealing with comments.

+\This class creates the queries dealing with comments.\ @@ -25,21 +25,21 @@ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -47,7 +47,7 @@ _read-onlyinherited_ ## Methods -##### [createComment](../utils_comment_queries/CommentQueries/createComment.md)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [createComment](../utils_comment_queries/CommentQueries/createComment.md)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -56,7 +56,7 @@ _read-onlyinherited_ -##### [getPostsComments](../utils_comment_queries/CommentQueries/getPostsComments.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) postId) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [getPostsComments](../utils_comment_queries/CommentQueries/getPostsComments.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) postId) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -65,21 +65,21 @@ _read-onlyinherited_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -87,12 +87,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/utils_comment_queries/CommentQueries/createComment.md b/docs/talawa-mobile-docs/utils_comment_queries/CommentQueries/createComment.md index 3557c7507e3..7274e7ce896 100644 --- a/docs/talawa-mobile-docs/utils_comment_queries/CommentQueries/createComment.md +++ b/docs/talawa-mobile-docs/utils_comment_queries/CommentQueries/createComment.md @@ -10,7 +10,7 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) createComment +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) createComment () @@ -23,19 +23,19 @@ ## Implementation ```dart -String createComment() { +String createComment() \{ return """ - mutation createComment(\$postId: ID!, \$text: String!) { + mutation createComment(\$postId: ID!, \$text: String!) \{ createComment(postId: \$postId, - data:{ + data:\{ text: \$text, - } - ){ + \} + )\{ _id - } - } + \} + \} """; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_comment_queries/CommentQueries/getPostsComments.md b/docs/talawa-mobile-docs/utils_comment_queries/CommentQueries/getPostsComments.md index b497be68ecb..bc5547b646d 100644 --- a/docs/talawa-mobile-docs/utils_comment_queries/CommentQueries/getPostsComments.md +++ b/docs/talawa-mobile-docs/utils_comment_queries/CommentQueries/getPostsComments.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) getPostsComments -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) postId) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) getPostsComments +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) postId) @@ -23,21 +23,21 @@ ## Implementation ```dart -String getPostsComments(String postId) { +String getPostsComments(String postId) \{ return """ - query{ - commentsByPost(id: "$postId"){ + query\{ + commentsByPost(id: "$postId")\{ _id text createdAt - creator{ + creator\{ firstName lastName - } - } - } + \} + \} + \} """; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_event_queries/EventQueries-class.md b/docs/talawa-mobile-docs/utils_event_queries/EventQueries-class.md index 102d424219d..8a989f2ca0c 100644 --- a/docs/talawa-mobile-docs/utils_event_queries/EventQueries-class.md +++ b/docs/talawa-mobile-docs/utils_event_queries/EventQueries-class.md @@ -11,7 +11,7 @@ -

This class creates queries related to the events.

+\This class creates queries related to the events.\ @@ -25,21 +25,21 @@ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -47,7 +47,7 @@ _read-onlyinherited_ ## Methods -##### [addEvent](../utils_event_queries/EventQueries/addEvent.md)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [addEvent](../utils_event_queries/EventQueries/addEvent.md)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -56,7 +56,7 @@ _read-onlyinherited_ -##### [deleteEvent](../utils_event_queries/EventQueries/deleteEvent.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) id) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [deleteEvent](../utils_event_queries/EventQueries/deleteEvent.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) id) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -65,7 +65,7 @@ _read-onlyinherited_ -##### [fetchOrgEvents](../utils_event_queries/EventQueries/fetchOrgEvents.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [fetchOrgEvents](../utils_event_queries/EventQueries/fetchOrgEvents.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) orgId) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -74,16 +74,16 @@ _read-onlyinherited_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [registerForEvent](../utils_event_queries/EventQueries/registerForEvent.md)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [registerForEvent](../utils_event_queries/EventQueries/registerForEvent.md)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -92,7 +92,7 @@ _inherited_ -##### [registrantsByEvent](../utils_event_queries/EventQueries/registrantsByEvent.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [registrantsByEvent](../utils_event_queries/EventQueries/registrantsByEvent.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -101,16 +101,16 @@ _inherited_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [updateEvent](../utils_event_queries/EventQueries/updateEvent.md)({dynamic eventId}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [updateEvent](../utils_event_queries/EventQueries/updateEvent.md)(\{dynamic eventId\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -123,12 +123,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/utils_event_queries/EventQueries/addEvent.md b/docs/talawa-mobile-docs/utils_event_queries/EventQueries/addEvent.md index d82a4ff80a7..cadc74fefe5 100644 --- a/docs/talawa-mobile-docs/utils_event_queries/EventQueries/addEvent.md +++ b/docs/talawa-mobile-docs/utils_event_queries/EventQueries/addEvent.md @@ -10,7 +10,7 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) addEvent +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) addEvent () @@ -23,7 +23,7 @@ ## Implementation ```dart -String addEvent() { +String addEvent() \{ return """ mutation createEvent( \$organizationId: ID!, \$title:String!, @@ -37,9 +37,9 @@ String addEvent() { \$location: String, \$startDate : Date!, \$endDate : Date!, - ) { + ) \{ createEvent( - data:{ + data:\{ organizationId: \$organizationId, title: \$title, description: \$description, @@ -52,15 +52,15 @@ String addEvent() { startDate: \$startDate, endDate: \$endDate, location: \$location, - } - ){ + \} + )\{ _id title description - } - } + \} + \} """; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_event_queries/EventQueries/deleteEvent.md b/docs/talawa-mobile-docs/utils_event_queries/EventQueries/deleteEvent.md index fd57a07e38d..28a52cbfa4a 100644 --- a/docs/talawa-mobile-docs/utils_event_queries/EventQueries/deleteEvent.md +++ b/docs/talawa-mobile-docs/utils_event_queries/EventQueries/deleteEvent.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) deleteEvent -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) id) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) deleteEvent +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) id) @@ -23,17 +23,17 @@ ## Implementation ```dart -String deleteEvent(String id) { +String deleteEvent(String id) \{ return """ - mutation { + mutation \{ removeEvent( id: "$id", - ){ + )\{ _id - } - } + \} + \} """; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_event_queries/EventQueries/fetchOrgEvents.md b/docs/talawa-mobile-docs/utils_event_queries/EventQueries/fetchOrgEvents.md index 9c6a6308f6a..5349b5beffc 100644 --- a/docs/talawa-mobile-docs/utils_event_queries/EventQueries/fetchOrgEvents.md +++ b/docs/talawa-mobile-docs/utils_event_queries/EventQueries/fetchOrgEvents.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) fetchOrgEvents -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) fetchOrgEvents +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) orgId) @@ -23,15 +23,15 @@ ## Implementation ```dart -String fetchOrgEvents(String orgId) { +String fetchOrgEvents(String orgId) \{ return """ - query { - eventsByOrganization(id: "$orgId"){ + query \{ + eventsByOrganization(id: "$orgId")\{ _id - organization { + organization \{ _id image - } + \} title description isPublic @@ -44,24 +44,24 @@ String fetchOrgEvents(String orgId) { startTime endTime location - creator{ + creator\{ _id firstName lastName - } - admins { + \} + admins \{ firstName lastName - } - registrants { - user { + \} + registrants \{ + user \{ _id - } - } - } - } + \} + \} + \} + \} """; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_event_queries/EventQueries/registerForEvent.md b/docs/talawa-mobile-docs/utils_event_queries/EventQueries/registerForEvent.md index c9910571084..bea9b040019 100644 --- a/docs/talawa-mobile-docs/utils_event_queries/EventQueries/registerForEvent.md +++ b/docs/talawa-mobile-docs/utils_event_queries/EventQueries/registerForEvent.md @@ -10,7 +10,7 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) registerForEvent +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) registerForEvent () @@ -23,18 +23,18 @@ ## Implementation ```dart -String registerForEvent() { +String registerForEvent() \{ return """ - mutation registerForEvent(\$eventId: ID!) { + mutation registerForEvent(\$eventId: ID!) \{ registerForEvent(id: \$eventId) - { + \{ _id title description - } - } + \} + \} """; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_event_queries/EventQueries/registrantsByEvent.md b/docs/talawa-mobile-docs/utils_event_queries/EventQueries/registrantsByEvent.md index 36f685036b7..9b2c71936ad 100644 --- a/docs/talawa-mobile-docs/utils_event_queries/EventQueries/registrantsByEvent.md +++ b/docs/talawa-mobile-docs/utils_event_queries/EventQueries/registrantsByEvent.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) registrantsByEvent -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) registrantsByEvent +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId) @@ -23,18 +23,18 @@ ## Implementation ```dart -String registrantsByEvent(String eventId) { +String registrantsByEvent(String eventId) \{ return ''' - query { - registrantsByEvent(id: "$eventId") { + query \{ + registrantsByEvent(id: "$eventId") \{ _id firstName lastName image - } - } + \} + \} '''; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_event_queries/EventQueries/updateEvent.md b/docs/talawa-mobile-docs/utils_event_queries/EventQueries/updateEvent.md index 3d5cf74f9bf..ab60ecc9d78 100644 --- a/docs/talawa-mobile-docs/utils_event_queries/EventQueries/updateEvent.md +++ b/docs/talawa-mobile-docs/utils_event_queries/EventQueries/updateEvent.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) updateEvent -({dynamic eventId}) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) updateEvent +(\{dynamic eventId\}) @@ -23,9 +23,9 @@ ## Implementation ```dart -String updateEvent({ +String updateEvent(\{ eventId, -}) { +\}) \{ return """mutation updateEvent( \$title:String!, \$description: String!, @@ -36,10 +36,10 @@ String updateEvent({ \$isPublic: Boolean!, \$isRegisterable: Boolean!, \$location: String, - ) { + ) \{ updateEvent( id: "$eventId" - data:{ + data:\{ title: \$title, description: \$description, isPublic: \$isPublic, @@ -49,14 +49,14 @@ String updateEvent({ startTime: \$startTime endTime: \$endTime location: \$location - } - ){ + \} + )\{ _id title description - } - }"""; -} + \} + \}"""; +\} ``` diff --git a/docs/talawa-mobile-docs/utils_post_queries/PostQueries-class.md b/docs/talawa-mobile-docs/utils_post_queries/PostQueries-class.md index c42cbf66cf4..9dc964e6f94 100644 --- a/docs/talawa-mobile-docs/utils_post_queries/PostQueries-class.md +++ b/docs/talawa-mobile-docs/utils_post_queries/PostQueries-class.md @@ -11,7 +11,7 @@ -

This class creates queries related to posts.

+\This class creates queries related to posts.\ @@ -25,21 +25,21 @@ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -47,7 +47,7 @@ _read-onlyinherited_ ## Methods -##### [addLike](../utils_post_queries/PostQueries/addLike.md)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [addLike](../utils_post_queries/PostQueries/addLike.md)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -56,7 +56,7 @@ Add Like to a post. -##### [getPostsById](../utils_post_queries/PostQueries/getPostsById.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [getPostsById](../utils_post_queries/PostQueries/getPostsById.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) orgId) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -65,16 +65,16 @@ Getting Posts by Id. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [removeLike](../utils_post_queries/PostQueries/removeLike.md)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [removeLike](../utils_post_queries/PostQueries/removeLike.md)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -83,16 +83,16 @@ Remove Like from a post. -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [uploadPost](../utils_post_queries/PostQueries/uploadPost.md)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [uploadPost](../utils_post_queries/PostQueries/uploadPost.md)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -105,12 +105,12 @@ Upload a post to database. ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/utils_post_queries/PostQueries/addLike.md b/docs/talawa-mobile-docs/utils_post_queries/PostQueries/addLike.md index 75f191c97ad..021063a1ebb 100644 --- a/docs/talawa-mobile-docs/utils_post_queries/PostQueries/addLike.md +++ b/docs/talawa-mobile-docs/utils_post_queries/PostQueries/addLike.md @@ -10,36 +10,36 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) addLike +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) addLike () -

Add Like to a post.

-

params: - None

-

returns:

-
    -
  • String: The query related to addingLike
  • -
+\Add Like to a post.\ +\\params\: + None\ +\\returns\:\ +\ +\\String\: The query related to addingLike\ +\ ## Implementation ```dart -String addLike() { +String addLike() \{ return """ - mutation likePost(\$postID: ID!) { + mutation likePost(\$postID: ID!) \{ likePost( id: \$postID,) - { + \{ _id - } - } + \} + \} """; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_post_queries/PostQueries/getPostsById.md b/docs/talawa-mobile-docs/utils_post_queries/PostQueries/getPostsById.md index ed6fb741cd2..cac35cd3b37 100644 --- a/docs/talawa-mobile-docs/utils_post_queries/PostQueries/getPostsById.md +++ b/docs/talawa-mobile-docs/utils_post_queries/PostQueries/getPostsById.md @@ -10,33 +10,33 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) getPostsById -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) getPostsById +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) orgId) -

Getting Posts by Id.

-

params:

-
    -
  • orgId: The organisation id
  • -
-

returns:

-
    -
  • String: The query related to gettingPostsbyId
  • -
+\Getting Posts by Id.\ +\\params\:\ +\ +\\orgId\: The organisation id\ +\ +\\returns\:\ +\ +\\String\: The query related to gettingPostsbyId\ +\ ## Implementation ```dart -String getPostsById(String orgId) { +String getPostsById(String orgId) \{ return """ - query { + query \{ postsByOrganization(id: "$orgId",orderBy: createdAt_DESC ) - { + \{ _id text createdAt @@ -45,25 +45,25 @@ String getPostsById(String orgId) { title commentCount likeCount - creator{ + creator\{ _id firstName lastName image - } - organization{ + \} + organization\{ _id - } - likedBy{ + \} + likedBy\{ _id - } - comments{ + \} + comments\{ _id - } - } - } + \} + \} + \} """; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_post_queries/PostQueries/removeLike.md b/docs/talawa-mobile-docs/utils_post_queries/PostQueries/removeLike.md index e43f174fcd9..f1cc4d8bd54 100644 --- a/docs/talawa-mobile-docs/utils_post_queries/PostQueries/removeLike.md +++ b/docs/talawa-mobile-docs/utils_post_queries/PostQueries/removeLike.md @@ -10,39 +10,39 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) removeLike +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) removeLike () -

Remove Like from a post.

-

params: - None

-

returns:

-
    -
  • String: The query related to removingLike
  • -
+\Remove Like from a post.\ +\\params\: + None\ +\\returns\:\ +\ +\\String\: The query related to removingLike\ +\ ## Implementation ```dart -String removeLike() { +String removeLike() \{ return """ - mutation unlikePost(\$postID: ID!) { + mutation unlikePost(\$postID: ID!) \{ unlikePost( id: \$postID,) - { + \{ _id - likedBy{ + likedBy\{ _id - } - } - } + \} + \} + \} """; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_post_queries/PostQueries/uploadPost.md b/docs/talawa-mobile-docs/utils_post_queries/PostQueries/uploadPost.md index 59d03b867d2..e1b5af981dc 100644 --- a/docs/talawa-mobile-docs/utils_post_queries/PostQueries/uploadPost.md +++ b/docs/talawa-mobile-docs/utils_post_queries/PostQueries/uploadPost.md @@ -10,27 +10,27 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) uploadPost +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) uploadPost () -

Upload a post to database.

-

params: - None

-

returns:

-
    -
  • String: The query related to uploadingPost.
  • -
+\Upload a post to database.\ +\\params\: + None\ +\\returns\:\ +\ +\\String\: The query related to uploadingPost.\ +\ ## Implementation ```dart -String uploadPost() { +String uploadPost() \{ return ''' mutation CreatePost( \$text: String! @@ -38,21 +38,21 @@ String uploadPost() { \$imageUrl: URL \$videoUrl: URL \$organizationId: ID! -) { +) \{ createPost( - data: { + data: \{ text: \$text title: \$title imageUrl: \$imageUrl videoUrl: \$videoUrl organizationId: \$organizationId - } - ) { + \} + ) \{ _id - } -} + \} +\} '''; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_queries/Queries-class.md b/docs/talawa-mobile-docs/utils_queries/Queries-class.md index 7b1fc116fe6..2e861f07a73 100644 --- a/docs/talawa-mobile-docs/utils_queries/Queries-class.md +++ b/docs/talawa-mobile-docs/utils_queries/Queries-class.md @@ -11,7 +11,7 @@ -

This class returns some queries for the application.

+\This class returns some queries for the application.\ @@ -25,48 +25,48 @@ ## Properties -##### [fetchJoinInOrg](../utils_queries/Queries/fetchJoinInOrg.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [fetchJoinInOrg](../utils_queries/Queries/fetchJoinInOrg.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_read-only_ +_\read-only\_ -##### [fetchJoinInOrgByName](../utils_queries/Queries/fetchJoinInOrgByName.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [fetchJoinInOrgByName](../utils_queries/Queries/fetchJoinInOrgByName.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_read-only_ +_\read-only\_ -##### [fetchUserInfo](../utils_queries/Queries/fetchUserInfo.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [fetchUserInfo](../utils_queries/Queries/fetchUserInfo.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_read / write_ +_\read / write\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -74,16 +74,16 @@ _read-onlyinherited_ ## Methods -##### [createDonation](../utils_queries/Queries/createDonation.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) userId, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) nameOfOrg, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) nameOfUser, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) payPalId, [double](https://api.flutter.dev/flutter/dart-core/double-class.html) amount) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [createDonation](../utils_queries/Queries/createDonation.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) userId, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) orgId, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) nameOfOrg, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) nameOfUser, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) payPalId, [double](https:api.flutter.dev/flutter/dart-core/double-class.html) amount) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -createDonation creates a new donation transaction by taking the userId ,orgId ,nameOfOrg ,nameOfUser as parameters +\createDonation\ creates a new donation transaction by taking the userId ,orgId ,nameOfOrg ,nameOfUser as parameters -##### [fetchOrgById](../utils_queries/Queries/fetchOrgById.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [fetchOrgById](../utils_queries/Queries/fetchOrgById.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) orgId) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -92,7 +92,7 @@ _read-onlyinherited_ -##### [fetchOrgDetailsById](../utils_queries/Queries/fetchOrgDetailsById.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [fetchOrgDetailsById](../utils_queries/Queries/fetchOrgDetailsById.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) orgId) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -101,16 +101,16 @@ _read-onlyinherited_ -##### [getPluginsList](../utils_queries/Queries/getPluginsList.md)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [getPluginsList](../utils_queries/Queries/getPluginsList.md)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -getPluginList queries all properties of pluginList from the server +\getPluginList\ queries all properties of pluginList from the server -##### [joinOrgById](../utils_queries/Queries/joinOrgById.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [joinOrgById](../utils_queries/Queries/joinOrgById.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) orgId) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -119,7 +119,7 @@ _read-onlyinherited_ -##### [loginUser](../utils_queries/Queries/loginUser.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) email, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) password) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [loginUser](../utils_queries/Queries/loginUser.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) email, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) password) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -128,7 +128,7 @@ _read-onlyinherited_ -##### [logout](../utils_queries/Queries/logout.md)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [logout](../utils_queries/Queries/logout.md)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -137,7 +137,7 @@ _read-onlyinherited_ -##### [newUserLanguage](../utils_queries/Queries/newUserLanguage.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) userId) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [newUserLanguage](../utils_queries/Queries/newUserLanguage.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) userId) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -146,16 +146,16 @@ _read-onlyinherited_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [refreshToken](../utils_queries/Queries/refreshToken.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) refreshToken) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [refreshToken](../utils_queries/Queries/refreshToken.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) refreshToken) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -164,7 +164,7 @@ _inherited_ -##### [registerUser](../utils_queries/Queries/registerUser.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) firstName, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) lastName, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) email, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) password) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [registerUser](../utils_queries/Queries/registerUser.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) firstName, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) lastName, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) email, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) password) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -173,7 +173,7 @@ _inherited_ -##### [saveFcmToken](../utils_queries/Queries/saveFcmToken.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html)? token) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [saveFcmToken](../utils_queries/Queries/saveFcmToken.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html)? token) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -182,7 +182,7 @@ _inherited_ -##### [sendMembershipRequest](../utils_queries/Queries/sendMembershipRequest.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [sendMembershipRequest](../utils_queries/Queries/sendMembershipRequest.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) orgId) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -191,16 +191,16 @@ _inherited_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [updateLanguage](../utils_queries/Queries/updateLanguage.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) languageCode) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [updateLanguage](../utils_queries/Queries/updateLanguage.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) languageCode) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -209,7 +209,7 @@ _inherited_ -##### [userLanguage](../utils_queries/Queries/userLanguage.md)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [userLanguage](../utils_queries/Queries/userLanguage.md)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -222,12 +222,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/utils_queries/Queries/createDonation.md b/docs/talawa-mobile-docs/utils_queries/Queries/createDonation.md index 3aed8b44ee0..ccdc57149c7 100644 --- a/docs/talawa-mobile-docs/utils_queries/Queries/createDonation.md +++ b/docs/talawa-mobile-docs/utils_queries/Queries/createDonation.md @@ -10,14 +10,14 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) createDonation -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) userId, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) nameOfOrg, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) nameOfUser, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) payPalId, [double](https://api.flutter.dev/flutter/dart-core/double-class.html) amount) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) createDonation +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) userId, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) orgId, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) nameOfOrg, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) nameOfUser, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) payPalId, [double](https:api.flutter.dev/flutter/dart-core/double-class.html) amount) -

createDonation creates a new donation transaction by taking the userId ,orgId ,nameOfOrg ,nameOfUser as parameters

+\\createDonation\ creates a new donation transaction by taking the userId ,orgId ,nameOfOrg ,nameOfUser as parameters\ @@ -31,26 +31,26 @@ String createDonation( String nameOfUser, String payPalId, double amount, -) { +) \{ return ''' - mutation createDonationMutation { createDonation( + mutation createDonationMutation \{ createDonation( userId :"$userId" orgId :"$orgId", nameOfOrg:"$nameOfOrg", nameOfUser:"$nameOfUser", payPalId:"$payPalId" amount :$amount - ){ + )\{ _id payPalId userId orgId payPalId nameOfUser - } - } + \} + \} '''; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_queries/Queries/fetchJoinInOrg.md b/docs/talawa-mobile-docs/utils_queries/Queries/fetchJoinInOrg.md index 33bb1607af3..1f6a3ed7f93 100644 --- a/docs/talawa-mobile-docs/utils_queries/Queries/fetchJoinInOrg.md +++ b/docs/talawa-mobile-docs/utils_queries/Queries/fetchJoinInOrg.md @@ -11,7 +11,7 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) fetchJoinInOrg +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) fetchJoinInOrg @@ -23,27 +23,27 @@ ## Implementation ```dart -String get fetchJoinInOrg { +String get fetchJoinInOrg \{ return """ - query organizationsConnection(\$first: Int, \$skip: Int){ + query organizationsConnection(\$first: Int, \$skip: Int)\{ organizationsConnection( first: \$first, skip: \$skip, orderBy: name_ASC - ){ + )\{ image _id name image isPublic - creator{ + creator\{ firstName lastName - } - } - } + \} + \} + \} """; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_queries/Queries/fetchJoinInOrgByName.md b/docs/talawa-mobile-docs/utils_queries/Queries/fetchJoinInOrgByName.md index 02bcbb61721..5bf45a1f169 100644 --- a/docs/talawa-mobile-docs/utils_queries/Queries/fetchJoinInOrgByName.md +++ b/docs/talawa-mobile-docs/utils_queries/Queries/fetchJoinInOrgByName.md @@ -11,7 +11,7 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) fetchJoinInOrgByName +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) fetchJoinInOrgByName @@ -23,36 +23,36 @@ ## Implementation ```dart -String get fetchJoinInOrgByName { +String get fetchJoinInOrgByName \{ return """ query organizationsConnection( \$first: Int, \$skip: Int, \$nameStartsWith: String - ){ + )\{ organizationsConnection( - where:{ + where:\{ name_starts_with: \$nameStartsWith, visibleInSearch: true, isPublic: true, - } + \} first: \$first, skip: \$skip, orderBy: name_ASC - ){ + )\{ image _id name image isPublic - creator{ + creator\{ firstName lastName - } - } - } + \} + \} + \} """; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_queries/Queries/fetchOrgById.md b/docs/talawa-mobile-docs/utils_queries/Queries/fetchOrgById.md index ea2c109b2d8..6d6298e3b92 100644 --- a/docs/talawa-mobile-docs/utils_queries/Queries/fetchOrgById.md +++ b/docs/talawa-mobile-docs/utils_queries/Queries/fetchOrgById.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) fetchOrgById -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) fetchOrgById +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) orgId) @@ -23,23 +23,23 @@ ## Implementation ```dart -String fetchOrgById(String orgId) { +String fetchOrgById(String orgId) \{ return ''' - query{ - organizations(id: "$orgId"){ + query\{ + organizations(id: "$orgId")\{ image _id name image isPublic - creator{ + creator\{ firstName lastName - } - } - } + \} + \} + \} '''; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_queries/Queries/fetchOrgDetailsById.md b/docs/talawa-mobile-docs/utils_queries/Queries/fetchOrgDetailsById.md index f311d621c1e..bc1c9a8fdc5 100644 --- a/docs/talawa-mobile-docs/utils_queries/Queries/fetchOrgDetailsById.md +++ b/docs/talawa-mobile-docs/utils_queries/Queries/fetchOrgDetailsById.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) fetchOrgDetailsById -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) fetchOrgDetailsById +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) orgId) @@ -23,33 +23,33 @@ ## Implementation ```dart -String fetchOrgDetailsById(String orgId) { +String fetchOrgDetailsById(String orgId) \{ return ''' - query{ - organizations(id: "$orgId"){ + query\{ + organizations(id: "$orgId")\{ image _id name - admins{ + admins\{ _id - } + \} description isPublic - creator{ + creator\{ _id firstName lastName - } - members{ + \} + members\{ _id firstName lastName image - } - } - } + \} + \} + \} '''; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_queries/Queries/fetchUserInfo.md b/docs/talawa-mobile-docs/utils_queries/Queries/fetchUserInfo.md index c038293e525..4c476a8627f 100644 --- a/docs/talawa-mobile-docs/utils_queries/Queries/fetchUserInfo.md +++ b/docs/talawa-mobile-docs/utils_queries/Queries/fetchUserInfo.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) fetchUserInfo +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) fetchUserInfo -_read / write_ +_\read / write\_ @@ -22,59 +22,59 @@ _read / write_ ```dart String fetchUserInfo = ''' - query Users(\$id: ID!){ - users(where: { id: \$id }) { + query Users(\$id: ID!)\{ + users(where: \{ id: \$id \}) \{ _id firstName lastName email image - joinedOrganizations{ + joinedOrganizations\{ _id name image description isPublic - creator{ + creator\{ _id firstName lastName image - } + \} - } - createdOrganizations{ + \} + createdOrganizations\{ _id name image description isPublic - creator{ + creator\{ _id firstName lastName image - } - } - membershipRequests{ - organization{ + \} + \} + membershipRequests\{ + organization\{ _id name image isPublic - creator{ + creator\{ _id firstName lastName image - } - } - } - adminFor{ + \} + \} + \} + adminFor\{ _id - } - } - } + \} + \} + \} '''; ``` diff --git a/docs/talawa-mobile-docs/utils_queries/Queries/getPluginsList.md b/docs/talawa-mobile-docs/utils_queries/Queries/getPluginsList.md index 66e39ef684d..9893e881cd4 100644 --- a/docs/talawa-mobile-docs/utils_queries/Queries/getPluginsList.md +++ b/docs/talawa-mobile-docs/utils_queries/Queries/getPluginsList.md @@ -10,34 +10,34 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) getPluginsList +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) getPluginsList () -

getPluginList queries all properties of pluginList from the server

+\\getPluginList\ queries all properties of pluginList from the server\ ## Implementation ```dart -String getPluginsList() { +String getPluginsList() \{ return ''' -query { -getPlugins { +query \{ +getPlugins \{ _id pluginName pluginCreatedBy pluginDesc pluginInstallStatus installedOrgs -} -} +\} +\} '''; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_queries/Queries/joinOrgById.md b/docs/talawa-mobile-docs/utils_queries/Queries/joinOrgById.md index 6b3a9c800c6..c5c87421eab 100644 --- a/docs/talawa-mobile-docs/utils_queries/Queries/joinOrgById.md +++ b/docs/talawa-mobile-docs/utils_queries/Queries/joinOrgById.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joinOrgById -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joinOrgById +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) orgId) @@ -23,28 +23,28 @@ ## Implementation ```dart -String joinOrgById(String orgId) { +String joinOrgById(String orgId) \{ return ''' - mutation { - joinPublicOrganization(organizationId: "$orgId") { - joinedOrganizations{ + mutation \{ + joinPublicOrganization(organizationId: "$orgId") \{ + joinedOrganizations\{ _id name image description isPublic - creator{ + creator\{ _id firstName lastName image - } + \} - } - } - } + \} + \} + \} '''; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_queries/Queries/loginUser.md b/docs/talawa-mobile-docs/utils_queries/Queries/loginUser.md index 31a470855fd..065dd638120 100644 --- a/docs/talawa-mobile-docs/utils_queries/Queries/loginUser.md +++ b/docs/talawa-mobile-docs/utils_queries/Queries/loginUser.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) loginUser -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) email, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) password) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) loginUser +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) email, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) password) @@ -23,71 +23,71 @@ ## Implementation ```dart -String loginUser(String email, String password) { +String loginUser(String email, String password) \{ return """ - mutation { - login(data: {email: "$email", password: "$password"}){ + mutation \{ + login(data: \{email: "$email", password: "$password"\})\{ accessToken - user{ + user\{ _id firstName lastName email image - joinedOrganizations{ + joinedOrganizations\{ _id name image description isPublic - creator{ + creator\{ _id firstName lastName image - } - } - createdOrganizations{ + \} + \} + createdOrganizations\{ _id name image description isPublic - creator{ + creator\{ _id firstName lastName image - } - } - membershipRequests{ - organization{ + \} + \} + membershipRequests\{ + organization\{ _id name image description isPublic - creator{ + creator\{ _id firstName lastName image - } - } - } - adminFor{ + \} + \} + \} + adminFor\{ _id - } - } + \} + \} refreshToken - androidFirebaseOptions { + androidFirebaseOptions \{ apiKey appId messagingSenderId projectId storageBucket - } - iosFirebaseOptions { + \} + iosFirebaseOptions \{ apiKey appId messagingSenderId @@ -95,11 +95,11 @@ String loginUser(String email, String password) { storageBucket iosClientId iosBundleId - } - } - } + \} + \} + \} """; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_queries/Queries/logout.md b/docs/talawa-mobile-docs/utils_queries/Queries/logout.md index 673bb388560..4b8ab8d33ad 100644 --- a/docs/talawa-mobile-docs/utils_queries/Queries/logout.md +++ b/docs/talawa-mobile-docs/utils_queries/Queries/logout.md @@ -10,7 +10,7 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) logout +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) logout () @@ -23,13 +23,13 @@ ## Implementation ```dart -String logout() { +String logout() \{ return """ - mutation { + mutation \{ logout - } + \} """; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_queries/Queries/newUserLanguage.md b/docs/talawa-mobile-docs/utils_queries/Queries/newUserLanguage.md index a22689f7d26..87cc4894950 100644 --- a/docs/talawa-mobile-docs/utils_queries/Queries/newUserLanguage.md +++ b/docs/talawa-mobile-docs/utils_queries/Queries/newUserLanguage.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) newUserLanguage -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) userId) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) newUserLanguage +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) userId) @@ -23,13 +23,13 @@ ## Implementation ```dart -String newUserLanguage(String userId) { +String newUserLanguage(String userId) \{ return ''' - query{ + query\{ userLanguage(userId:"$userId") - } + \} '''; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_queries/Queries/refreshToken.md b/docs/talawa-mobile-docs/utils_queries/Queries/refreshToken.md index c384ab0919c..b15119f87ab 100644 --- a/docs/talawa-mobile-docs/utils_queries/Queries/refreshToken.md +++ b/docs/talawa-mobile-docs/utils_queries/Queries/refreshToken.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) refreshToken -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) refreshToken) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) refreshToken +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) refreshToken) @@ -23,16 +23,16 @@ ## Implementation ```dart -String refreshToken(String refreshToken) { +String refreshToken(String refreshToken) \{ return ''' - mutation{ - refreshToken(refreshToken: "$refreshToken"){ + mutation\{ + refreshToken(refreshToken: "$refreshToken")\{ accessToken refreshToken - } - } + \} + \} '''; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_queries/Queries/registerUser.md b/docs/talawa-mobile-docs/utils_queries/Queries/registerUser.md index 19b4402c663..44270d3c587 100644 --- a/docs/talawa-mobile-docs/utils_queries/Queries/registerUser.md +++ b/docs/talawa-mobile-docs/utils_queries/Queries/registerUser.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) registerUser -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) firstName, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) lastName, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) email, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) password) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) registerUser +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) firstName, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) lastName, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) email, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) password) @@ -28,68 +28,68 @@ String registerUser( String lastName, String email, String password, -) { +) \{ return """ - mutation{ - signUp(data: {firstName: "$firstName", lastName: "$lastName", email: "$email", password: "$password"}) - { + mutation\{ + signUp(data: \{firstName: "$firstName", lastName: "$lastName", email: "$email", password: "$password"\}) + \{ accessToken - user{ + user\{ _id firstName lastName email image - joinedOrganizations{ + joinedOrganizations\{ _id name image description isPublic - creator{ + creator\{ _id firstName lastName image - } - } - createdOrganizations{ + \} + \} + createdOrganizations\{ _id name image description isPublic - creator{ + creator\{ _id firstName lastName image - } - } - membershipRequests{ - organization{ + \} + \} + membershipRequests\{ + organization\{ _id name image description isPublic - creator{ + creator\{ _id firstName lastName image - } - } - } - adminFor{ + \} + \} + \} + adminFor\{ _id - } - } + \} + \} refreshToken - } - } + \} + \} """; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_queries/Queries/saveFcmToken.md b/docs/talawa-mobile-docs/utils_queries/Queries/saveFcmToken.md index 0b8bab769ce..9ae91246b19 100644 --- a/docs/talawa-mobile-docs/utils_queries/Queries/saveFcmToken.md +++ b/docs/talawa-mobile-docs/utils_queries/Queries/saveFcmToken.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) saveFcmToken -([String](https://api.flutter.dev/flutter/dart-core/String-class.html)? token) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) saveFcmToken +([String](https:api.flutter.dev/flutter/dart-core/String-class.html)? token) @@ -23,13 +23,13 @@ ## Implementation ```dart -String saveFcmToken(String? token) { +String saveFcmToken(String? token) \{ return """ - mutation { + mutation \{ saveFcmToken(token: "$token") - } + \} """; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_queries/Queries/sendMembershipRequest.md b/docs/talawa-mobile-docs/utils_queries/Queries/sendMembershipRequest.md index 033475b2b78..7b274c5382c 100644 --- a/docs/talawa-mobile-docs/utils_queries/Queries/sendMembershipRequest.md +++ b/docs/talawa-mobile-docs/utils_queries/Queries/sendMembershipRequest.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) sendMembershipRequest -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) sendMembershipRequest +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) orgId) @@ -23,27 +23,27 @@ ## Implementation ```dart -String sendMembershipRequest(String orgId) { +String sendMembershipRequest(String orgId) \{ return ''' - mutation { - sendMembershipRequest(organizationId: "$orgId"){ - organization{ + mutation \{ + sendMembershipRequest(organizationId: "$orgId")\{ + organization\{ _id name image description isPublic - creator{ + creator\{ _id firstName lastName image - } - } - } - } + \} + \} + \} + \} '''; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_queries/Queries/updateLanguage.md b/docs/talawa-mobile-docs/utils_queries/Queries/updateLanguage.md index 4f786b799c1..9450eb6679a 100644 --- a/docs/talawa-mobile-docs/utils_queries/Queries/updateLanguage.md +++ b/docs/talawa-mobile-docs/utils_queries/Queries/updateLanguage.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) updateLanguage -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) languageCode) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) updateLanguage +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) languageCode) @@ -23,17 +23,17 @@ ## Implementation ```dart -String updateLanguage(String languageCode) { +String updateLanguage(String languageCode) \{ return ''' - mutation { - updateLanguage(languageCode: "$languageCode"){ + mutation \{ + updateLanguage(languageCode: "$languageCode")\{ _id firstName appLanguageCode - } - } + \} + \} '''; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_queries/Queries/userLanguage.md b/docs/talawa-mobile-docs/utils_queries/Queries/userLanguage.md index 7e07be5a622..89c3ffe560e 100644 --- a/docs/talawa-mobile-docs/utils_queries/Queries/userLanguage.md +++ b/docs/talawa-mobile-docs/utils_queries/Queries/userLanguage.md @@ -10,7 +10,7 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) userLanguage +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) userLanguage () @@ -23,13 +23,13 @@ ## Implementation ```dart -String userLanguage() { +String userLanguage() \{ return ''' - query{ + query\{ myLanguage - } + \} '''; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_task_queries/TaskQueries-class.md b/docs/talawa-mobile-docs/utils_task_queries/TaskQueries-class.md index 9c6198bcd98..dd6de6e1aad 100644 --- a/docs/talawa-mobile-docs/utils_task_queries/TaskQueries-class.md +++ b/docs/talawa-mobile-docs/utils_task_queries/TaskQueries-class.md @@ -11,7 +11,7 @@ -

This class creates queries for the tasks in the application.

+\This class creates queries for the tasks in the application.\ @@ -25,21 +25,21 @@ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -47,21 +47,21 @@ _read-onlyinherited_ ## Methods -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -69,12 +69,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ @@ -84,7 +84,7 @@ _inherited_ ## Static Methods -##### [addTask](../utils_task_queries/TaskQueries/addTask.md)({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) title, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) description, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) deadline, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [addTask](../utils_task_queries/TaskQueries/addTask.md)(\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) title, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) description, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) deadline, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -93,7 +93,7 @@ _inherited_ -##### [deleteTask](../utils_task_queries/TaskQueries/deleteTask.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) taskId) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [deleteTask](../utils_task_queries/TaskQueries/deleteTask.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) taskId) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -102,7 +102,7 @@ _inherited_ -##### [editTask](../utils_task_queries/TaskQueries/editTask.md)({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) title, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) description, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) deadline, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) taskId}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [editTask](../utils_task_queries/TaskQueries/editTask.md)(\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) title, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) description, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) deadline, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) taskId\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -111,7 +111,7 @@ _inherited_ -##### [eventTasks](../utils_task_queries/TaskQueries/eventTasks.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [eventTasks](../utils_task_queries/TaskQueries/eventTasks.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -120,7 +120,7 @@ _inherited_ -##### [userTasks](../utils_task_queries/TaskQueries/userTasks.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) userId) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [userTasks](../utils_task_queries/TaskQueries/userTasks.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) userId) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) diff --git a/docs/talawa-mobile-docs/utils_task_queries/TaskQueries/addTask.md b/docs/talawa-mobile-docs/utils_task_queries/TaskQueries/addTask.md index 9152376d4fd..1e72cb59ca2 100644 --- a/docs/talawa-mobile-docs/utils_task_queries/TaskQueries/addTask.md +++ b/docs/talawa-mobile-docs/utils_task_queries/TaskQueries/addTask.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) addTask -({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) title, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) description, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) deadline, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId}) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) addTask +(\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) title, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) description, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) deadline, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId\}) @@ -23,33 +23,33 @@ ## Implementation ```dart -static String addTask({ +static String addTask(\{ required String title, required String description, required String deadline, required String eventId, -}) => +\}) =\> ''' - mutation { + mutation \{ createTask( - data: { title: "$title", description: "$description", deadline: "$deadline" } + data: \{ title: "$title", description: "$description", deadline: "$deadline" \} eventId: "$eventId" - ) { + ) \{ _id title description createdAt deadline - creator { + creator \{ _id firstName - } - event { + \} + event \{ _id title - } - } - } + \} + \} + \} '''; ``` diff --git a/docs/talawa-mobile-docs/utils_task_queries/TaskQueries/deleteTask.md b/docs/talawa-mobile-docs/utils_task_queries/TaskQueries/deleteTask.md index 6c2ee6db381..35ee900f0a6 100644 --- a/docs/talawa-mobile-docs/utils_task_queries/TaskQueries/deleteTask.md +++ b/docs/talawa-mobile-docs/utils_task_queries/TaskQueries/deleteTask.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) deleteTask -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) taskId) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) deleteTask +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) taskId) @@ -23,12 +23,12 @@ ## Implementation ```dart -static String deleteTask(String taskId) => ''' - mutation { - removeTask(id: "$taskId") { +static String deleteTask(String taskId) =\> ''' + mutation \{ + removeTask(id: "$taskId") \{ _id - } - } + \} + \} '''; ``` diff --git a/docs/talawa-mobile-docs/utils_task_queries/TaskQueries/editTask.md b/docs/talawa-mobile-docs/utils_task_queries/TaskQueries/editTask.md index f176f847ff1..33b093610d5 100644 --- a/docs/talawa-mobile-docs/utils_task_queries/TaskQueries/editTask.md +++ b/docs/talawa-mobile-docs/utils_task_queries/TaskQueries/editTask.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) editTask -({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) title, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) description, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) deadline, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) taskId}) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) editTask +(\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) title, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) description, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) deadline, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) taskId\}) @@ -23,31 +23,31 @@ ## Implementation ```dart -static String editTask({ +static String editTask(\{ required String title, required String description, required String deadline, required String taskId, -}) => +\}) =\> ''' - mutation { + mutation \{ updateTask( - data: { title: "$title", description: "$description", deadline: "$deadline" } + data: \{ title: "$title", description: "$description", deadline: "$deadline" \} id: "$taskId" - ) { + ) \{ _id title description createdAt deadline - creator { + creator \{ _id - } - event { + \} + event \{ _id - } - } - } + \} + \} + \} '''; ``` diff --git a/docs/talawa-mobile-docs/utils_task_queries/TaskQueries/eventTasks.md b/docs/talawa-mobile-docs/utils_task_queries/TaskQueries/eventTasks.md index 4b5260c9411..6d8882069f7 100644 --- a/docs/talawa-mobile-docs/utils_task_queries/TaskQueries/eventTasks.md +++ b/docs/talawa-mobile-docs/utils_task_queries/TaskQueries/eventTasks.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventTasks -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventTasks +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId) @@ -23,24 +23,24 @@ ## Implementation ```dart -static String eventTasks(String eventId) => ''' - query { - tasksByEvent(id: "$eventId") { +static String eventTasks(String eventId) =\> ''' + query \{ + tasksByEvent(id: "$eventId") \{ _id title description createdAt deadline - creator { + creator \{ _id firstName - } - event { + \} + event \{ _id title - } - } - } + \} + \} + \} '''; ``` diff --git a/docs/talawa-mobile-docs/utils_task_queries/TaskQueries/userTasks.md b/docs/talawa-mobile-docs/utils_task_queries/TaskQueries/userTasks.md index 0c3064b19fe..af348e0af7d 100644 --- a/docs/talawa-mobile-docs/utils_task_queries/TaskQueries/userTasks.md +++ b/docs/talawa-mobile-docs/utils_task_queries/TaskQueries/userTasks.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) userTasks -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) userId) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) userTasks +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) userId) @@ -23,24 +23,24 @@ ## Implementation ```dart -static String userTasks(String userId) => ''' - query { - tasksByUser(id: "$userId") { +static String userTasks(String userId) =\> ''' + query \{ + tasksByUser(id: "$userId") \{ _id title description createdAt deadline - creator { + creator \{ _id firstName - } - event { + \} + event \{ _id title - } - } - } + \} + \} + \} '''; ``` diff --git a/docs/talawa-mobile-docs/utils_validators/Validator-class.md b/docs/talawa-mobile-docs/utils_validators/Validator-class.md index f179f31a121..94802779d98 100644 --- a/docs/talawa-mobile-docs/utils_validators/Validator-class.md +++ b/docs/talawa-mobile-docs/utils_validators/Validator-class.md @@ -11,8 +11,8 @@ -

This class creats various validator methods for the application. -They are used to validate information given by the users.

+\This class creats various validator methods for the application. +They are used to validate information given by the users.\ @@ -26,21 +26,21 @@ They are used to validate information given by the users.

## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -48,25 +48,25 @@ _read-onlyinherited_ ## Methods -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [validateUrlExistence](../utils_validators/Validator/validateUrlExistence.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) url) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)?> +##### [validateUrlExistence](../utils_validators/Validator/validateUrlExistence.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) url) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)?\> @@ -79,12 +79,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ @@ -94,7 +94,7 @@ _inherited_ ## Static Methods -##### [validateEmail](../utils_validators/Validator/validateEmail.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) email) [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [validateEmail](../utils_validators/Validator/validateEmail.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) email) [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? @@ -103,7 +103,7 @@ _inherited_ -##### [validateEventForm](../utils_validators/Validator/validateEventForm.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) value, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? label) [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [validateEventForm](../utils_validators/Validator/validateEventForm.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) value, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? label) [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? @@ -112,7 +112,7 @@ _inherited_ -##### [validateFirstName](../utils_validators/Validator/validateFirstName.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) value) [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [validateFirstName](../utils_validators/Validator/validateFirstName.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) value) [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? @@ -121,7 +121,7 @@ _inherited_ -##### [validateLastName](../utils_validators/Validator/validateLastName.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) value) [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [validateLastName](../utils_validators/Validator/validateLastName.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) value) [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? @@ -130,7 +130,7 @@ _inherited_ -##### [validatePassword](../utils_validators/Validator/validatePassword.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) password) [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [validatePassword](../utils_validators/Validator/validatePassword.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) password) [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? @@ -139,7 +139,7 @@ _inherited_ -##### [validatePasswordConfirm](../utils_validators/Validator/validatePasswordConfirm.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) value, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) comparator) [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [validatePasswordConfirm](../utils_validators/Validator/validatePasswordConfirm.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) value, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) comparator) [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? @@ -148,7 +148,7 @@ _inherited_ -##### [validateURL](../utils_validators/Validator/validateURL.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) value) [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [validateURL](../utils_validators/Validator/validateURL.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) value) [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? diff --git a/docs/talawa-mobile-docs/utils_validators/Validator/validateEmail.md b/docs/talawa-mobile-docs/utils_validators/Validator/validateEmail.md index b167aec826e..4531eaf1a94 100644 --- a/docs/talawa-mobile-docs/utils_validators/Validator/validateEmail.md +++ b/docs/talawa-mobile-docs/utils_validators/Validator/validateEmail.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? validateEmail -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) email) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? validateEmail +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) email) @@ -25,19 +25,19 @@ ```dart static String? validateEmail( String email, -) { - // If email is empty return. - if (email.isEmpty) { +) \{ + If email is empty return. + if (email.isEmpty) \{ return "Email must not be left blank"; - } + \} const String pattern = - r"^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,253}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,253}[a-zA-Z0-9])?)*$"; + r"^[a-zA-Z0-9.!#$%&'*+/=?^_`\{|\}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]\{0,253\}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]\{0,253\}[a-zA-Z0-9])?)*$"; final RegExp regex = RegExp(pattern); - if (!regex.hasMatch(email)) { + if (!regex.hasMatch(email)) \{ return 'Please enter a valid Email Address'; - } + \} return null; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_validators/Validator/validateEventForm.md b/docs/talawa-mobile-docs/utils_validators/Validator/validateEventForm.md index 2742c92773b..87b4207dd34 100644 --- a/docs/talawa-mobile-docs/utils_validators/Validator/validateEventForm.md +++ b/docs/talawa-mobile-docs/utils_validators/Validator/validateEventForm.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? validateEventForm -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) value, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? label) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? validateEventForm +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) value, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? label) @@ -23,18 +23,18 @@ ## Implementation ```dart -static String? validateEventForm(String value, String? label) { - if (value.isEmpty) { +static String? validateEventForm(String value, String? label) \{ + if (value.isEmpty) \{ return '$label must not be left blank.'; - } - // ignore: unnecessary_raw_strings + \} + ignore: unnecessary_raw_strings const String pattern = r'(?=.*?[A-Za-z]).+'; final RegExp regex = RegExp(pattern); - if (!regex.hasMatch(value)) { + if (!regex.hasMatch(value)) \{ return "Invalid $label"; - } + \} return null; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_validators/Validator/validateFirstName.md b/docs/talawa-mobile-docs/utils_validators/Validator/validateFirstName.md index bef755da682..2eabe2afb50 100644 --- a/docs/talawa-mobile-docs/utils_validators/Validator/validateFirstName.md +++ b/docs/talawa-mobile-docs/utils_validators/Validator/validateFirstName.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? validateFirstName -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) value) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? validateFirstName +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) value) @@ -23,18 +23,18 @@ ## Implementation ```dart -static String? validateFirstName(String value) { - if (value.isEmpty) { +static String? validateFirstName(String value) \{ + if (value.isEmpty) \{ return 'Firstname must not be left blank.'; - } - // ignore: unnecessary_raw_strings + \} + ignore: unnecessary_raw_strings const String pattern = r'(?=.*?[A-Za-z]).+'; final RegExp regex = RegExp(pattern); - if (!regex.hasMatch(value)) { + if (!regex.hasMatch(value)) \{ return "Invalid Firstname"; - } + \} return null; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_validators/Validator/validateLastName.md b/docs/talawa-mobile-docs/utils_validators/Validator/validateLastName.md index d0f24762f3a..aa74c7a2a6b 100644 --- a/docs/talawa-mobile-docs/utils_validators/Validator/validateLastName.md +++ b/docs/talawa-mobile-docs/utils_validators/Validator/validateLastName.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? validateLastName -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) value) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? validateLastName +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) value) @@ -23,18 +23,18 @@ ## Implementation ```dart -static String? validateLastName(String value) { - if (value.isEmpty) { +static String? validateLastName(String value) \{ + if (value.isEmpty) \{ return 'Lastname must not be left blank.'; - } - // ignore: unnecessary_raw_strings + \} + ignore: unnecessary_raw_strings const String pattern = r"(?=.*?[A-Za-z]).+"; final RegExp regex = RegExp(pattern); - if (!regex.hasMatch(value)) { + if (!regex.hasMatch(value)) \{ return "Invalid Lastname"; - } + \} return null; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_validators/Validator/validatePassword.md b/docs/talawa-mobile-docs/utils_validators/Validator/validatePassword.md index f79ec49c788..22192513065 100644 --- a/docs/talawa-mobile-docs/utils_validators/Validator/validatePassword.md +++ b/docs/talawa-mobile-docs/utils_validators/Validator/validatePassword.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? validatePassword -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) password) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? validatePassword +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) password) @@ -25,28 +25,28 @@ ```dart static String? validatePassword( String password, -) { - // If password is empty return. - if (password.isEmpty) { +) \{ + If password is empty return. + if (password.isEmpty) \{ return "Password must not be left blank"; - } + \} const String pattern = - r'^(?=.*?[A-Z])(?=.*?[0-9])(?=.*?[!@#\$&*%^~.]).{8,}$'; + r'^(?=.*?[A-Z])(?=.*?[0-9])(?=.*?[!@#\$&*%^~.]).\{8,\}$'; final RegExp regExp = RegExp(pattern); - //Regex for no spaces allowed + Regex for no spaces allowed const String noSpaces = r'^\S+$'; final RegExp noSpaceRegex = RegExp(noSpaces); - if (!noSpaceRegex.hasMatch(password)) { + if (!noSpaceRegex.hasMatch(password)) \{ return "Password must not contain spaces"; - } - if (!regExp.hasMatch(password)) { + \} + if (!regExp.hasMatch(password)) \{ return "Your password must be at least 8 characters long, contain at least one numeric, one uppercase and one lowercase letters and one special character (@,#,\$,etc.)"; - } + \} return null; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_validators/Validator/validatePasswordConfirm.md b/docs/talawa-mobile-docs/utils_validators/Validator/validatePasswordConfirm.md index aa89e2f44bf..b7a9ba5dbd1 100644 --- a/docs/talawa-mobile-docs/utils_validators/Validator/validatePasswordConfirm.md +++ b/docs/talawa-mobile-docs/utils_validators/Validator/validatePasswordConfirm.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? validatePasswordConfirm -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) value, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) comparator) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? validatePasswordConfirm +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) value, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) comparator) @@ -26,12 +26,12 @@ static String? validatePasswordConfirm( String value, String comparator, -) { - if (value != comparator) { +) \{ + if (value != comparator) \{ return 'Password does not match original'; - } + \} return null; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_validators/Validator/validateURL.md b/docs/talawa-mobile-docs/utils_validators/Validator/validateURL.md index b1608f917d8..8fee22fff74 100644 --- a/docs/talawa-mobile-docs/utils_validators/Validator/validateURL.md +++ b/docs/talawa-mobile-docs/utils_validators/Validator/validateURL.md @@ -10,8 +10,8 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? validateURL -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) value) +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? validateURL +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) value) @@ -25,16 +25,16 @@ ```dart static String? validateURL( String value, -) { - if (value.isEmpty) { +) \{ + if (value.isEmpty) \{ return 'Please verify URL first'; - } + \} final bool validURL = Uri.parse(value).isAbsolute; - if (!validURL) { + if (!validURL) \{ return 'Enter a valid URL'; - } + \} return null; -} +\} ``` diff --git a/docs/talawa-mobile-docs/utils_validators/Validator/validateUrlExistence.md b/docs/talawa-mobile-docs/utils_validators/Validator/validateUrlExistence.md index 568b5ec31ee..afa2521ba21 100644 --- a/docs/talawa-mobile-docs/utils_validators/Validator/validateUrlExistence.md +++ b/docs/talawa-mobile-docs/utils_validators/Validator/validateUrlExistence.md @@ -10,8 +10,8 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)?> validateUrlExistence -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) url) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)?\> validateUrlExistence +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) url) @@ -23,15 +23,15 @@ ## Implementation ```dart -Future validateUrlExistence(String url) async { - try { +Future\ validateUrlExistence(String url) async \{ + try \{ await http.get(Uri.parse(url)); return true; - } on Exception catch (e) { + \} on Exception catch (e) \{ debugPrint(e.toString()); return false; - } -} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel-class.md b/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel-class.md index dcb8604eac6..c23ae6745b6 100644 --- a/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel-class.md +++ b/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel-class.md @@ -16,8 +16,8 @@ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) - [BaseModel](../view_model_base_view_model/BaseModel-class.md) - AccessScreenViewModel @@ -37,66 +37,66 @@ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hasListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hasListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether any listeners are currently registered. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [optionalMessageController](../view_model_access_request_view_model/AccessScreenViewModel/optionalMessageController.md) → [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) +##### [optionalMessageController](../view_model_access_request_view_model/AccessScreenViewModel/optionalMessageController.md) → [TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) -_final_ +_\final\_ -##### [organizations](../view_model_access_request_view_model/AccessScreenViewModel/organizations.md) ↔ [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)> +##### [organizations](../view_model_access_request_view_model/AccessScreenViewModel/organizations.md) ↔ [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)\> -_read / write_ +_\read / write\_ -##### [orgId](../view_model_access_request_view_model/AccessScreenViewModel/orgId.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [orgId](../view_model_access_request_view_model/AccessScreenViewModel/orgId.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_read / write_ +_\read / write\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -105,7 +105,7 @@ _read-onlyinherited_ -_read / write_ +_\read / write\_ @@ -114,7 +114,7 @@ _read / write_ -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -122,27 +122,27 @@ _read-onlyinherited_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be called when the object changes. -_inherited_ +_\inherited\_ -##### [dispose](https://api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void +##### [dispose](https:api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -
addListener will throw after the object is disposed). -_inherited_ +\addListener\ will throw after the object is disposed). +_\inherited\_ -##### [initialise](../view_model_access_request_view_model/AccessScreenViewModel/initialise.md)([OrgInfo](../models_organization_org_info/OrgInfo-class.md) org) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [initialise](../view_model_access_request_view_model/AccessScreenViewModel/initialise.md)([OrgInfo](../models_organization_org_info/OrgInfo-class.md) org) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -151,35 +151,35 @@ _inherited_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void +##### [notifyListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void Call all the registered listeners. -_inherited_ +_\inherited\_ -##### [removeListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that are notified when the object changes. -_inherited_ +_\inherited\_ -##### [sendMembershipRequest](../view_model_access_request_view_model/AccessScreenViewModel/sendMembershipRequest.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [sendMembershipRequest](../view_model_access_request_view_model/AccessScreenViewModel/sendMembershipRequest.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -193,16 +193,16 @@ _inherited_ -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -210,12 +210,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/initialise.md b/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/initialise.md index 7bb061c66bd..fb9714ede44 100644 --- a/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/initialise.md +++ b/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/initialise.md @@ -10,7 +10,7 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> initialise +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> initialise ([OrgInfo](../../models_organization_org_info/OrgInfo-class.md) org) @@ -23,9 +23,9 @@ ## Implementation ```dart -Future initialise(OrgInfo org) async { +Future\ initialise(OrgInfo org) async \{ selectedOrganization = org; -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/optionalMessageController.md b/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/optionalMessageController.md index 3feae3226d8..db21ffa7b5f 100644 --- a/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/optionalMessageController.md +++ b/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/optionalMessageController.md @@ -9,9 +9,9 @@ -[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) optionalMessageController +[TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) optionalMessageController -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/orgId.md b/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/orgId.md index 8401c3532ac..5c5f8cccfb5 100644 --- a/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/orgId.md +++ b/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/orgId.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) orgId -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/organizations.md b/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/organizations.md index d267d675bd7..84e4a7f0815 100644 --- a/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/organizations.md +++ b/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/organizations.md @@ -9,9 +9,9 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)> organizations +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)\> organizations -_read / write_ +_\read / write\_ @@ -21,7 +21,7 @@ _read / write_ ## Implementation ```dart -late List organizations = []; +late List\ organizations = []; ``` diff --git a/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/selectedOrganization.md b/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/selectedOrganization.md index 1c7a65ca8a9..120b783f224 100644 --- a/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/selectedOrganization.md +++ b/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/selectedOrganization.md @@ -11,7 +11,7 @@ [OrgInfo](../../models_organization_org_info/OrgInfo-class.md) selectedOrganization -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/sendMembershipRequest.md b/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/sendMembershipRequest.md index badfa2c33da..ee2e5d1bee7 100644 --- a/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/sendMembershipRequest.md +++ b/docs/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/sendMembershipRequest.md @@ -10,7 +10,7 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> sendMembershipRequest +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> sendMembershipRequest () @@ -23,31 +23,31 @@ ## Implementation ```dart -Future sendMembershipRequest() async { - //TODO: Implement Message arg for below function +Future\ sendMembershipRequest() async \{ + TODO: Implement Message arg for below function final result = await databaseFunctions.gqlAuthMutation( queries.sendMembershipRequest(selectedOrganization.id!), ); - if (result != null) { + if (result != null) \{ final OrgInfo membershipRequest = OrgInfo.fromJson( (((result as QueryResult).data!)['sendMembershipRequest'] - as Map)['organization'] as Map, + as Map\)['organization'] as Map\, ); userConfig.updateUserMemberRequestOrg([membershipRequest]); - if (userConfig.currentUser.joinedOrganizations!.isEmpty) { + if (userConfig.currentUser.joinedOrganizations!.isEmpty) \{ navigationService.removeAllAndPush( Routes.waitingScreen, Routes.splashScreen, ); - } else { + \} else \{ navigationService.pop(); navigationService.showTalawaErrorSnackBar( - 'Join in request sent to ${selectedOrganization.name} successfully', + 'Join in request sent to $\{selectedOrganization.name\} successfully', MessageType.info, ); - } - } -} + \} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel-class.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel-class.md index d1cf1ebe114..5620b20ebff 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel-class.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel-class.md @@ -11,15 +11,15 @@ -

AddPostViewModel class have different functions that are used.

-

to interact with the model to add a new post in the organization.

+\AddPostViewModel class have different functions that are used.\ +\to interact with the model to add a new post in the organization.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) - [BaseModel](../view_model_base_view_model/BaseModel-class.md) - AddPostViewModel @@ -39,66 +39,66 @@ ## Properties -##### [controller](../view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/controller.md) → [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) +##### [controller](../view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/controller.md) → [TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) Post body text controller. -_read-only_ +_\read-only\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hasListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hasListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether any listeners are currently registered. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [imageFile](../view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/imageFile.md) → [File](https://api.flutter.dev/flutter/dart-io/File-class.html)? +##### [imageFile](../view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/imageFile.md) → [File](https:api.flutter.dev/flutter/dart-io/File-class.html)? The image file that is to be uploaded. -_read-only_ +_\read-only\_ -##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [orgName](../view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/orgName.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [orgName](../view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/orgName.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) The organisation name. -_read-only_ +_\read-only\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -107,25 +107,25 @@ _read-onlyinherited_ -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [titleController](../view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/titleController.md) → [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) +##### [titleController](../view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/titleController.md) → [TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) Post title text controller. -_read-only_ +_\read-only\_ -##### [userName](../view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/userName.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [userName](../view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/userName.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) The Username. -_read-only_ +_\read-only\_ @@ -133,27 +133,27 @@ _read-only_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be called when the object changes. -_inherited_ +_\inherited\_ -##### [dispose](https://api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void +##### [dispose](https:api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -
addListener will throw after the object is disposed). -_inherited_ +\addListener\ will throw after the object is disposed). +_\inherited\_ -##### [getImageFromGallery](../view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/getImageFromGallery.md)({[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) camera = false}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [getImageFromGallery](../view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/getImageFromGallery.md)(\{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) camera = false\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -171,21 +171,21 @@ This function is usedto do initialisation of stuff in the view model. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void +##### [notifyListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void Call all the registered listeners. -_inherited_ +_\inherited\_ @@ -198,13 +198,13 @@ This function removes the image selected. -##### [removeListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that are notified when the object changes. -_inherited_ +_\inherited\_ @@ -213,20 +213,20 @@ _inherited_ -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [uploadPost](../view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/uploadPost.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [uploadPost](../view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/uploadPost.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -239,12 +239,12 @@ This function uploads the post finally, and navigate the success message or erro ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/controller.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/controller.md index 6bfa5f1a3e7..d21aa669920 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/controller.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/controller.md @@ -11,26 +11,26 @@ -[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) controller +[TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) controller -

Post body text controller.

-

params: +\Post body text controller.\ +\params: None -returns:

-
    -
  • TextEditingController: The main text controller of the post body
  • -
+returns:\ +\ +\\TextEditingController\: The main text controller of the post body\ +\ ## Implementation ```dart -TextEditingController get controller => _controller; +TextEditingController get controller =\> _controller; ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/getImageFromGallery.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/getImageFromGallery.md index 4b687e6e28e..dbf3bfacd5c 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/getImageFromGallery.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/getImageFromGallery.md @@ -10,41 +10,41 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> getImageFromGallery -({[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) camera = false}) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> getImageFromGallery +(\{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) camera = false\}) -

This function is used to get the image from gallery.

-

The function uses the _multiMediaPickerService services.

-

params:

-
    -
  • camera: if true then open camera for image, else open gallery to select image.
  • -
-

returns:

-
    -
  • Future<void>: Getting image from gallery returns future
  • -
+\This function is used to get the image from gallery.\ +\The function uses the \_multiMediaPickerService\ services.\ +\\params\:\ +\ +\\camera\: if true then open camera for image, else open gallery to select image.\ +\ +\\returns\:\ +\ +\\Future<void>\: Getting image from gallery returns future\ +\ ## Implementation ```dart -Future getImageFromGallery({bool camera = false}) async { +Future\ getImageFromGallery(\{bool camera = false\}) async \{ final image = await _multiMediaPickerService.getPhotoFromGallery(camera: camera); - if (image != null) { + if (image != null) \{ _imageFile = image; _navigationService.showTalawaErrorSnackBar( "Image is added", MessageType.info, ); notifyListeners(); - } -} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/imageFile.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/imageFile.md index 19699241f89..e5465d0fdd3 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/imageFile.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/imageFile.md @@ -11,26 +11,26 @@ -[File](https://api.flutter.dev/flutter/dart-io/File-class.html)? imageFile +[File](https:api.flutter.dev/flutter/dart-io/File-class.html)? imageFile -

The image file that is to be uploaded.

-

params: +\The image file that is to be uploaded.\ +\params: None -returns:

-
    -
  • File?: The image file
  • -
+returns:\ +\ +\\File?\: The image file\ +\ ## Implementation ```dart -File? get imageFile => _imageFile; +File? get imageFile =\> _imageFile; ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/initialise.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/initialise.md index ab0e08b7e4e..9873125a395 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/initialise.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/initialise.md @@ -17,25 +17,25 @@ void initialise -

This function is usedto do initialisation of stuff in the view model.

-

params: - None

-

returns: - None

+\This function is usedto do initialisation of stuff in the view model.\ +\\params\: + None\ +\\returns\: + None\ ## Implementation ```dart -void initialise() { - _currentUser = locator().currentUser; - _navigationService = locator(); - _selectedOrg = locator().currentOrg; +void initialise() \{ + _currentUser = locator\().currentUser; + _navigationService = locator\(); + _selectedOrg = locator\().currentOrg; _imageFile = null; - _multiMediaPickerService = locator(); - _dbFunctions = locator(); -} + _multiMediaPickerService = locator\(); + _dbFunctions = locator\(); +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/orgName.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/orgName.md index 1006f776860..9ef4301b717 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/orgName.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/orgName.md @@ -11,26 +11,26 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgName +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) orgName -

The organisation name.

-

params: +\The organisation name.\ +\params: None -returns:

-
    -
  • String: The organisation name
  • -
+returns:\ +\ +\\String\: The organisation name\ +\ ## Implementation ```dart -String get orgName => _selectedOrg.name!; +String get orgName =\> _selectedOrg.name!; ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/removeImage.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/removeImage.md index 43fd648c644..8d1ca7bff99 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/removeImage.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/removeImage.md @@ -17,21 +17,21 @@ void removeImage -

This function removes the image selected.

-

params: - None

-

returns: - None

+\This function removes the image selected.\ +\\params\: + None\ +\\returns\: + None\ ## Implementation ```dart -void removeImage() { +void removeImage() \{ _imageFile = null; notifyListeners(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/titleController.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/titleController.md index d3fac7285a9..be179635571 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/titleController.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/titleController.md @@ -11,26 +11,26 @@ -[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) titleController +[TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) titleController -

Post title text controller.

-

params: +\Post title text controller.\ +\params: None -returns:

-
    -
  • TextEditingController: The text controller of the title body
  • -
+returns:\ +\ +\\TextEditingController\: The text controller of the title body\ +\ ## Implementation ```dart -TextEditingController get titleController => _titleController; +TextEditingController get titleController =\> _titleController; ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/uploadPost.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/uploadPost.md index 4fc93630b54..d0a55183244 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/uploadPost.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/uploadPost.md @@ -10,54 +10,54 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> uploadPost +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> uploadPost () -

This function uploads the post finally, and navigate the success message or error message in Snack Bar.

-

params: - None

-

returns:

-
    -
  • Future<void>: Uploading post by contacting queries
  • -
+\This function uploads the post finally, and navigate the success message or error message in Snack Bar.\ +\\params\: + None\ +\\returns\:\ +\ +\\Future<void>\: Uploading post by contacting queries\ +\ ## Implementation ```dart -Future uploadPost() async { - // {TODO: } - if (_imageFile == null) { - try { +Future\ uploadPost() async \{ + \{TODO: \} + if (_imageFile == null) \{ + try \{ await _dbFunctions.gqlAuthMutation( PostQueries().uploadPost(), - variables: { + variables: \{ "text": _controller.text, "organizationId": _selectedOrg.id, "title": _titleController.text - }, + \}, ); _navigationService.showTalawaErrorSnackBar( "Post is uploaded", MessageType.info, ); - } on Exception catch (_) { + \} on Exception catch (_) \{ _navigationService.showTalawaErrorSnackBar( "Something went wrong", MessageType.error, ); - } - } + \} + \} removeImage(); _controller.text = ""; _titleController.text = ""; notifyListeners(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/userName.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/userName.md index 91033806d07..6de741d5042 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/userName.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/userName.md @@ -11,26 +11,26 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) userName +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) userName -

The Username.

-

params: +\The Username.\ +\params: None -returns:

-
    -
  • String: The username of the currentUser
  • -
+returns:\ +\ +\\String\: The username of the currentUser\ +\ ## Implementation ```dart -String get userName => _currentUser.firstName! + _currentUser.lastName!; +String get userName =\> _currentUser.firstName! + _currentUser.lastName!; ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md index ba22f8b88ff..5cdfcf60626 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md @@ -11,20 +11,20 @@ -

This ViewModel class have different functions that are used interact with model in the context of Direct Chat.

-

Functions include:

-
    -
  • initialise : Initialise the states.
  • -
  • getChatMessages : to get all the messages of a chat.
  • -
  • sendMessageToDirectChat : to send the message to chat.
  • -
+\This ViewModel class have different functions that are used interact with model in the context of Direct Chat.\ +\Functions include:\ +\ +\\initialise\ : Initialise the states.\ +\\getChatMessages\ : to get all the messages of a chat.\ +\\sendMessageToDirectChat\ : to send the message to chat.\ +\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) - [BaseModel](../view_model_base_view_model/BaseModel-class.md) - DirectChatViewModel @@ -44,21 +44,21 @@ ## Properties -##### [chatMessagesByUser](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatMessagesByUser.md) → [Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[ChatMessage](../models_chats_chat_message/ChatMessage-class.md)>> +##### [chatMessagesByUser](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatMessagesByUser.md) → [Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[ChatMessage](../models_chats_chat_message/ChatMessage-class.md)\>\> -_read-only_ +_\read-only\_ -##### [chats](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chats.md) → [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[ChatListTileDataModel](../models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md)> +##### [chats](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chats.md) → [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[ChatListTileDataModel](../models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md)\> -_read-only_ +_\read-only\_ @@ -67,61 +67,61 @@ _read-only_ -_read / write_ +_\read / write\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hasListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hasListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether any listeners are currently registered. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [listKey](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/listKey.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[AnimatedListState](https://api.flutter.dev/flutter/widgets/AnimatedListState-class.html)> +##### [listKey](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/listKey.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[AnimatedListState](https:api.flutter.dev/flutter/widgets/AnimatedListState-class.html)\> -_final_ +_\final\_ -##### [name](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/name.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [name](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/name.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_read / write_ +_\read / write\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -130,7 +130,7 @@ _read-onlyinherited_ -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -138,12 +138,12 @@ _read-onlyinherited_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be called when the object changes. -_inherited_ +_\inherited\_ @@ -162,12 +162,12 @@ _inherited_ Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -
addListener will throw after the object is disposed). -_override_ +\addListener\ will throw after the object is disposed). +_\override\_ -##### [getChatMessages](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/getChatMessages.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) chatId) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [getChatMessages](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/getChatMessages.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) chatId) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -176,7 +176,7 @@ This function get all messages for a chat. -##### [initialise](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/initialise.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [initialise](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/initialise.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -185,21 +185,21 @@ This function get all messages for a chat. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void +##### [notifyListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void Call all the registered listeners. -_inherited_ +_\inherited\_ @@ -212,17 +212,17 @@ This function refresh the chats. -##### [removeListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that are notified when the object changes. -_inherited_ +_\inherited\_ -##### [sendMessageToDirectChat](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/sendMessageToDirectChat.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) chatId, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) messageContent) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [sendMessageToDirectChat](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/sendMessageToDirectChat.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) chatId, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) messageContent) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -236,16 +236,16 @@ This function send the message to Direct Chat. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -253,12 +253,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatMessagesByUser.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatMessagesByUser.md index 77f46270e0e..d8663258a90 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatMessagesByUser.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatMessagesByUser.md @@ -11,7 +11,7 @@ -[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[ChatMessage](../../models_chats_chat_message/ChatMessage-class.md)>> chatMessagesByUser +[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[ChatMessage](../../models_chats_chat_message/ChatMessage-class.md)\>\> chatMessagesByUser @@ -23,7 +23,7 @@ ## Implementation ```dart -Map> get chatMessagesByUser => _chatMessagesByUser; +Map\\> get chatMessagesByUser =\> _chatMessagesByUser; ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatName.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatName.md index 5c2f3625b45..47acb56d630 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatName.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatName.md @@ -23,16 +23,16 @@ void chatName ## Implementation ```dart -void chatName(chatId) { - final List users = - _chats.firstWhere((element) => element.id == chatId).users!; +void chatName(chatId) \{ + final List\ users = + _chats.firstWhere((element) =\> element.id == chatId).users!; - users.forEach((element) { - if (element.id != userConfig.currentUser.id!) { + users.forEach((element) \{ + if (element.id != userConfig.currentUser.id!) \{ name = element.firstName; - } - }); -} + \} + \}); +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatState.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatState.md index 0ebdda61c90..e0fe0a284b7 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatState.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatState.md @@ -11,7 +11,7 @@ [ChatState](../../enums_enums/ChatState.md) chatState -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chats.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chats.md index 81f69657a5b..89a07633e5f 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chats.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chats.md @@ -11,7 +11,7 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[ChatListTileDataModel](../../models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md)> chats +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[ChatListTileDataModel](../../models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md)\> chats @@ -23,7 +23,7 @@ ## Implementation ```dart -List get chats => _chats; +List\ get chats =\> _chats; ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/dispose.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/dispose.md index 551ec7916fe..308dc99580e 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/dispose.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/dispose.md @@ -9,22 +9,22 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) void dispose () -_override_ +_\override\_ -

Discards any resources used by the object. After this is called, the +\Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -addListener will throw after the object is disposed).

-

This method should only be called by the object's owner.

-

This method does not notify listeners, and clears the listener list once +\addListener\ will throw after the object is disposed).\ +\This method should only be called by the object's owner.\ +\This method does not notify listeners, and clears the listener list once it is called. Consumers of this class must decide on whether to notify -listeners or not immediately before disposal.

+listeners or not immediately before disposal.\ @@ -32,11 +32,11 @@ listeners or not immediately before disposal.

```dart @override -void dispose() { +void dispose() \{ _chatMessageSubscription?.cancel(); _chatListSubscription.cancel(); super.dispose(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/getChatMessages.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/getChatMessages.md index bf87af3bc9a..348a1df62d5 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/getChatMessages.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/getChatMessages.md @@ -10,40 +10,40 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> getChatMessages -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) chatId) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> getChatMessages +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) chatId) -

This function get all messages for a chat.

-

params:

-
    -
  • chatId : id of a chat for which messages need to be fetched.
  • -
+\This function get all messages for a chat.\ +\params:\ +\ +\\chatId\ : id of a chat for which messages need to be fetched.\ +\ ## Implementation ```dart -Future getChatMessages(String chatId) async { +Future\ getChatMessages(String chatId) async \{ _chatMessagesByUser.clear(); chatState = ChatState.loading; - // await _chatService.getMessagesFromDirectChat(); - // variable - final List messages = []; + await _chatService.getMessagesFromDirectChat(); + variable + final List\ messages = []; _chatMessageSubscription = - _chatService.chatMessagesStream.listen((newMessage) { + _chatService.chatMessagesStream.listen((newMessage) \{ messages.add(newMessage); _chatMessagesByUser[chatId] = messages; - }); - // use `chatService` services + \}); + use `chatService` services await _chatService.getDirectChatMessagesByChatId(chatId); chatState = ChatState.complete; notifyListeners(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/initialise.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/initialise.md index 1ddffc5e032..c8a1fe54680 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/initialise.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/initialise.md @@ -10,7 +10,7 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> initialise +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> initialise () @@ -23,20 +23,20 @@ ## Implementation ```dart -Future initialise() async { +Future\ initialise() async \{ setState(ViewState.busy); chatState = ChatState.loading; - _chatListSubscription = _chatService.chatListStream.listen((newChat) { + _chatListSubscription = _chatService.chatListStream.listen((newChat) \{ _uniqueChatIds.add(newChat.id!); _chats.insert(0, newChat); - }); + \}); await _chatService.getDirectChatsByUserId(); chatState = ChatState.complete; setState(ViewState.idle); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/listKey.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/listKey.md index 64ba84797bd..7e56a03ee42 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/listKey.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/listKey.md @@ -9,9 +9,9 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[AnimatedListState](https://api.flutter.dev/flutter/widgets/AnimatedListState-class.html)> listKey +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[AnimatedListState](https:api.flutter.dev/flutter/widgets/AnimatedListState-class.html)\> listKey -_final_ +_\final\_ @@ -21,7 +21,7 @@ _final_ ## Implementation ```dart -final listKey = GlobalKey(); +final listKey = GlobalKey\(); ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/name.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/name.md index 8a9acbd9021..692b66ea02e 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/name.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/name.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/refreshChats.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/refreshChats.md index 87d21035e84..7413a29b174 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/refreshChats.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/refreshChats.md @@ -17,19 +17,19 @@ void refreshChats -

This function refresh the chats.

+\This function refresh the chats.\ ## Implementation ```dart -void refreshChats() { +void refreshChats() \{ _chats.clear(); _uniqueChatIds.clear(); notifyListeners(); _chatService.getDirectChatsByUserId(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/sendMessageToDirectChat.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/sendMessageToDirectChat.md index d1cf19519b3..e2fa3a081fa 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/sendMessageToDirectChat.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/sendMessageToDirectChat.md @@ -10,36 +10,36 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> sendMessageToDirectChat -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) chatId, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) messageContent) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> sendMessageToDirectChat +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) chatId, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) messageContent) -

This function send the message to Direct Chat.

-

params:

-
    -
  • chatId : id of a chat where message need to be send.
  • -
  • messageContent : content of a message.
  • -
+\This function send the message to Direct Chat.\ +\params:\ +\ +\\chatId\ : id of a chat where message need to be send.\ +\\messageContent\ : content of a message.\ +\ ## Implementation ```dart -Future sendMessageToDirectChat( +Future\ sendMessageToDirectChat( String chatId, String messageContent, -) async { +) async \{ chatState = ChatState.loading; - _chatService.chatMessagesStream.listen((newMessage) { + _chatService.chatMessagesStream.listen((newMessage) \{ _chatMessagesByUser[chatId]!.add(newMessage); - }); + \}); await _chatService.sendMessageToDirectChat(chatId, messageContent); chatState = ChatState.complete; -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel-class.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel-class.md index d1b8cd05b93..2bf21be02df 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel-class.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel-class.md @@ -11,18 +11,18 @@ -

SelectContactViewModel class have different functions to interact with model.

-

Functions include:

-
    -
  • getCurrentOrgUsersList : to get all users of current organization.
  • -
+\SelectContactViewModel class have different functions to interact with model.\ +\Functions include:\ +\ +\\getCurrentOrgUsersList\ : to get all users of current organization.\ +\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) - [BaseModel](../view_model_base_view_model/BaseModel-class.md) - SelectContactViewModel @@ -42,48 +42,48 @@ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hasListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hasListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether any listeners are currently registered. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [orgMembersList](../view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/orgMembersList.md) ↔ [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)> +##### [orgMembersList](../view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/orgMembersList.md) ↔ [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)\> -_read / write_ +_\read / write\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -92,7 +92,7 @@ _read-onlyinherited_ -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -100,27 +100,27 @@ _read-onlyinherited_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be called when the object changes. -_inherited_ +_\inherited\_ -##### [dispose](https://api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void +##### [dispose](https:api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -
addListener will throw after the object is disposed). -_inherited_ +\addListener\ will throw after the object is disposed). +_\inherited\_ -##### [getCurrentOrgUsersList](../view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/getCurrentOrgUsersList.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [getCurrentOrgUsersList](../view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/getCurrentOrgUsersList.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -138,31 +138,31 @@ This function is used to get all users list of an current organization. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void +##### [notifyListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void Call all the registered listeners. -_inherited_ +_\inherited\_ -##### [removeListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that are notified when the object changes. -_inherited_ +_\inherited\_ @@ -171,16 +171,16 @@ _inherited_ -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -188,12 +188,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/getCurrentOrgUsersList.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/getCurrentOrgUsersList.md index 8c9f8c8cd20..fe4d9079ae4 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/getCurrentOrgUsersList.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/getCurrentOrgUsersList.md @@ -10,28 +10,28 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> getCurrentOrgUsersList +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> getCurrentOrgUsersList () -

This function is used to get all users list of an current organization.

+\This function is used to get all users list of an current organization.\ ## Implementation ```dart -Future getCurrentOrgUsersList() async { - if (orgMembersList.isEmpty) { +Future\ getCurrentOrgUsersList() async \{ + if (orgMembersList.isEmpty) \{ orgMembersList = await _organizationService .getOrgMembersList(userConfig.currentOrg.id!); - } + \} - //return orgMembersList; -} + return orgMembersList; +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/initialise.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/initialise.md index a51657cbb63..efd78f3eab9 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/initialise.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/initialise.md @@ -23,9 +23,9 @@ void initialise ## Implementation ```dart -void initialise() { - _organizationService = locator(); -} +void initialise() \{ + _organizationService = locator\(); +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/orgMembersList.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/orgMembersList.md index fc9910f37b5..1292c78b33d 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/orgMembersList.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/orgMembersList.md @@ -9,9 +9,9 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)> orgMembersList +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)\> orgMembersList -_read / write_ +_\read / write\_ @@ -21,7 +21,7 @@ _read / write_ ## Implementation ```dart -late List orgMembersList = []; +late List\ orgMembersList = []; ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md index 38267d729c3..2a63b2a384d 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md @@ -11,23 +11,23 @@ -

CreateEventViewModel class have methods to interact with model in.

-

the context of creating the event in the organization.

-

Methods include:

-
    -
  • createEvent : to create an event.
  • -
  • getImageFromGallery : to select image for a post.
  • -
  • removeImage : to remove the image.
  • -
  • getCurrentOrgUsersList : to get all user list of current organization.
  • -
  • removeUserFromList : to remove a user from list.
  • -
+\CreateEventViewModel class have methods to interact with model in.\ +\the context of creating the event in the organization.\ +\Methods include:\ +\ +\\createEvent\ : to create an event.\ +\\getImageFromGallery\ : to select image for a post.\ +\\removeImage\ : to remove the image.\ +\\getCurrentOrgUsersList\ : to get all user list of current organization.\ +\\removeUserFromList\ : to remove a user from list.\ +\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) - [BaseModel](../view_model_base_view_model/BaseModel-class.md) - CreateEventViewModel @@ -47,201 +47,201 @@ ## Properties -##### [descriptionFocus](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/descriptionFocus.md) ↔ [FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) +##### [descriptionFocus](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/descriptionFocus.md) ↔ [FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) DescriptionFocus FocusNode. -_read / write_ +_\read / write\_ -##### [eventDescriptionTextController](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventDescriptionTextController.md) ↔ [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) +##### [eventDescriptionTextController](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventDescriptionTextController.md) ↔ [TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) Event Description Text Controller. -_read / write_ +_\read / write\_ -##### [eventEndDate](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventEndDate.md) ↔ [DateTime](https://api.flutter.dev/flutter/dart-core/DateTime-class.html) +##### [eventEndDate](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventEndDate.md) ↔ [DateTime](https:api.flutter.dev/flutter/dart-core/DateTime-class.html) Event End Date. -_read / write_ +_\read / write\_ -##### [eventEndTime](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventEndTime.md) ↔ [TimeOfDay](https://api.flutter.dev/flutter/material/TimeOfDay-class.html) +##### [eventEndTime](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventEndTime.md) ↔ [TimeOfDay](https:api.flutter.dev/flutter/material/TimeOfDay-class.html) Event End Time. -_read / write_ +_\read / write\_ -##### [eventLocationTextController](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventLocationTextController.md) ↔ [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) +##### [eventLocationTextController](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventLocationTextController.md) ↔ [TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) Event Location Text Controller. -_read / write_ +_\read / write\_ -##### [eventStartDate](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventStartDate.md) ↔ [DateTime](https://api.flutter.dev/flutter/dart-core/DateTime-class.html) +##### [eventStartDate](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventStartDate.md) ↔ [DateTime](https:api.flutter.dev/flutter/dart-core/DateTime-class.html) Event Start Date. -_read / write_ +_\read / write\_ -##### [eventStartTime](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventStartTime.md) ↔ [TimeOfDay](https://api.flutter.dev/flutter/material/TimeOfDay-class.html) +##### [eventStartTime](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventStartTime.md) ↔ [TimeOfDay](https:api.flutter.dev/flutter/material/TimeOfDay-class.html) Event Start Time. -_read / write_ +_\read / write\_ -##### [eventTitleTextController](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventTitleTextController.md) ↔ [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) +##### [eventTitleTextController](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventTitleTextController.md) ↔ [TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) Event Title Text Controller. -_read / write_ +_\read / write\_ -##### [formKey](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/formKey.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[FormState](https://api.flutter.dev/flutter/widgets/FormState-class.html)> +##### [formKey](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/formKey.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[FormState](https:api.flutter.dev/flutter/widgets/FormState-class.html)\> Global FormKey. -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hasListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hasListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether any listeners are currently registered. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [imageFile](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/imageFile.md) → [File](https://api.flutter.dev/flutter/dart-io/File-class.html)? +##### [imageFile](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/imageFile.md) → [File](https:api.flutter.dev/flutter/dart-io/File-class.html)? Getter to return imageFile. -_read-only_ +_\read-only\_ -##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isPublicSwitch](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/isPublicSwitch.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isPublicSwitch](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/isPublicSwitch.md) ↔ [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Public Event or Not. -_read / write_ +_\read / write\_ -##### [isRegisterableSwitch](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/isRegisterableSwitch.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isRegisterableSwitch](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/isRegisterableSwitch.md) ↔ [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) If event is registerable after creation. -_read / write_ +_\read / write\_ -##### [latitude](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/latitude.md) ↔ [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? +##### [latitude](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/latitude.md) ↔ [double](https:api.flutter.dev/flutter/dart-core/double-class.html)? Latitude store. -_read / write_ +_\read / write\_ -##### [locationFocus](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/locationFocus.md) ↔ [FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) +##### [locationFocus](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/locationFocus.md) ↔ [FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) LocationFocus FocusNode. -_read / write_ +_\read / write\_ -##### [longitude](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/longitude.md) ↔ [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? +##### [longitude](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/longitude.md) ↔ [double](https:api.flutter.dev/flutter/dart-core/double-class.html)? Longitude store. -_read / write_ +_\read / write\_ -##### [memberCheckedMap](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/memberCheckedMap.md) → [Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)> +##### [memberCheckedMap](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/memberCheckedMap.md) → [Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)\> Getter to return members map. -_read-only_ +_\read-only\_ -##### [orgMembersList](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/orgMembersList.md) ↔ [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)> +##### [orgMembersList](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/orgMembersList.md) ↔ [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)\> Organisation Members List. -_read / write_ +_\read / write\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [selectedMembers](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/selectedMembers.md) → [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)> +##### [selectedMembers](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/selectedMembers.md) → [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)\> Getter to return selected members. -_read-only_ +_\read-only\_ @@ -250,25 +250,25 @@ _read-only_ -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [titleFocus](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/titleFocus.md) ↔ [FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) +##### [titleFocus](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/titleFocus.md) ↔ [FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) TitleFocus FocusNode. -_read / write_ +_\read / write\_ -##### [validate](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/validate.md) ↔ [AutovalidateMode](https://api.flutter.dev/flutter/widgets/AutovalidateMode.html) +##### [validate](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/validate.md) ↔ [AutovalidateMode](https:api.flutter.dev/flutter/widgets/AutovalidateMode.html) AutoValidateMode default to disabled. -_read / write_ +_\read / write\_ @@ -276,12 +276,12 @@ _read / write_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be called when the object changes. -_inherited_ +_\inherited\_ @@ -294,7 +294,7 @@ This function build the user list. -##### [createEvent](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/createEvent.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [createEvent](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/createEvent.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -303,27 +303,27 @@ This function is used to create the event for the organization. -##### [dispose](https://api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void +##### [dispose](https:api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -
addListener will throw after the object is disposed). -_inherited_ +\addListener\ will throw after the object is disposed). +_\inherited\_ -##### [getCurrentOrgUsersList](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/getCurrentOrgUsersList.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)>> +##### [getCurrentOrgUsersList](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/getCurrentOrgUsersList.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)\>\> -This function fetch all the users in the current organization and return List. +This function fetch all the users in the current organization and return \List\. -##### [getImageFromGallery](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/getImageFromGallery.md)({[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) camera = false}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [getImageFromGallery](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/getImageFromGallery.md)(\{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) camera = false\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -341,21 +341,21 @@ Function To Initialize. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void +##### [notifyListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void Call all the registered listeners. -_inherited_ +_\inherited\_ @@ -368,17 +368,17 @@ This function remove the selected image. -##### [removeListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that are notified when the object changes. -_inherited_ +_\inherited\_ -##### [removeUserFromList](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/removeUserFromList.md)({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) userId}) void +##### [removeUserFromList](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/removeUserFromList.md)(\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) userId\}) void @@ -392,16 +392,16 @@ This function is used to remove a user from user's list. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -409,12 +409,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/buildUserList.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/buildUserList.md index 49b43c3ff73..c7a88bc351b 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/buildUserList.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/buildUserList.md @@ -17,29 +17,29 @@ void buildUserList -

This function build the user list.

-

params: - None

-

returns: - None

+\This function build the user list.\ +\\params\: + None\ +\\returns\: + None\ ## Implementation ```dart -void buildUserList() { +void buildUserList() \{ _selectedMembers.clear(); - // loop through the organization member list + loop through the organization member list - orgMembersList.forEach((orgMember) { - if (_memberCheckedMap[orgMember.id] == true) { + orgMembersList.forEach((orgMember) \{ + if (_memberCheckedMap[orgMember.id] == true) \{ _selectedMembers.add(orgMember); - } - }); + \} + \}); notifyListeners(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/createEvent.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/createEvent.md index e02be1250b9..b71fd024fed 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/createEvent.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/createEvent.md @@ -10,37 +10,37 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> createEvent +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> createEvent () -

This function is used to create the event for the organization.

-

The function uses database_mutation_functions services to call the graphQL mutation -for creating an event and passes the required variables for the event.

-

params: - None

-

returns:

-
    -
  • Future<void>: Asynchronous function for creating event
  • -
+\This function is used to create the event for the organization.\ +\The function uses \database_mutation_functions\ services to call the graphQL mutation +for creating an event and passes the required variables for the event.\ +\\params\: + None\ +\\returns\:\ +\ +\\Future<void>\: Asynchronous function for creating event\ +\ ## Implementation ```dart -Future createEvent() async { +Future\ createEvent() async \{ titleFocus.unfocus(); locationFocus.unfocus(); descriptionFocus.unfocus(); validate = AutovalidateMode.always; - if (formKey.currentState!.validate()) { + if (formKey.currentState!.validate()) \{ validate = AutovalidateMode.disabled; - // variables initialisation + variables initialisation final DateTime startDate = eventStartDate; final DateTime endDate = eventEndDate; final DateTime startTime = DateTime( @@ -58,8 +58,8 @@ Future createEvent() async { eventEndTime.minute, ); - // all required data for creating an event - final Map variables = { + all required data for creating an event + final Map\ variables = \{ 'startDate': DateFormat('yyyy-MM-dd').format(startDate), 'endDate': DateFormat('yyyy-MM-dd').format(endDate), 'organizationId': _currentOrg.id, @@ -70,11 +70,11 @@ Future createEvent() async { 'isRegisterable': isRegisterableSwitch, 'recurring': false, 'allDay': false, - 'startTime': '${DateFormat('HH:mm:ss').format(startTime)}Z', - 'endTime': '${DateFormat('HH:mm:ss').format(endTime)}Z', + 'startTime': '$\{DateFormat('HH:mm:ss').format(startTime)\}Z', + 'endTime': '$\{DateFormat('HH:mm:ss').format(endTime)\}Z', if (latitude != null) 'latitude': latitude, if (longitude != null) 'longitude': longitude, - }; + \}; navigationService.pushDialog( const CustomProgressDialog(key: Key('EventCreationProgress')), @@ -82,20 +82,20 @@ Future createEvent() async { final tokenResult = await databaseFunctions .refreshAccessToken(userConfig.currentUser.refreshToken!); print(tokenResult); - // invoke the `gqlAuthMutation` function of `databaseFunctions` - // service along with the mutation query and variable map. + invoke the `gqlAuthMutation` function of `databaseFunctions` + service along with the mutation query and variable map. final result = await databaseFunctions.gqlAuthMutation( EventQueries().addEvent(), variables: variables, ); navigationService.pop(); - if (result != null) { + if (result != null) \{ navigationService.pop(); await _eventService.getEvents(); - } - } -} + \} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/descriptionFocus.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/descriptionFocus.md index 2d720cdd9e0..5540363792d 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/descriptionFocus.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/descriptionFocus.md @@ -9,13 +9,13 @@ -[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) descriptionFocus +[FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) descriptionFocus -_read / write_ +_\read / write\_ -

DescriptionFocus FocusNode.

+\DescriptionFocus FocusNode.\ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventDescriptionTextController.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventDescriptionTextController.md index abda49060ed..2fec92e6a17 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventDescriptionTextController.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventDescriptionTextController.md @@ -9,13 +9,13 @@ -[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) eventDescriptionTextController +[TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) eventDescriptionTextController -_read / write_ +_\read / write\_ -

Event Description Text Controller.

+\Event Description Text Controller.\ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventEndDate.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventEndDate.md index 2eae857b115..0ab90812858 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventEndDate.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventEndDate.md @@ -9,13 +9,13 @@ -[DateTime](https://api.flutter.dev/flutter/dart-core/DateTime-class.html) eventEndDate +[DateTime](https:api.flutter.dev/flutter/dart-core/DateTime-class.html) eventEndDate -_read / write_ +_\read / write\_ -

Event End Date.

+\Event End Date.\ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventEndTime.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventEndTime.md index 18d766fed0f..ddff34fee29 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventEndTime.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventEndTime.md @@ -9,13 +9,13 @@ -[TimeOfDay](https://api.flutter.dev/flutter/material/TimeOfDay-class.html) eventEndTime +[TimeOfDay](https:api.flutter.dev/flutter/material/TimeOfDay-class.html) eventEndTime -_read / write_ +_\read / write\_ -

Event End Time.

+\Event End Time.\ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventLocationTextController.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventLocationTextController.md index d371ed22b94..3dfa4b0270b 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventLocationTextController.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventLocationTextController.md @@ -9,13 +9,13 @@ -[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) eventLocationTextController +[TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) eventLocationTextController -_read / write_ +_\read / write\_ -

Event Location Text Controller.

+\Event Location Text Controller.\ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventStartDate.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventStartDate.md index d568203e394..01e3bdbdc12 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventStartDate.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventStartDate.md @@ -9,13 +9,13 @@ -[DateTime](https://api.flutter.dev/flutter/dart-core/DateTime-class.html) eventStartDate +[DateTime](https:api.flutter.dev/flutter/dart-core/DateTime-class.html) eventStartDate -_read / write_ +_\read / write\_ -

Event Start Date.

+\Event Start Date.\ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventStartTime.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventStartTime.md index 0ba2d449bb7..98c94e78f22 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventStartTime.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventStartTime.md @@ -9,13 +9,13 @@ -[TimeOfDay](https://api.flutter.dev/flutter/material/TimeOfDay-class.html) eventStartTime +[TimeOfDay](https:api.flutter.dev/flutter/material/TimeOfDay-class.html) eventStartTime -_read / write_ +_\read / write\_ -

Event Start Time.

+\Event Start Time.\ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventTitleTextController.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventTitleTextController.md index 0ff98f1e475..162f91a40b2 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventTitleTextController.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventTitleTextController.md @@ -9,13 +9,13 @@ -[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) eventTitleTextController +[TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) eventTitleTextController -_read / write_ +_\read / write\_ -

Event Title Text Controller.

+\Event Title Text Controller.\ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/formKey.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/formKey.md index 8d24a83fcc6..a6e290c37e6 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/formKey.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/formKey.md @@ -9,20 +9,20 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[FormState](https://api.flutter.dev/flutter/widgets/FormState-class.html)> formKey +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[FormState](https:api.flutter.dev/flutter/widgets/FormState-class.html)\> formKey -_final_ +_\final\_ -

Global FormKey.

+\Global FormKey.\ ## Implementation ```dart -final formKey = GlobalKey(); +final formKey = GlobalKey\(); ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/getCurrentOrgUsersList.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/getCurrentOrgUsersList.md index dd2d7bc7f6f..0d4edfbfbb5 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/getCurrentOrgUsersList.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/getCurrentOrgUsersList.md @@ -10,40 +10,40 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)>> getCurrentOrgUsersList +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)\>\> getCurrentOrgUsersList () -

This function fetch all the users in the current organization and return List.

-

params: - None

-

returns:

-
    -
  • Future<List<User>>: Current Organization Users List
  • -
+\This function fetch all the users in the current organization and return \List\.\ +\\params\: + None\ +\\returns\:\ +\ +\\Future<List<User>>\: Current Organization Users List\ +\ ## Implementation ```dart -Future> getCurrentOrgUsersList() async { - if (orgMembersList.isEmpty) { +Future\\> getCurrentOrgUsersList() async \{ + if (orgMembersList.isEmpty) \{ orgMembersList = await organizationService .getOrgMembersList(userConfig.currentOrg.id!); - } - - // loop through list - orgMembersList.forEach((orgMember) { - _memberCheckedMap.putIfAbsent(orgMember.id!, () => false); - _memberCheckedMap.putIfAbsent(orgMember.id!, () => false); - }); - // return list + \} + + loop through list + orgMembersList.forEach((orgMember) \{ + _memberCheckedMap.putIfAbsent(orgMember.id!, () =\> false); + _memberCheckedMap.putIfAbsent(orgMember.id!, () =\> false); + \}); + return list return orgMembersList; -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/getImageFromGallery.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/getImageFromGallery.md index 8401473f63a..e4cc3ddb3ce 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/getImageFromGallery.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/getImageFromGallery.md @@ -10,37 +10,37 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> getImageFromGallery -({[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) camera = false}) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> getImageFromGallery +(\{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) camera = false\}) -

This function is used to get the image from gallery.

-

The function uses the _multiMediaPickerService services.

-

params:

-
    -
  • camera: if true then open camera for image, else open gallery to select image.
  • -
-

returns:

-
    -
  • Future<void>: Asynchronous function for getting image from gallery
  • -
+\This function is used to get the image from gallery.\ +\The function uses the \_multiMediaPickerService\ services.\ +\\params\:\ +\ +\\camera\: if true then open camera for image, else open gallery to select image.\ +\ +\\returns\:\ +\ +\\Future<void>\: Asynchronous function for getting image from gallery\ +\ ## Implementation ```dart -Future getImageFromGallery({bool camera = false}) async { +Future\ getImageFromGallery(\{bool camera = false\}) async \{ final image = await _multiMediaPickerService.getPhotoFromGallery(camera: camera); - if (image != null) { + if (image != null) \{ _imageFile = image; notifyListeners(); - } -} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/imageFile.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/imageFile.md index 041c6defc85..f06296ef619 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/imageFile.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/imageFile.md @@ -11,26 +11,26 @@ -[File](https://api.flutter.dev/flutter/dart-io/File-class.html)? imageFile +[File](https:api.flutter.dev/flutter/dart-io/File-class.html)? imageFile -

Getter to return imageFile.

-

params: -None

-

returns:

-
    -
  • File?: Returns imageFile.
  • -
+\Getter to return imageFile.\ +\params: +None\ +\returns:\ +\ +\\File?\: Returns imageFile.\ +\ ## Implementation ```dart -File? get imageFile => _imageFile; +File? get imageFile =\> _imageFile; ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/initialize.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/initialize.md index 1f60b376dd9..7312c17b2b8 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/initialize.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/initialize.md @@ -17,24 +17,24 @@ void initialize -

Function To Initialize.

-

params: - None

-

returns: - None

+\Function To Initialize.\ +\\params\: + None\ +\\returns\: + None\ ## Implementation ```dart -void initialize() { +void initialize() \{ _currentOrg = _userConfig.currentOrg; - //_organizationService = locator(); + _organizationService = locator\(); _imageFile = null; - _multiMediaPickerService = locator(); -} + _multiMediaPickerService = locator\(); +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/isPublicSwitch.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/isPublicSwitch.md index 8c49650a240..8bcc58872e4 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/isPublicSwitch.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/isPublicSwitch.md @@ -9,13 +9,13 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isPublicSwitch +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isPublicSwitch -_read / write_ +_\read / write\_ -

Public Event or Not.

+\Public Event or Not.\ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/isRegisterableSwitch.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/isRegisterableSwitch.md index 4c0808ed0b7..15740afeb0f 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/isRegisterableSwitch.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/isRegisterableSwitch.md @@ -9,13 +9,13 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isRegisterableSwitch +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isRegisterableSwitch -_read / write_ +_\read / write\_ -

If event is registerable after creation.

+\If event is registerable after creation.\ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/latitude.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/latitude.md index da17e9b9c9f..fb2e6c2a514 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/latitude.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/latitude.md @@ -9,13 +9,13 @@ -[double](https://api.flutter.dev/flutter/dart-core/double-class.html)? latitude +[double](https:api.flutter.dev/flutter/dart-core/double-class.html)? latitude -_read / write_ +_\read / write\_ -

Latitude store.

+\Latitude store.\ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/locationFocus.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/locationFocus.md index df230e49332..79c0bc20c78 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/locationFocus.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/locationFocus.md @@ -9,13 +9,13 @@ -[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) locationFocus +[FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) locationFocus -_read / write_ +_\read / write\_ -

LocationFocus FocusNode.

+\LocationFocus FocusNode.\ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/longitude.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/longitude.md index eba02e97c77..13301b6c88f 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/longitude.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/longitude.md @@ -9,13 +9,13 @@ -[double](https://api.flutter.dev/flutter/dart-core/double-class.html)? longitude +[double](https:api.flutter.dev/flutter/dart-core/double-class.html)? longitude -_read / write_ +_\read / write\_ -

Longitude store.

+\Longitude store.\ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/memberCheckedMap.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/memberCheckedMap.md index 81076cdb6ff..403b6b119d5 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/memberCheckedMap.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/memberCheckedMap.md @@ -11,27 +11,27 @@ -[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)> memberCheckedMap +[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)\> memberCheckedMap -

Getter to return members map.

-

params: -None

-

returns:

-
    -
  • Map<String, bool>: Returns a map of entries with id and boolean if they are -selected for events or not in bottom sheet.
  • -
+\Getter to return members map.\ +\params: +None\ +\returns:\ +\ +\\Map<String, bool>\: Returns a map of entries with id and boolean if they are +selected for events or not in bottom sheet.\ +\ ## Implementation ```dart -Map get memberCheckedMap => _memberCheckedMap; +Map\ get memberCheckedMap =\> _memberCheckedMap; ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/orgMembersList.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/orgMembersList.md index 5e26fd92869..4896ad7cb8c 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/orgMembersList.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/orgMembersList.md @@ -9,20 +9,20 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)> orgMembersList +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)\> orgMembersList -_read / write_ +_\read / write\_ -

Organisation Members List.

+\Organisation Members List.\ ## Implementation ```dart -late List orgMembersList = []; +late List\ orgMembersList = []; ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/removeImage.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/removeImage.md index 11b3c4f3e80..d246b87d756 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/removeImage.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/removeImage.md @@ -17,21 +17,21 @@ void removeImage -

This function remove the selected image.

-

params: - None

-

returns: - None

+\This function remove the selected image.\ +\\params\: + None\ +\\returns\: + None\ ## Implementation ```dart -void removeImage() { +void removeImage() \{ _imageFile = null; notifyListeners(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/removeUserFromList.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/removeUserFromList.md index eafdab6ecd2..7170a8d4ba6 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/removeUserFromList.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/removeUserFromList.md @@ -11,31 +11,31 @@ void removeUserFromList -({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) userId}) +(\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) userId\}) -

This function is used to remove a user from user's list.

-

params:

-
    -
  • userId: id of the user that need to be removed.
  • -
-

returns: - None

+\This function is used to remove a user from user's list.\ +\\params\:\ +\ +\\userId\: id of the user that need to be removed.\ +\ +\\returns\: + None\ ## Implementation ```dart -void removeUserFromList({required String userId}) { - _selectedMembers.removeWhere((user) => user.id == userId); +void removeUserFromList(\{required String userId\}) \{ + _selectedMembers.removeWhere((user) =\> user.id == userId); _memberCheckedMap[userId] = false; notifyListeners(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/selectedMembers.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/selectedMembers.md index cc72b1eb82b..904f99e3f11 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/selectedMembers.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/selectedMembers.md @@ -11,26 +11,26 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)> selectedMembers +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)\> selectedMembers -

Getter to return selected members.

-

params: -None

-

returns:

-
    -
  • List<User>: Returns a list of selectedMembers for events
  • -
+\Getter to return selected members.\ +\params: +None\ +\returns:\ +\ +\\List<User>\: Returns a list of selectedMembers for events\ +\ ## Implementation ```dart -List get selectedMembers => _selectedMembers; +List\ get selectedMembers =\> _selectedMembers; ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/titleFocus.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/titleFocus.md index dafe064f751..ad152dce546 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/titleFocus.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/titleFocus.md @@ -9,13 +9,13 @@ -[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) titleFocus +[FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) titleFocus -_read / write_ +_\read / write\_ -

TitleFocus FocusNode.

+\TitleFocus FocusNode.\ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/validate.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/validate.md index 0c6ee84f70f..3a227d6526e 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/validate.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/validate.md @@ -9,13 +9,13 @@ -[AutovalidateMode](https://api.flutter.dev/flutter/widgets/AutovalidateMode.html) validate +[AutovalidateMode](https:api.flutter.dev/flutter/widgets/AutovalidateMode.html) validate -_read / write_ +_\read / write\_ -

AutoValidateMode default to disabled.

+\AutoValidateMode default to disabled.\ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md index d2eed60cf20..c7a1f1db074 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md @@ -11,19 +11,19 @@ -

EditEventViewModel class have methods to interact with model in -the context of editing the event in the organization.

-

Methods include:

-
    -
  • updateEvent : to update an event.
  • -
+\EditEventViewModel class have methods to interact with model in +the context of editing the event in the organization.\ +\Methods include:\ +\ +\\updateEvent\ : to update an event.\ +\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) - [BaseModel](../view_model_base_view_model/BaseModel-class.md) - EditEventViewModel @@ -43,147 +43,147 @@ the context of editing the event in the organization.

## Properties -##### [descriptionFocus](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/descriptionFocus.md) ↔ [FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) +##### [descriptionFocus](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/descriptionFocus.md) ↔ [FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) -_read / write_ +_\read / write\_ -##### [eventDescriptionTextController](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventDescriptionTextController.md) ↔ [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) +##### [eventDescriptionTextController](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventDescriptionTextController.md) ↔ [TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) -_read / write_ +_\read / write\_ -##### [eventEndDate](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventEndDate.md) ↔ [DateTime](https://api.flutter.dev/flutter/dart-core/DateTime-class.html) +##### [eventEndDate](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventEndDate.md) ↔ [DateTime](https:api.flutter.dev/flutter/dart-core/DateTime-class.html) -_read / write_ +_\read / write\_ -##### [eventEndTime](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventEndTime.md) ↔ [TimeOfDay](https://api.flutter.dev/flutter/material/TimeOfDay-class.html) +##### [eventEndTime](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventEndTime.md) ↔ [TimeOfDay](https:api.flutter.dev/flutter/material/TimeOfDay-class.html) -_read / write_ +_\read / write\_ -##### [eventLocationTextController](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventLocationTextController.md) ↔ [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) +##### [eventLocationTextController](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventLocationTextController.md) ↔ [TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) -_read / write_ +_\read / write\_ -##### [eventStartDate](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventStartDate.md) ↔ [DateTime](https://api.flutter.dev/flutter/dart-core/DateTime-class.html) +##### [eventStartDate](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventStartDate.md) ↔ [DateTime](https:api.flutter.dev/flutter/dart-core/DateTime-class.html) -_read / write_ +_\read / write\_ -##### [eventStartTime](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventStartTime.md) ↔ [TimeOfDay](https://api.flutter.dev/flutter/material/TimeOfDay-class.html) +##### [eventStartTime](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventStartTime.md) ↔ [TimeOfDay](https:api.flutter.dev/flutter/material/TimeOfDay-class.html) -_read / write_ +_\read / write\_ -##### [eventTitleTextController](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventTitleTextController.md) ↔ [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) +##### [eventTitleTextController](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventTitleTextController.md) ↔ [TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) -_read / write_ +_\read / write\_ -##### [formKey](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/formKey.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[FormState](https://api.flutter.dev/flutter/widgets/FormState-class.html)> +##### [formKey](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/formKey.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[FormState](https:api.flutter.dev/flutter/widgets/FormState-class.html)\> -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hasListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hasListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether any listeners are currently registered. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isPublicSwitch](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/isPublicSwitch.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isPublicSwitch](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/isPublicSwitch.md) ↔ [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read / write_ +_\read / write\_ -##### [isRegisterableSwitch](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/isRegisterableSwitch.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isRegisterableSwitch](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/isRegisterableSwitch.md) ↔ [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read / write_ +_\read / write\_ -##### [locationFocus](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/locationFocus.md) ↔ [FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) +##### [locationFocus](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/locationFocus.md) ↔ [FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) -_read / write_ +_\read / write\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -192,25 +192,25 @@ _read-onlyinherited_ -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [titleFocus](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/titleFocus.md) ↔ [FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) +##### [titleFocus](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/titleFocus.md) ↔ [FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) -_read / write_ +_\read / write\_ -##### [validate](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/validate.md) ↔ [AutovalidateMode](https://api.flutter.dev/flutter/widgets/AutovalidateMode.html) +##### [validate](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/validate.md) ↔ [AutovalidateMode](https:api.flutter.dev/flutter/widgets/AutovalidateMode.html) -_read / write_ +_\read / write\_ @@ -218,23 +218,23 @@ _read / write_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be called when the object changes. -_inherited_ +_\inherited\_ -##### [dispose](https://api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void +##### [dispose](https:api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -
addListener will throw after the object is disposed). -_inherited_ +\addListener\ will throw after the object is disposed). +_\inherited\_ @@ -247,31 +247,31 @@ _inherited_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void +##### [notifyListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void Call all the registered listeners. -_inherited_ +_\inherited\_ -##### [removeListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that are notified when the object changes. -_inherited_ +_\inherited\_ @@ -280,25 +280,25 @@ _inherited_ -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [updateEvent](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/updateEvent.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [updateEvent](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/updateEvent.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> This function is used to update an event. -The function uses editEvent function provided by eventService service. +The function uses \editEvent\ function provided by \eventService\ service. @@ -307,12 +307,12 @@ The function uses editEvent function provided by eventService ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/descriptionFocus.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/descriptionFocus.md index 42e3cadfa14..efa48e36966 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/descriptionFocus.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/descriptionFocus.md @@ -9,9 +9,9 @@ -[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) descriptionFocus +[FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) descriptionFocus -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventDescriptionTextController.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventDescriptionTextController.md index 6c46c7d62f8..df10e3e5bac 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventDescriptionTextController.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventDescriptionTextController.md @@ -9,9 +9,9 @@ -[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) eventDescriptionTextController +[TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) eventDescriptionTextController -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventEndDate.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventEndDate.md index 9e06aaece51..6551ae3ccb5 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventEndDate.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventEndDate.md @@ -9,9 +9,9 @@ -[DateTime](https://api.flutter.dev/flutter/dart-core/DateTime-class.html) eventEndDate +[DateTime](https:api.flutter.dev/flutter/dart-core/DateTime-class.html) eventEndDate -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventEndTime.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventEndTime.md index fbcf2e3a593..908baa4fdde 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventEndTime.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventEndTime.md @@ -9,9 +9,9 @@ -[TimeOfDay](https://api.flutter.dev/flutter/material/TimeOfDay-class.html) eventEndTime +[TimeOfDay](https:api.flutter.dev/flutter/material/TimeOfDay-class.html) eventEndTime -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventLocationTextController.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventLocationTextController.md index 65a3646953b..e57fb469070 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventLocationTextController.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventLocationTextController.md @@ -9,9 +9,9 @@ -[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) eventLocationTextController +[TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) eventLocationTextController -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventStartDate.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventStartDate.md index 0f6005ef743..a1d31fcf6ed 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventStartDate.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventStartDate.md @@ -9,9 +9,9 @@ -[DateTime](https://api.flutter.dev/flutter/dart-core/DateTime-class.html) eventStartDate +[DateTime](https:api.flutter.dev/flutter/dart-core/DateTime-class.html) eventStartDate -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventStartTime.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventStartTime.md index 4a0fbcbd6cd..fb0fb7d6982 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventStartTime.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventStartTime.md @@ -9,9 +9,9 @@ -[TimeOfDay](https://api.flutter.dev/flutter/material/TimeOfDay-class.html) eventStartTime +[TimeOfDay](https:api.flutter.dev/flutter/material/TimeOfDay-class.html) eventStartTime -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventTitleTextController.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventTitleTextController.md index a8880e96af0..6c4adaab53f 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventTitleTextController.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventTitleTextController.md @@ -9,9 +9,9 @@ -[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) eventTitleTextController +[TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) eventTitleTextController -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/formKey.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/formKey.md index d7de0e859ad..b2f0242bc8f 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/formKey.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/formKey.md @@ -9,9 +9,9 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[FormState](https://api.flutter.dev/flutter/widgets/FormState-class.html)> formKey +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[FormState](https:api.flutter.dev/flutter/widgets/FormState-class.html)\> formKey -_final_ +_\final\_ @@ -21,7 +21,7 @@ _final_ ## Implementation ```dart -final formKey = GlobalKey(); +final formKey = GlobalKey\(); ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/initialize.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/initialize.md index 1ecb6819cd7..723774d6eec 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/initialize.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/initialize.md @@ -23,10 +23,10 @@ void initialize ## Implementation ```dart -void initialize(Event event) { +void initialize(Event event) \{ _event = event; _fillEditForm(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/isPublicSwitch.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/isPublicSwitch.md index 3f1458f4be8..e74ce70397a 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/isPublicSwitch.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/isPublicSwitch.md @@ -9,9 +9,9 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isPublicSwitch +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isPublicSwitch -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/isRegisterableSwitch.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/isRegisterableSwitch.md index 02f53c66c79..12683ca3602 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/isRegisterableSwitch.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/isRegisterableSwitch.md @@ -9,9 +9,9 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isRegisterableSwitch +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isRegisterableSwitch -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/locationFocus.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/locationFocus.md index bd199d216fc..45b6bdafb6d 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/locationFocus.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/locationFocus.md @@ -9,9 +9,9 @@ -[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) locationFocus +[FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) locationFocus -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/titleFocus.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/titleFocus.md index 43897adf9cb..7384372c2c5 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/titleFocus.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/titleFocus.md @@ -9,9 +9,9 @@ -[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) titleFocus +[FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) titleFocus -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/updateEvent.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/updateEvent.md index 5befd21fe1a..85234bc8b45 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/updateEvent.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/updateEvent.md @@ -10,27 +10,27 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> updateEvent +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> updateEvent () -

This function is used to update an event. -The function uses editEvent function provided by eventService service.

+\This function is used to update an event. +The function uses \editEvent\ function provided by \eventService\ service.\ ## Implementation ```dart -Future updateEvent() async { +Future\ updateEvent() async \{ titleFocus.unfocus(); locationFocus.unfocus(); descriptionFocus.unfocus(); validate = AutovalidateMode.always; - if (formKey.currentState!.validate()) { + if (formKey.currentState!.validate()) \{ validate = AutovalidateMode.disabled; final DateTime startTime = DateTime( eventStartDate.year, @@ -46,8 +46,8 @@ Future updateEvent() async { eventEndTime.hour, eventEndTime.minute, ); - // map for the required data to update an event. - final Map variables = { + map for the required data to update an event. + final Map\ variables = \{ 'title': eventTitleTextController.text, 'description': eventDescriptionTextController.text, 'location': eventLocationTextController.text, @@ -57,12 +57,12 @@ Future updateEvent() async { 'allDay': false, 'startDate': DateFormat('yyyy-MM-dd').format(eventStartDate), 'endDate': DateFormat('yyyy-MM-dd').format(eventEndDate), - 'startTime': '${DateFormat('HH:mm:ss').format(startTime)}Z', - 'endTime': '${DateFormat('HH:mm:ss').format(endTime)}Z', - }; + 'startTime': '$\{DateFormat('HH:mm:ss').format(startTime)\}Z', + 'endTime': '$\{DateFormat('HH:mm:ss').format(endTime)\}Z', + \}; _eventService.editEvent(eventId: _event.id!, variables: variables); - } -} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/validate.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/validate.md index 7dd63a4d447..2abd528167e 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/validate.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/validate.md @@ -9,9 +9,9 @@ -[AutovalidateMode](https://api.flutter.dev/flutter/widgets/AutovalidateMode.html) validate +[AutovalidateMode](https:api.flutter.dev/flutter/widgets/AutovalidateMode.html) validate -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel-class.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel-class.md index ca90a6094d5..c56af273ad5 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel-class.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel-class.md @@ -11,19 +11,19 @@ -

EventInfoViewModel class helps interacting with model to serve view with the event information data.'

-

Methods include:

-
    -
  • registerForEvent : to register user for an event.
  • -
  • getFabTitle : to get the status of "registration" for an event.
  • -
+\EventInfoViewModel class helps interacting with model to serve view with the event information data.'\ +\Methods include:\ +\ +\\registerForEvent\ : to register user for an event.\ +\\getFabTitle\ : to get the status of "registration" for an event.\ +\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) - [BaseModel](../view_model_base_view_model/BaseModel-class.md) - EventInfoViewModel @@ -48,7 +48,7 @@ -_read / write_ +_\read / write\_ @@ -57,61 +57,61 @@ _read / write_ -_read / write_ +_\read / write\_ -##### [fabTitle](../view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/fabTitle.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [fabTitle](../view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/fabTitle.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_read / write_ +_\read / write\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hasListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hasListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether any listeners are currently registered. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [registrants](../view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/registrants.md) ↔ [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)> +##### [registrants](../view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/registrants.md) ↔ [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../models_user_user_info/User-class.md)\> -_read / write_ +_\read / write\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -120,7 +120,7 @@ _read-onlyinherited_ -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -128,36 +128,36 @@ _read-onlyinherited_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be called when the object changes. -_inherited_ +_\inherited\_ -##### [dispose](https://api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void +##### [dispose](https:api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -
addListener will throw after the object is disposed). -_inherited_ +\addListener\ will throw after the object is disposed). +_\inherited\_ -##### [getFabTitle](../view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/getFabTitle.md)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [getFabTitle](../view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/getFabTitle.md)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -This function returns String type for the event registration status. +This function returns \String\ type for the event registration status. -##### [initialize](../view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/initialize.md)({required [Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> args}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [initialize](../view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/initialize.md)(\{required [Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> args\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -166,25 +166,25 @@ initialise with the event data fetched from the model. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void +##### [notifyListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void Call all the registered listeners. -_inherited_ +_\inherited\_ -##### [registerForEvent](../view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/registerForEvent.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [registerForEvent](../view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/registerForEvent.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -193,13 +193,13 @@ This function helps the user to register for an event. -##### [removeListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that are notified when the object changes. -_inherited_ +_\inherited\_ @@ -208,16 +208,16 @@ _inherited_ -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -225,12 +225,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/event.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/event.md index c2c81ab4f08..68cfc6dfd7e 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/event.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/event.md @@ -11,7 +11,7 @@ [Event](../../models_events_event_model/Event-class.md) event -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/exploreEventsInstance.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/exploreEventsInstance.md index 577772d8518..d52366d7b28 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/exploreEventsInstance.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/exploreEventsInstance.md @@ -11,7 +11,7 @@ [ExploreEventsViewModel](../../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md) exploreEventsInstance -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/fabTitle.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/fabTitle.md index ec2aa5e298f..130bde1d3ce 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/fabTitle.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/fabTitle.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) fabTitle +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) fabTitle -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/getFabTitle.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/getFabTitle.md index 2c51f02c845..4c7fce90d9b 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/getFabTitle.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/getFabTitle.md @@ -10,29 +10,29 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) getFabTitle +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) getFabTitle () -

This function returns String type for the event registration status.

+\This function returns \String\ type for the event registration status.\ ## Implementation ```dart -String getFabTitle() { - if (event.isRegisterable == false) { +String getFabTitle() \{ + if (event.isRegisterable == false) \{ return "Not Registrable"; - } else if (event.isRegistered == true) { + \} else if (event.isRegistered == true) \{ return "Registered"; - } else { + \} else \{ return "Register"; - } -} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/initialize.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/initialize.md index 4c6cd87ca6e..83c915e8079 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/initialize.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/initialize.md @@ -10,40 +10,40 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> initialize -({required [Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> args}) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> initialize +(\{required [Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> args\}) -

initialise with the event data fetched from the model.

+\initialise with the event data fetched from the model.\ ## Implementation ```dart -Future initialize({required Map args}) async { +Future\ initialize(\{required Map\ args\}) async \{ event = args["event"] as Event; exploreEventsInstance = args["exploreEventViewModel"] as ExploreEventsViewModel; fabTitle = getFabTitle(); setState(ViewState.busy); - final fetchRegistrantsByEventQueryResult = await locator() + final fetchRegistrantsByEventQueryResult = await locator\() .fetchRegistrantsByEvent(event.id!) as QueryResult; final registrantsJsonList = fetchRegistrantsByEventQueryResult - .data!['registrantsByEvent'] as List; + .data!['registrantsByEvent'] as List\; registrants = registrantsJsonList .map( - (registrantJson) => User.fromJson( - registrantJson! as Map, + (registrantJson) =\> User.fromJson( + registrantJson! as Map\, fromOrg: true, ), ) .toList(); setState(ViewState.idle); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/registerForEvent.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/registerForEvent.md index 453b6507519..6aca895608c 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/registerForEvent.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/registerForEvent.md @@ -10,44 +10,44 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> registerForEvent +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> registerForEvent () -

This function helps the user to register for an event.

+\This function helps the user to register for an event.\ ## Implementation ```dart -Future registerForEvent() async { - // if event registration is open and user not already registered for the event. - if (event.isRegisterable == true && event.isRegistered == false) { +Future\ registerForEvent() async \{ + if event registration is open and user not already registered for the event. + if (event.isRegisterable == true && event.isRegistered == false) \{ navigationService.pushDialog( const CustomProgressDialog( key: Key('RegisterEvent'), ), ); - // use `registerForAnEvent` function provided by `EventService` service. + use `registerForAnEvent` function provided by `EventService` service. final registerResult = - await locator().registerForAnEvent(event.id!); - //final registerResult = await EventService().registerForAnEvent(event.id!); - // if the registration is successful. - if (registerResult != null) { + await locator\().registerForAnEvent(event.id!); + final registerResult = await EventService().registerForAnEvent(event.id!); + if the registration is successful. + if (registerResult != null) \{ event.isRegistered = true; - registrants.add(locator().currentUser); - } + registrants.add(locator\().currentUser); + \} print(registerResult); fabTitle = getFabTitle(); navigationService.pop(); notifyListeners(); - } -} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/registrants.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/registrants.md index 3074b46da9b..7708b898c1d 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/registrants.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/registrants.md @@ -9,9 +9,9 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)> registrants +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)\> registrants -_read / write_ +_\read / write\_ @@ -21,7 +21,7 @@ _read / write_ ## Implementation ```dart -late List registrants; +late List\ registrants; ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md index 0db9f1f4b02..83e9892ec10 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md @@ -11,22 +11,22 @@ -

ExploreEventsViewModel class helps to interact with model to serve data to view for event explore section.

-

Methods include:

-
    -
  • fetchNewEvents : to fetch new events in the organization.
  • -
  • refreshEvents : to refersh the event.
  • -
  • checkIfExistsAndAddNewEvent : to check if the event exists or not, if now add a new event.
  • -
  • deleteEvent : to delete the event.
  • -
  • choseValueFromDropdown : to return the relevant message in the dropdown after any action.
  • -
+\ExploreEventsViewModel class helps to interact with model to serve data to view for event explore section.\ +\Methods include:\ +\ +\\fetchNewEvents\ : to fetch new events in the organization.\ +\\refreshEvents\ : to refersh the event.\ +\\checkIfExistsAndAddNewEvent\ : to check if the event exists or not, if now add a new event.\ +\\deleteEvent\ : to delete the event.\ +\\choseValueFromDropdown\ : to return the relevant message in the dropdown after any action.\ +\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) - [BaseModel](../view_model_base_view_model/BaseModel-class.md) - ExploreEventsViewModel @@ -46,30 +46,30 @@ ## Properties -##### [chosenValue](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/chosenValue.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [chosenValue](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/chosenValue.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_read-only_ +_\read-only\_ -##### [emptyListMessage](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/emptyListMessage.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [emptyListMessage](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/emptyListMessage.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_read-only_ +_\read-only\_ -##### [events](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/events.md) → [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Event](../models_events_event_model/Event-class.md)> +##### [events](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/events.md) → [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Event](../models_events_event_model/Event-class.md)\> -_read-only_ +_\read-only\_ @@ -78,43 +78,43 @@ _read-only_ -_read-only_ +_\read-only\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hasListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hasListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether any listeners are currently registered. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -123,7 +123,7 @@ _read-onlyinherited_ -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -131,16 +131,16 @@ _read-onlyinherited_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be called when the object changes. -_inherited_ +_\inherited\_ -##### [checkIfExistsAndAddNewEvent](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/checkIfExistsAndAddNewEvent.md)([Event](../models_events_event_model/Event-class.md) newEvent) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [checkIfExistsAndAddNewEvent](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/checkIfExistsAndAddNewEvent.md)([Event](../models_events_event_model/Event-class.md) newEvent) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -149,7 +149,7 @@ This function add a new event if the event not exist. -##### [choseValueFromDropdown](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/choseValueFromDropdown.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) value) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [choseValueFromDropdown](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/choseValueFromDropdown.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) value) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -159,7 +159,7 @@ return the filter events, if empty list then return relevant message. -##### [deleteEvent](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/deleteEvent.md)({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [deleteEvent](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/deleteEvent.md)(\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -174,22 +174,22 @@ This function deletes the event. Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -
addListener will throw after the object is disposed). -_override_ +\addListener\ will throw after the object is disposed). +_\override\_ -##### [fetchNewEvents](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/fetchNewEvents.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [fetchNewEvents](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/fetchNewEvents.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> This function is used to fetch new events in the organization. -The function uses getEvents method from EventService. +The function uses \getEvents\ method from \EventService\. -##### [initialise](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/initialise.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [initialise](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/initialise.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -198,41 +198,41 @@ The function uses getEvents method from EventService. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void +##### [notifyListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void Call all the registered listeners. -_inherited_ +_\inherited\_ -##### [refreshEvents](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/refreshEvents.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [refreshEvents](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/refreshEvents.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> This function is used to refresh the events in the organization. -The function uses getEvents method from EventService. +The function uses \getEvents\ method from \EventService\. -##### [removeListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that are notified when the object changes. -_inherited_ +_\inherited\_ @@ -241,16 +241,16 @@ _inherited_ -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -258,12 +258,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/checkIfExistsAndAddNewEvent.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/checkIfExistsAndAddNewEvent.md index e16d37fb291..ec533c8195f 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/checkIfExistsAndAddNewEvent.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/checkIfExistsAndAddNewEvent.md @@ -10,33 +10,33 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> checkIfExistsAndAddNewEvent +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> checkIfExistsAndAddNewEvent ([Event](../../models_events_event_model/Event-class.md) newEvent) -

This function add a new event if the event not exist.

-

params:

-
    -
  • newEvent : Event type variable containing data to create a new event.
  • -
+\This function add a new event if the event not exist.\ +\params:\ +\ +\\newEvent\ : \Event\ type variable containing data to create a new event.\ +\ ## Implementation ```dart -Future checkIfExistsAndAddNewEvent(Event newEvent) async { - // checking if the `newEvent.id` is unique and not exist already. +Future\ checkIfExistsAndAddNewEvent(Event newEvent) async \{ + checking if the `newEvent.id` is unique and not exist already. if ((!_uniqueEventIds.contains(newEvent.id)) && - (newEvent.organization!.id == userConfig.currentOrg.id)) { + (newEvent.organization!.id == userConfig.currentOrg.id)) \{ _uniqueEventIds.add(newEvent.id!); _parseEventDateTime(newEvent); notifyListeners(); - } -} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/choseValueFromDropdown.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/choseValueFromDropdown.md index a875ad66acb..1e0cd2d4dda 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/choseValueFromDropdown.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/choseValueFromDropdown.md @@ -10,103 +10,103 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> choseValueFromDropdown -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) value) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> choseValueFromDropdown +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) value) -

This function takes the choosen value from dropdown and -return the filter events, if empty list then return relevant message.

-

params:

-
    -
  • value : choosen value from dropdown.
  • -
+\This function takes the choosen value from dropdown and +return the filter events, if empty list then return relevant message.\ +\params:\ +\ +\\value\ : choosen value from dropdown.\ +\ ## Implementation ```dart -Future choseValueFromDropdown(String value) async { +Future\ choseValueFromDropdown(String value) async \{ _chosenValue = value; notifyListeners(); setState(ViewState.busy); - switch (_chosenValue) { - // if `_chosenValue` is "All events". + switch (_chosenValue) \{ + if `_chosenValue` is "All events". case 'All Events': - { - // all events + \{ + all events _events = _bufferEvents; - // if list is empty + if list is empty _emptyListMessage = "Looks like there aren't any events."; - } + \} break; - // if `_chosenValue` is "created event". + if `_chosenValue` is "created event". case 'Created Events': - { - // loop through the `_events` list and check - // for the creator id matched the current user id. + \{ + loop through the `_events` list and check + for the creator id matched the current user id. _events = List.from( _bufferEvents.where( - (element) => element.creator!.id == userConfig.currentUser.id, + (element) =\> element.creator!.id == userConfig.currentUser.id, ), ); - // if list is empty + if list is empty _emptyListMessage = "You have not created any event."; - } + \} break; - // if `_chosenValue` is "Registered Events". + if `_chosenValue` is "Registered Events". case 'Registered Events': - { - // loop through the `_events` list and filter elements - // if `element.isRegistered` is true and user is not the creator. + \{ + loop through the `_events` list and filter elements + if `element.isRegistered` is true and user is not the creator. _events = List.from( _bufferEvents.where( - (element) => + (element) =\> element.isRegistered == true && element.creator!.id != userConfig.currentUser.id, ), ); - // if list is empty + if list is empty _emptyListMessage = "No registered events are present"; - } + \} break; - // if `_chosenValue` is "Registered Events". + if `_chosenValue` is "Registered Events". case 'Public Events': - { - // loop through the `_events` list and filter elements - // with the `isPublic` as true. + \{ + loop through the `_events` list and filter elements + with the `isPublic` as true. _events = _bufferEvents - .where((element) => element.isPublic == true) + .where((element) =\> element.isPublic == true) .toList(); - // if list is empty + if list is empty _emptyListMessage = "There aren't any public events."; - } + \} break; case 'Private Events': - { - // loop through the `_events` list and filter elements - // with the `isPublic` as false. + \{ + loop through the `_events` list and filter elements + with the `isPublic` as false. _events = _bufferEvents - .where((element) => element.isPublic == false) + .where((element) =\> element.isPublic == false) .toList(); - // if list is empty + if list is empty _emptyListMessage = "There aren't any private events."; - } + \} break; default: - { + \{ _events = _bufferEvents; - } - } + \} + \} await Future.delayed(const Duration(milliseconds: 500)); setState(ViewState.idle); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/chosenValue.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/chosenValue.md index d75248d6971..8d83faf8b09 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/chosenValue.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/chosenValue.md @@ -11,7 +11,7 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) chosenValue +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) chosenValue @@ -23,7 +23,7 @@ ## Implementation ```dart -String get chosenValue => _chosenValue; +String get chosenValue =\> _chosenValue; ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/deleteEvent.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/deleteEvent.md index 62435c10d05..2c394979fb5 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/deleteEvent.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/deleteEvent.md @@ -10,50 +10,50 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> deleteEvent -({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId}) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> deleteEvent +(\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId\}) -

This function deletes the event.

-

params:

-
    -
  • eventId : id of the event that need to be delete.
  • -
+\This function deletes the event.\ +\params:\ +\ +\\eventId\ : id of the event that need to be delete.\ +\ ## Implementation ```dart -Future deleteEvent({required String eventId}) async { - // push the custom alert dialog to ask for confirmation. +Future\ deleteEvent(\{required String eventId\}) async \{ + push the custom alert dialog to ask for confirmation. navigationService.pushDialog( CustomAlertDialog( reverse: true, dialogSubTitle: 'Are you sure you want to delete this event?', successText: 'Delete', - success: () { + success: () \{ navigationService.pop(); _eventService.deleteEvent(eventId).then( - (result) async { - if (result != null) { + (result) async \{ + if (result != null) \{ navigationService.pop(); setState(ViewState.busy); print(result); _uniqueEventIds.remove(eventId); - _events.removeWhere((element) => element.id == eventId); + _events.removeWhere((element) =\> element.id == eventId); await Future.delayed(const Duration(milliseconds: 500)); setState(ViewState.idle); - } - }, + \} + \}, ); - }, + \}, ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/dispose.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/dispose.md index 6c23fac6a5f..da8226bba27 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/dispose.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/dispose.md @@ -9,22 +9,22 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) void dispose () -_override_ +_\override\_ -

Discards any resources used by the object. After this is called, the +\Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -addListener will throw after the object is disposed).

-

This method should only be called by the object's owner.

-

This method does not notify listeners, and clears the listener list once +\addListener\ will throw after the object is disposed).\ +\This method should only be called by the object's owner.\ +\This method does not notify listeners, and clears the listener list once it is called. Consumers of this class must decide on whether to notify -listeners or not immediately before disposal.

+listeners or not immediately before disposal.\ @@ -32,11 +32,11 @@ listeners or not immediately before disposal.

```dart @override -void dispose() { +void dispose() \{ _eventStreamSubscription.cancel(); _currentOrganizationStreamSubscription.cancel(); super.dispose(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/emptyListMessage.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/emptyListMessage.md index 9f89f47bafe..7ab3378d633 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/emptyListMessage.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/emptyListMessage.md @@ -11,7 +11,7 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) emptyListMessage +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) emptyListMessage @@ -23,7 +23,7 @@ ## Implementation ```dart -String get emptyListMessage => _emptyListMessage; +String get emptyListMessage =\> _emptyListMessage; ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/eventService.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/eventService.md index face3b442d0..3484950ec5c 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/eventService.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/eventService.md @@ -23,7 +23,7 @@ ## Implementation ```dart -EventService get eventService => _eventService; +EventService get eventService =\> _eventService; ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/events.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/events.md index c267070c56b..002b31b766b 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/events.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/events.md @@ -11,7 +11,7 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Event](../../models_events_event_model/Event-class.md)> events +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Event](../../models_events_event_model/Event-class.md)\> events @@ -23,7 +23,7 @@ ## Implementation ```dart -List get events => _events; +List\ get events =\> _events; ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/fetchNewEvents.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/fetchNewEvents.md index 9722f847c5d..5df0c31426b 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/fetchNewEvents.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/fetchNewEvents.md @@ -10,27 +10,27 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> fetchNewEvents +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> fetchNewEvents () -

This function is used to fetch new events in the organization. -The function uses getEvents method from EventService.

+\This function is used to fetch new events in the organization. +The function uses \getEvents\ method from \EventService\.\ ## Implementation ```dart -Future fetchNewEvents() async { +Future\ fetchNewEvents() async \{ setState(ViewState.busy); notifyListeners(); await _eventService.getEvents(); setState(ViewState.idle); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/initialise.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/initialise.md index cb43c5c962a..dd72c582381 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/initialise.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/initialise.md @@ -10,7 +10,7 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> initialise +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> initialise () @@ -23,18 +23,18 @@ ## Implementation ```dart -Future initialise() async { +Future\ initialise() async \{ setState(ViewState.busy); _currentOrganizationStreamSubscription = userConfig.currentOrgInfoStream - .listen((updatedOrganization) => refreshEvents()); + .listen((updatedOrganization) =\> refreshEvents()); await _eventService.getEvents(); _eventStreamSubscription = _eventService.eventStream.listen( - (newEvent) => checkIfExistsAndAddNewEvent(newEvent), + (newEvent) =\> checkIfExistsAndAddNewEvent(newEvent), ); _bufferEvents = _events; setState(ViewState.idle); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/refreshEvents.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/refreshEvents.md index ed1c495c5c9..2933e82eed0 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/refreshEvents.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/refreshEvents.md @@ -10,28 +10,28 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> refreshEvents +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> refreshEvents () -

This function is used to refresh the events in the organization. -The function uses getEvents method from EventService.

+\This function is used to refresh the events in the organization. +The function uses \getEvents\ method from \EventService\.\ ## Implementation ```dart -Future refreshEvents() async { +Future\ refreshEvents() async \{ setState(ViewState.busy); _events.clear(); _uniqueEventIds.clear(); await _eventService.getEvents(); setState(ViewState.idle); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel-class.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel-class.md index 3241daad6db..cd38f243b1f 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel-class.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel-class.md @@ -11,23 +11,23 @@ -

OrganizationFeedViewModel class helps to interact with model to serve data to view for organization feed section.

-

Methods include:

-
    -
  • setCurrentOrganizationName : to set current organization name.
  • -
  • fetchNewPosts : to fetch new posts in the organization.
  • -
  • navigateToIndividualPage : to navigate to individual page.
  • -
  • navigateToPinnedPostPage : to navigate to pinned post page.
  • -
  • addNewPost : to add new post in the organization.
  • -
  • updatedPost : to update a post in the organization.
  • -
+\OrganizationFeedViewModel class helps to interact with model to serve data to view for organization feed section.\ +\Methods include:\ +\ +\\setCurrentOrganizationName\ : to set current organization name.\ +\\fetchNewPosts\ : to fetch new posts in the organization.\ +\\navigateToIndividualPage\ : to navigate to individual page.\ +\\navigateToPinnedPostPage\ : to navigate to pinned post page.\ +\\addNewPost\ : to add new post in the organization.\ +\\updatedPost\ : to update a post in the organization.\ +\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) - [BaseModel](../view_model_base_view_model/BaseModel-class.md) - OrganizationFeedViewModel @@ -47,75 +47,75 @@ ## Properties -##### [currentOrgName](../view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/currentOrgName.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [currentOrgName](../view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/currentOrgName.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_read-only_ +_\read-only\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hasListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hasListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether any listeners are currently registered. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [istest](../view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/istest.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [istest](../view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/istest.md) ↔ [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read / write_ +_\read / write\_ -##### [pinnedPosts](../view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/pinnedPosts.md) → [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../models_post_post_model/Post-class.md)> +##### [pinnedPosts](../view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/pinnedPosts.md) → [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../models_post_post_model/Post-class.md)\> -_read-only_ +_\read-only\_ -##### [posts](../view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/posts.md) → [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../models_post_post_model/Post-class.md)> +##### [posts](../view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/posts.md) → [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../models_post_post_model/Post-class.md)\> -_read-only_ +_\read-only\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -124,7 +124,7 @@ _read-onlyinherited_ -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -132,12 +132,12 @@ _read-onlyinherited_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be called when the object changes. -_inherited_ +_\inherited\_ @@ -150,11 +150,11 @@ This function adds new Post. -##### [buildNewPosts](../view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/buildNewPosts.md)([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../models_post_post_model/Post-class.md)> newPosts) void +##### [buildNewPosts](../view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/buildNewPosts.md)([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../models_post_post_model/Post-class.md)\> newPosts) void -This function initialise _posts with newPosts. +This function initialise \_posts\ with \newPosts\. @@ -165,8 +165,8 @@ This function initialise _posts with newPosts. Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -
addListener will throw after the object is disposed). -_override_ +\addListener\ will throw after the object is disposed). +_\override\_ @@ -179,7 +179,7 @@ This function fetches new posts in the organization. -##### [initialise](../view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/initialise.md)({[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isTest = false}) void +##### [initialise](../view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/initialise.md)(\{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isTest = false\}) void @@ -215,35 +215,35 @@ This function navigate to pinned post page. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void +##### [notifyListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void Call all the registered listeners. -_inherited_ +_\inherited\_ -##### [removeListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that are notified when the object changes. -_inherited_ +_\inherited\_ -##### [setCurrentOrganizationName](../view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/setCurrentOrganizationName.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) updatedOrganization) void +##### [setCurrentOrganizationName](../view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/setCurrentOrganizationName.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) updatedOrganization) void @@ -257,16 +257,16 @@ This function sets the organization name after update. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -283,12 +283,12 @@ This function updates the post. ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/addNewPost.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/addNewPost.md index 8c2c03afe3a..fa68f1d8198 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/addNewPost.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/addNewPost.md @@ -17,21 +17,21 @@ void addNewPost -

This function adds new Post.

-

params:

-
    -
  • newPost
  • -
+\This function adds new Post.\ +\params:\ +\ +\\newPost\\ +\ ## Implementation ```dart -void addNewPost(Post newPost) { +void addNewPost(Post newPost) \{ _posts.insert(0, newPost); notifyListeners(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/buildNewPosts.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/buildNewPosts.md index 55261441cd1..7967248ae17 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/buildNewPosts.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/buildNewPosts.md @@ -11,27 +11,27 @@ void buildNewPosts -([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)> newPosts) +([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)\> newPosts) -

This function initialise _posts with newPosts.

-

params:

-
    -
  • newPosts
  • -
+\This function initialise \_posts\ with \newPosts\.\ +\params:\ +\ +\\newPosts\\ +\ ## Implementation ```dart -void buildNewPosts(List newPosts) { +void buildNewPosts(List\ newPosts) \{ _posts = newPosts; notifyListeners(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/currentOrgName.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/currentOrgName.md index 9688a5a1b90..fa15cb58e07 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/currentOrgName.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/currentOrgName.md @@ -11,7 +11,7 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) currentOrgName +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) currentOrgName @@ -23,7 +23,7 @@ ## Implementation ```dart -String get currentOrgName => _currentOrgName; +String get currentOrgName =\> _currentOrgName; ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/dispose.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/dispose.md index b9bddb208fd..19ccdbbb2c2 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/dispose.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/dispose.md @@ -9,22 +9,22 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) void dispose () -_override_ +_\override\_ -

Discards any resources used by the object. After this is called, the +\Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -addListener will throw after the object is disposed).

-

This method should only be called by the object's owner.

-

This method does not notify listeners, and clears the listener list once +\addListener\ will throw after the object is disposed).\ +\This method should only be called by the object's owner.\ +\This method does not notify listeners, and clears the listener list once it is called. Consumers of this class must decide on whether to notify -listeners or not immediately before disposal.

+listeners or not immediately before disposal.\ @@ -32,13 +32,13 @@ listeners or not immediately before disposal.

```dart @override -void dispose() { - // Canceling the subscription so that there will be no rebuild after the widget is disposed. +void dispose() \{ + Canceling the subscription so that there will be no rebuild after the widget is disposed. _currentOrganizationStreamSubscription.cancel(); _postsSubscription.cancel(); _updatePostSubscription.cancel(); super.dispose(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/fetchNewPosts.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/fetchNewPosts.md index a01c185d7c0..079611c81b7 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/fetchNewPosts.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/fetchNewPosts.md @@ -17,16 +17,16 @@ void fetchNewPosts -

This function fetches new posts in the organization.

+\This function fetches new posts in the organization.\ ## Implementation ```dart -void fetchNewPosts() { +void fetchNewPosts() \{ _postService.getPosts(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/initialise.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/initialise.md index cea956cdbab..51f80253d13 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/initialise.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/initialise.md @@ -11,7 +11,7 @@ void initialise -({[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isTest = false}) +(\{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isTest = false\}) @@ -24,30 +24,30 @@ void initialise ```dart void initialise( - // bool forTest, - { + bool forTest, + \{ bool isTest = false, -}) { - // For caching/initializing the current organization after the stream subscription has canceled and the stream is updated +\}) \{ + For caching/initializing the current organization after the stream subscription has canceled and the stream is updated _currentOrgName = _userConfig.currentOrg.name!; - // ------ - // Attaching the stream subscription to rebuild the widgets automatically + ------ + Attaching the stream subscription to rebuild the widgets automatically _currentOrganizationStreamSubscription = _userConfig.currentOrgInfoStream.listen( - (updatedOrganization) => + (updatedOrganization) =\> setCurrentOrganizationName(updatedOrganization.name!), ); - _postsSubscription = _postService.postStream.listen((newPosts) { + _postsSubscription = _postService.postStream.listen((newPosts) \{ return buildNewPosts(newPosts); - }); + \}); _updatePostSubscription = - _postService.updatedPostStream.listen((post) => updatedPost(post)); - if (isTest) { + _postService.updatedPostStream.listen((post) =\> updatedPost(post)); + if (isTest) \{ istest = true; - } -} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/initializeWithDemoData.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/initializeWithDemoData.md index a6589facc87..e4d2306a67f 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/initializeWithDemoData.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/initializeWithDemoData.md @@ -23,19 +23,17 @@ void initializeWithDemoData ## Implementation ```dart -void initializeWithDemoData() { - // final postJsonResult = postsDemoData; - // - // ------ - // // Calling function to ge the post for the only 1st time. - // _postService.getPosts(); - // - // //fetching pinnedPosts - // final pinnedPostJsonResult = pinnedPostsDemoData; - // pinnedPostJsonResult.forEach((pinnedPostJsonData) { - // _pinnedPosts.add(Post.fromJson(pinnedPostJsonData)); - // }); -} +void initializeWithDemoData() \{ + final postJsonResult = postsDemoData; + ------ + Calling function to ge the post for the only 1st time. + _postService.getPosts(); + fetching pinnedPosts + final pinnedPostJsonResult = pinnedPostsDemoData; + pinnedPostJsonResult.forEach((pinnedPostJsonData) \{ + _pinnedPosts.add(Post.fromJson(pinnedPostJsonData)); + \}); +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/istest.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/istest.md index 7b27c4dd8a6..b8ef4a72476 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/istest.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/istest.md @@ -9,9 +9,9 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) istest +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) istest -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/navigateToIndividualPage.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/navigateToIndividualPage.md index 82d923bcdf1..8b8f75de488 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/navigateToIndividualPage.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/navigateToIndividualPage.md @@ -17,17 +17,17 @@ void navigateToIndividualPage -

This function navigate to individual post page.

+\This function navigate to individual post page.\ ## Implementation ```dart -void navigateToIndividualPage(Post post) { - // uses `pushScreen` method by `navigationService` service. +void navigateToIndividualPage(Post post) \{ + uses `pushScreen` method by `navigationService` service. _navigationService.pushScreen(Routes.individualPost, arguments: post); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/navigateToPinnedPostPage.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/navigateToPinnedPostPage.md index 75f8159c1f4..733daa10516 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/navigateToPinnedPostPage.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/navigateToPinnedPostPage.md @@ -17,20 +17,20 @@ void navigateToPinnedPostPage -

This function navigate to pinned post page.

+\This function navigate to pinned post page.\ ## Implementation ```dart -void navigateToPinnedPostPage() { - // uses `pushScreen` method by `navigationService` service. +void navigateToPinnedPostPage() \{ + uses `pushScreen` method by `navigationService` service. _navigationService.pushScreen( Routes.pinnedPostPage, arguments: _pinnedPosts, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/pinnedPosts.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/pinnedPosts.md index 88ef2709ee2..846ae27c9cf 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/pinnedPosts.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/pinnedPosts.md @@ -11,7 +11,7 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)> pinnedPosts +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)\> pinnedPosts @@ -23,13 +23,13 @@ ## Implementation ```dart -List get pinnedPosts { - if (istest) { +List\ get pinnedPosts \{ + if (istest) \{ _pinnedPosts = []; return _pinnedPosts; - } + \} return _pinnedPosts; -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/posts.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/posts.md index be2240d6a63..f4d96016b34 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/posts.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/posts.md @@ -11,7 +11,7 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)> posts +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)\> posts @@ -23,13 +23,13 @@ ## Implementation ```dart -List get posts { - // if (istest) { - // _posts = pinnedPostsDemoData.map((e) => Post.fromJson(e)).toList(); - // return _posts; - // } +List\ get posts \{ + if (istest) \{ + _posts = pinnedPostsDemoData.map((e) =\> Post.fromJson(e)).toList(); return _posts; -} + \} + return _posts; +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/setCurrentOrganizationName.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/setCurrentOrganizationName.md index df80565db6f..3a2b9137516 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/setCurrentOrganizationName.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/setCurrentOrganizationName.md @@ -11,33 +11,33 @@ void setCurrentOrganizationName -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) updatedOrganization) +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) updatedOrganization) -

This function sets the organization name after update.

-

params:

-
    -
  • updatedOrganization : updated organization name.
  • -
+\This function sets the organization name after update.\ +\params:\ +\ +\\updatedOrganization\ : updated organization name.\ +\ ## Implementation ```dart -void setCurrentOrganizationName(String updatedOrganization) { - // if `updatedOrganization` is not same to `_currentOrgName`. - if (updatedOrganization != _currentOrgName) { +void setCurrentOrganizationName(String updatedOrganization) \{ + if `updatedOrganization` is not same to `_currentOrgName`. + if (updatedOrganization != _currentOrgName) \{ _posts.clear(); _renderedPostID.clear(); _currentOrgName = updatedOrganization; notifyListeners(); - } - // _postService.getPosts(); -} + \} + _postService.getPosts(); +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/updatedPost.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/updatedPost.md index ad276dec3ff..4d62398fb51 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/updatedPost.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/updatedPost.md @@ -17,26 +17,26 @@ void updatedPost -

This function updates the post.

-

params:

-
    -
  • post
  • -
+\This function updates the post.\ +\params:\ +\ +\\post\\ +\ ## Implementation ```dart -void updatedPost(Post post) { - for (int i = 0; i < _posts.length; i++) { - if (_posts[i].sId == post.sId) { +void updatedPost(Post post) \{ + for (int i = 0; i \< _posts.length; i++) \{ + if (_posts[i].sId == post.sId) \{ _posts[i] = post; notifyListeners(); break; - } - } -} + \} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel-class.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel-class.md index f83ea766cfd..dcf615611a5 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel-class.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel-class.md @@ -11,18 +11,18 @@ -

EditProfilePageViewModel class helps to interact with model to serve data to edit profile views.

-

Methods include:

-
    -
  • getImageFromGallery
  • -
+\EditProfilePageViewModel class helps to interact with model to serve data to edit profile views.\ +\Methods include:\ +\ +\\getImageFromGallery\\ +\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) - [BaseModel](../view_model_base_view_model/BaseModel-class.md) - EditProfilePageViewModel @@ -47,88 +47,88 @@ -_final_ +_\final\_ -##### [firstNameFocus](../view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/firstNameFocus.md) ↔ [FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) +##### [firstNameFocus](../view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/firstNameFocus.md) ↔ [FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) -_read / write_ +_\read / write\_ -##### [firstNameTextController](../view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/firstNameTextController.md) ↔ [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) +##### [firstNameTextController](../view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/firstNameTextController.md) ↔ [TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) -_read / write_ +_\read / write\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hasListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hasListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether any listeners are currently registered. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [imageFile](../view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/imageFile.md) ↔ [File](https://api.flutter.dev/flutter/dart-io/File-class.html)? +##### [imageFile](../view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/imageFile.md) ↔ [File](https:api.flutter.dev/flutter/dart-io/File-class.html)? -_read / write_ +_\read / write\_ -##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [lastNameFocus](../view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/lastNameFocus.md) ↔ [FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) +##### [lastNameFocus](../view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/lastNameFocus.md) ↔ [FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) -_read / write_ +_\read / write\_ -##### [lastNameTextController](../view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/lastNameTextController.md) ↔ [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) +##### [lastNameTextController](../view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/lastNameTextController.md) ↔ [TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) -_read / write_ +_\read / write\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -137,7 +137,7 @@ _read-onlyinherited_ -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -146,7 +146,7 @@ _read-onlyinherited_ -_final_ +_\final\_ @@ -154,32 +154,32 @@ _final_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be called when the object changes. -_inherited_ +_\inherited\_ -##### [dispose](https://api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void +##### [dispose](https:api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -
addListener will throw after the object is disposed). -_inherited_ +\addListener\ will throw after the object is disposed). +_\inherited\_ -##### [getImageFromGallery](../view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/getImageFromGallery.md)({[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) camera = false}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [getImageFromGallery](../view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/getImageFromGallery.md)(\{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) camera = false\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> This function is used to get the image from gallery. -The function uses the _multiMediaPickerService services. +The function uses the \_multiMediaPickerService\ services. @@ -193,21 +193,21 @@ The function uses the _multiMediaPickerService services. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void +##### [notifyListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void Call all the registered listeners. -_inherited_ +_\inherited\_ @@ -220,13 +220,13 @@ This function remove the selected image. -##### [removeListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that are notified when the object changes. -_inherited_ +_\inherited\_ @@ -235,16 +235,16 @@ _inherited_ -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -252,12 +252,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/databaseService.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/databaseService.md index 611b9398556..69f557e0b0b 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/databaseService.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/databaseService.md @@ -11,7 +11,7 @@ [DataBaseMutationFunctions](../../services_database_mutation_functions/DataBaseMutationFunctions-class.md) databaseService -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/firstNameFocus.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/firstNameFocus.md index 48ab5e6a563..6c92e8530d9 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/firstNameFocus.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/firstNameFocus.md @@ -9,9 +9,9 @@ -[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) firstNameFocus +[FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) firstNameFocus -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/firstNameTextController.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/firstNameTextController.md index ad9f13aa618..788cf99d6d3 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/firstNameTextController.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/firstNameTextController.md @@ -9,9 +9,9 @@ -[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) firstNameTextController +[TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) firstNameTextController -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/getImageFromGallery.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/getImageFromGallery.md index b1f5eda7ceb..be147c1cb86 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/getImageFromGallery.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/getImageFromGallery.md @@ -10,33 +10,33 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> getImageFromGallery -({[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) camera = false}) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> getImageFromGallery +(\{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) camera = false\}) -

This function is used to get the image from gallery. -The function uses the _multiMediaPickerService services.

-

params:

-
    -
  • camera : if true then open camera for image, else open gallery to select image.
  • -
+\This function is used to get the image from gallery. +The function uses the \_multiMediaPickerService\ services.\ +\params:\ +\ +\\camera\ : if true then open camera for image, else open gallery to select image.\ +\ ## Implementation ```dart -Future getImageFromGallery({bool camera = false}) async { +Future\ getImageFromGallery(\{bool camera = false\}) async \{ final image = await _multiMediaPickerService.getPhotoFromGallery(camera: camera); - if (image != null) { + if (image != null) \{ imageFile = image; notifyListeners(); - } -} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/imageFile.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/imageFile.md index 57c47fbe12f..78f04a6850d 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/imageFile.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/imageFile.md @@ -9,9 +9,9 @@ -[File](https://api.flutter.dev/flutter/dart-io/File-class.html)? imageFile +[File](https:api.flutter.dev/flutter/dart-io/File-class.html)? imageFile -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/initialize.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/initialize.md index 0c1fdae5c77..80fc49ae8b7 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/initialize.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/initialize.md @@ -23,10 +23,10 @@ void initialize ## Implementation ```dart -void initialize() { +void initialize() \{ imageFile = null; - _multiMediaPickerService = locator(); -} + _multiMediaPickerService = locator\(); +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/lastNameFocus.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/lastNameFocus.md index e304beed056..740e6f608ff 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/lastNameFocus.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/lastNameFocus.md @@ -9,9 +9,9 @@ -[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) lastNameFocus +[FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) lastNameFocus -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/lastNameTextController.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/lastNameTextController.md index e7cd6c0a28c..4fd4d1f1eca 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/lastNameTextController.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/lastNameTextController.md @@ -9,9 +9,9 @@ -[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) lastNameTextController +[TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) lastNameTextController -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/removeImage.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/removeImage.md index 2f0f573c0b8..aea59c5db2e 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/removeImage.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/removeImage.md @@ -17,17 +17,17 @@ void removeImage -

This function remove the selected image.

+\This function remove the selected image.\ ## Implementation ```dart -void removeImage() { +void removeImage() \{ imageFile = null; notifyListeners(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/user.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/user.md index d20415aecda..03cc90f13f4 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/user.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/user.md @@ -11,7 +11,7 @@ [User](../../models_user_user_info/User-class.md) user -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md index 399f3e78932..709406c84f8 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md @@ -11,19 +11,19 @@ -

ProfilePageViewModel class helps to interact with model to serve data -and react to user's input in Profile Page view.

-

Methods include:

-
    -
  • logout
  • -
+\ProfilePageViewModel class helps to interact with model to serve data +and react to user's input in Profile Page view.\ +\Methods include:\ +\ +\\logout\\ +\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) - [BaseModel](../view_model_base_view_model/BaseModel-class.md) - ProfilePageViewModel @@ -43,12 +43,12 @@ and react to user's input in Profile Page view.

## Properties -##### [bottomSheetHeight](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/bottomSheetHeight.md) ↔ [double](https://api.flutter.dev/flutter/dart-core/double-class.html) +##### [bottomSheetHeight](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/bottomSheetHeight.md) ↔ [double](https:api.flutter.dev/flutter/dart-core/double-class.html) -_read / write_ +_\read / write\_ @@ -57,7 +57,7 @@ _read / write_ -_read / write_ +_\read / write\_ @@ -66,106 +66,106 @@ _read / write_ -_read / write_ +_\read / write\_ -##### [denomination](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/denomination.md) → [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html)> +##### [denomination](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/denomination.md) → [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html)\> -_final_ +_\final\_ -##### [donationAmount](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationAmount.md) ↔ [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) +##### [donationAmount](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationAmount.md) ↔ [TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) -_read / write_ +_\read / write\_ -##### [donationCurrency](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationCurrency.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [donationCurrency](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationCurrency.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_read / write_ +_\read / write\_ -##### [donationCurrencySymbol](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationCurrencySymbol.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [donationCurrencySymbol](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationCurrencySymbol.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_read / write_ +_\read / write\_ -##### [donationField](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationField.md) → [FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) +##### [donationField](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationField.md) → [FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hasListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hasListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether any listeners are currently registered. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [organisation](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/organisation.md) ↔ [Box](https://pub.dev/documentation/hive/2.2.3/hive/Box-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)> +##### [organisation](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/organisation.md) ↔ [Box](https:pub.dev/documentation/hive/2.2.3/hive/Box-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)\> -_latefinal_ +_\late\\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [scaffoldKey](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/scaffoldKey.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[ScaffoldState](https://api.flutter.dev/flutter/material/ScaffoldState-class.html)> +##### [scaffoldKey](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/scaffoldKey.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[ScaffoldState](https:api.flutter.dev/flutter/material/ScaffoldState-class.html)\> -_final_ +_\final\_ @@ -174,25 +174,25 @@ _final_ -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [url](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/url.md) ↔ [Box](https://pub.dev/documentation/hive/2.2.3/hive/Box-class.html) +##### [url](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/url.md) ↔ [Box](https:pub.dev/documentation/hive/2.2.3/hive/Box-class.html) -_latefinal_ +_\late\\final\_ -##### [user](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/user.md) ↔ [Box](https://pub.dev/documentation/hive/2.2.3/hive/Box-class.html)<[User](../models_user_user_info/User-class.md)> +##### [user](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/user.md) ↔ [Box](https:pub.dev/documentation/hive/2.2.3/hive/Box-class.html)<[User](../models_user_user_info/User-class.md)\> -_latefinal_ +_\late\\final\_ @@ -200,16 +200,16 @@ _latefinal_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be called when the object changes. -_inherited_ +_\inherited\_ -##### [attachListener](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/attachListener.md)([Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) setter) void +##### [attachListener](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/attachListener.md)([Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) setter) void @@ -218,7 +218,7 @@ _inherited_ -##### [changeCurrency](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/changeCurrency.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context, [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) setter) void +##### [changeCurrency](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/changeCurrency.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context, [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) setter) void @@ -227,18 +227,18 @@ This method changes the currency of the user for donation purpose. -##### [dispose](https://api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void +##### [dispose](https:api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -
addListener will throw after the object is disposed). -_inherited_ +\addListener\ will throw after the object is disposed). +_\inherited\_ -##### [dominationButton](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/dominationButton.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) amount, [BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context, [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) setter) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [dominationButton](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/dominationButton.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) amount, [BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context, [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) setter) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) @@ -247,7 +247,7 @@ This widget returns button for domination. -##### [iconButton](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/iconButton.md)([Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) icon, [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) onTap) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [iconButton](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/iconButton.md)([Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) icon, [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) onTap) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) @@ -265,7 +265,7 @@ This widget returns the button for social media sharing option. -##### [invite](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/invite.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) void +##### [invite](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/invite.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) void @@ -275,7 +275,7 @@ Dialog box contains the QR-code of organization invite link and social media sha -##### [logout](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/logout.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [logout](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/logout.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -285,21 +285,21 @@ The function asks for the confimation in Custom Alert Dialog. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void +##### [notifyListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void Call all the registered listeners. -_inherited_ +_\inherited\_ @@ -312,13 +312,13 @@ _inherited_ -##### [removeListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that are notified when the object changes. -_inherited_ +_\inherited\_ @@ -327,11 +327,11 @@ _inherited_ -_inherited_ +_\inherited\_ -##### [showSnackBar](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/showSnackBar.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) message) void +##### [showSnackBar](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/showSnackBar.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) message) void @@ -340,12 +340,12 @@ _inherited_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -362,12 +362,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/attachListener.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/attachListener.md index edcf927825a..14d72cb3abd 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/attachListener.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/attachListener.md @@ -11,7 +11,7 @@ void attachListener -([Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) setter) +([Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) setter) @@ -23,23 +23,23 @@ void attachListener ## Implementation ```dart -void attachListener(Function setter) { - donationField.addListener(() { - if (donationField.hasFocus) { - setter(() { +void attachListener(Function setter) \{ + donationField.addListener(() \{ + if (donationField.hasFocus) \{ + setter(() \{ bottomSheetHeight = SizeConfig.screenHeight! * 0.8725; - }); - } else { - Future.delayed(const Duration(milliseconds: 300), () { - { - setter(() { + \}); + \} else \{ + Future.delayed(const Duration(milliseconds: 300), () \{ + \{ + setter(() \{ bottomSheetHeight = SizeConfig.screenHeight! * 0.68; - }); - } - }); - } - }); -} + \}); + \} + \}); + \} + \}); +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/bottomSheetHeight.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/bottomSheetHeight.md index 6b02dd5428e..20a402bfc37 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/bottomSheetHeight.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/bottomSheetHeight.md @@ -9,9 +9,9 @@ -[double](https://api.flutter.dev/flutter/dart-core/double-class.html) bottomSheetHeight +[double](https:api.flutter.dev/flutter/dart-core/double-class.html) bottomSheetHeight -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/changeCurrency.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/changeCurrency.md index 123044aa49b..87eb8716a8a 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/changeCurrency.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/changeCurrency.md @@ -11,31 +11,31 @@ void changeCurrency -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context, [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) setter) +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context, [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) setter) -

This method changes the currency of the user for donation purpose.

+\This method changes the currency of the user for donation purpose.\ ## Implementation ```dart -void changeCurrency(BuildContext context, Function setter) { +void changeCurrency(BuildContext context, Function setter) \{ showCurrencyPicker( context: context, currencyFilter: supportedCurrencies, - onSelect: (Currency currency) { - setter(() { + onSelect: (Currency currency) \{ + setter(() \{ donationCurrency = currency.code; donationCurrencySymbol = currency.symbol; - }); - }, + \}); + \}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/currentOrg.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/currentOrg.md index 6455d508dd8..e33538bdf85 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/currentOrg.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/currentOrg.md @@ -11,7 +11,7 @@ [OrgInfo](../../models_organization_org_info/OrgInfo-class.md) currentOrg -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/currentUser.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/currentUser.md index e955d406240..58980d18f65 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/currentUser.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/currentUser.md @@ -11,7 +11,7 @@ [User](../../models_user_user_info/User-class.md) currentUser -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/denomination.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/denomination.md index d75e715f016..241dbd833a0 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/denomination.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/denomination.md @@ -9,9 +9,9 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html)> denomination +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html)\> denomination -_final_ +_\final\_ @@ -21,7 +21,7 @@ _final_ ## Implementation ```dart -final List denomination = ['1', '5', '10']; +final List\ denomination = ['1', '5', '10']; ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/dominationButton.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/dominationButton.md index b69ecf71615..df429ae0340 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/dominationButton.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/dominationButton.md @@ -10,19 +10,19 @@ -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) dominationButton -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) amount, [BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context, [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) setter) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) dominationButton +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) amount, [BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context, [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) setter) -

This widget returns button for domination.

-

params:

-
    -
  • amount : donation Amount.
  • -
  • setter : Function type, which on tap set the amount to donationAmount.
  • -
+\This widget returns button for domination.\ +\params:\ +\ +\\amount\ : donation Amount.\ +\\setter\ : \Function\ type, which on tap set the amount to \donationAmount\.\ +\ @@ -33,13 +33,13 @@ Widget dominationButton( String amount, BuildContext context, Function setter, -) { +) \{ return InkWell( - onTap: () { - setter(() { + onTap: () \{ + setter(() \{ donationAmount.text = amount; - }); - }, + \}); + \}, child: Container( padding: EdgeInsets.symmetric( vertical: SizeConfig.screenHeight! * 0.02, @@ -57,7 +57,7 @@ Widget dominationButton( ), ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationAmount.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationAmount.md index 9ce57b25868..f920dee3e03 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationAmount.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationAmount.md @@ -9,9 +9,9 @@ -[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) donationAmount +[TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) donationAmount -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationCurrency.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationCurrency.md index aacae7fd41c..7685160486a 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationCurrency.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationCurrency.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) donationCurrency +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) donationCurrency -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationCurrencySymbol.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationCurrencySymbol.md index bd1213350e3..d4c34149f5c 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationCurrencySymbol.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationCurrencySymbol.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) donationCurrencySymbol +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) donationCurrencySymbol -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationField.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationField.md index a8002fbd95d..a8c5db6f4b6 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationField.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationField.md @@ -9,9 +9,9 @@ -[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) donationField +[FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) donationField -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/iconButton.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/iconButton.md index 3c4daade75c..3f906fb17b0 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/iconButton.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/iconButton.md @@ -10,38 +10,38 @@ -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) iconButton -([Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) icon, [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) onTap) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) iconButton +([Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) icon, [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) onTap) -

This widget returns the button for social media sharing option.

-

params:

-
    -
  • icon : This is Widget type with icon details.
  • -
  • onTap : This is Function, which invoke on tap.
  • -
+\This widget returns the button for social media sharing option.\ +\params:\ +\ +\\icon\ : This is \Widget\ type with icon details.\ +\\onTap\ : This is \Function\, which invoke on tap.\ +\ ## Implementation ```dart -Widget iconButton(Widget icon, Function onTap) { +Widget iconButton(Widget icon, Function onTap) \{ return Stack( children: [ IconButton( - onPressed: () { + onPressed: () \{ print('tapped'); onTap(); - }, + \}, icon: icon, ), ], ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/initialize.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/initialize.md index 831375087c7..d1b162163ca 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/initialize.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/initialize.md @@ -23,12 +23,12 @@ void initialize ## Implementation ```dart -void initialize() { +void initialize() \{ setState(ViewState.busy); currentOrg = _userConfig.currentOrg; currentUser = _userConfig.currentUser; setState(ViewState.idle); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/invite.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/invite.md index 3126aa8f9c6..94c5d3930e8 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/invite.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/invite.md @@ -11,28 +11,28 @@ void invite -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -

This function generates the organization invitation link in a Dialog Box. -Dialog box contains the QR-code of organization invite link and social media sharing options.

+\This function generates the organization invitation link in a Dialog Box. +Dialog box contains the QR-code of organization invite link and social media sharing options.\ ## Implementation ```dart -void invite(BuildContext context) { +void invite(BuildContext context) \{ _appLanguageService.initialize(); - // organization url + organization url final String url = - 'https://cyberwake.github.io/applink/invite?selectLang=${_appLanguageService.appLocal.languageCode}&setUrl=${GraphqlConfig.orgURI}&selectOrg=${userConfig.currentOrg.id!}'; - // QR + 'https:cyberwake.github.io/applink/invite?selectLang=$\{_appLanguageService.appLocal.languageCode\}&setUrl=$\{GraphqlConfig.orgURI\}&selectOrg=$\{userConfig.currentOrg.id!\}'; + QR final String qrData = - '${GraphqlConfig.orgURI}?orgid=${userConfig.currentOrg.id!}'; + '$\{GraphqlConfig.orgURI\}?orgid=$\{userConfig.currentOrg.id!\}'; print(url); print(qrData); showModalBottomSheet( @@ -43,7 +43,7 @@ void invite(BuildContext context) { topRight: Radius.circular(30), ), ), - builder: (BuildContext context) { + builder: (BuildContext context) \{ return ClipRRect( borderRadius: const BorderRadius.only( topLeft: Radius.circular(30), @@ -69,7 +69,7 @@ void invite(BuildContext context) { height: SizeConfig.screenHeight! * 0.08, ), Text( - 'Scan the QR to join ${userConfig.currentOrg.name}', + 'Scan the QR to join $\{userConfig.currentOrg.name\}', style: const TextStyle(color: Colors.black), ), SizedBox( @@ -85,27 +85,27 @@ void invite(BuildContext context) { size: 35, color: Color(0xFF1DA1F2), ), - () async => SocialShare.shareTwitter('Join us', url: url), + () async =\> SocialShare.shareTwitter('Join us', url: url), ), iconButton( CustomPaint( size: const Size( 50, 50 * 1.004, - ), //You can Replace [WIDTH] with your desired width for Custom Paint and height will be calculated automatically + ), You can Replace [WIDTH] with your desired width for Custom Paint and height will be calculated automatically painter: WhatsappLogo(), ), - () async => SocialShare.shareWhatsapp(url), + () async =\> SocialShare.shareWhatsapp(url), ), iconButton( CustomPaint( size: Size( 45, (45 * 1).toDouble(), - ), //You can Replace [WIDTH] with your desired width for Custom Paint and height will be calculated automatically + ), You can Replace [WIDTH] with your desired width for Custom Paint and height will be calculated automatically painter: TelegramLogo(), ), - () async => SocialShare.shareTelegram(url), + () async =\> SocialShare.shareTelegram(url), ), iconButton( const FaIcon( @@ -113,7 +113,7 @@ void invite(BuildContext context) { size: 30, color: Color(0xff40c351), ), - () async => SocialShare.shareOptions(url), + () async =\> SocialShare.shareOptions(url), ), ], ) @@ -121,9 +121,9 @@ void invite(BuildContext context) { ), ), ); - }, + \}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/logout.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/logout.md index 32f820dbc28..d4d757a138d 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/logout.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/logout.md @@ -10,56 +10,56 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> logout -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> logout +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -

This method destroys the user's session or sign out the user from app. -The function asks for the confimation in Custom Alert Dialog.

+\This method destroys the user's session or sign out the user from app. +The function asks for the confimation in Custom Alert Dialog.\ ## Implementation ```dart -Future logout(BuildContext context) async { - // push custom alert dialog with the confirmation message. +Future\ logout(BuildContext context) async \{ + push custom alert dialog with the confirmation message. navigationService.pushDialog( CustomAlertDialog( reverse: true, dialogSubTitle: 'Are you sure you want to logout?', successText: 'Logout', - success: () async { - try { + success: () async \{ + try \{ final result = await databaseFunctions .gqlAuthMutation(queries.logout()) as QueryResult?; - if (result != null && result.data!['logout'] == true) { + if (result != null && result.data!['logout'] == true) \{ navigationService.pop(); navigationService.pushDialog( const CustomProgressDialog( key: Key('LogoutProgress'), ), ); - Future.delayed(const Duration(seconds: 1)).then((value) { - user = Hive.box('currentUser'); + Future.delayed(const Duration(seconds: 1)).then((value) \{ + user = Hive.box\('currentUser'); url = Hive.box('url'); final androidFirebaseOptionsBox = Hive.box('androidFirebaseOptions'); final iosFirebaseOptionsBox = Hive.box('iosFirebaseOptions'); - organisation = Hive.box('currentOrg'); + organisation = Hive.box\('currentOrg'); user.clear(); url.clear(); androidFirebaseOptionsBox.clear(); iosFirebaseOptionsBox.clear(); - try { + try \{ Firebase.app() - .delete(); // Deleting app will stop all Firebase plugins - } catch (e) { + .delete(); Deleting app will stop all Firebase plugins + \} catch (e) \{ debugPrint("ERROR: Unable to delete firebase app $e"); - } + \} organisation.clear(); navigationService.pop(); navigationService.removeAllAndPush( @@ -67,15 +67,15 @@ Future logout(BuildContext context) async { '/', arguments: '0', ); - }); - } - } catch (e) { + \}); + \} + \} catch (e) \{ print(e); - } - }, + \} + \}, ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/organisation.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/organisation.md index 3d34e04e3e9..8ffa04bf859 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/organisation.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/organisation.md @@ -9,9 +9,9 @@ -[Box](https://pub.dev/documentation/hive/2.2.3/hive/Box-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)> organisation +[Box](https:pub.dev/documentation/hive/2.2.3/hive/Box-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)\> organisation -_latefinal_ +_\late\\final\_ @@ -21,7 +21,7 @@ _latefinal_ ## Implementation ```dart -late final Box organisation; +late final Box\ organisation; ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/popBottomSheet.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/popBottomSheet.md index 13718f6ff40..9053b1752d2 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/popBottomSheet.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/popBottomSheet.md @@ -23,9 +23,9 @@ void popBottomSheet ## Implementation ```dart -void popBottomSheet() { +void popBottomSheet() \{ _navigationService.pop(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/scaffoldKey.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/scaffoldKey.md index 2ecabe5005d..c5d5e052aed 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/scaffoldKey.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/scaffoldKey.md @@ -9,9 +9,9 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[ScaffoldState](https://api.flutter.dev/flutter/material/ScaffoldState-class.html)> scaffoldKey +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[ScaffoldState](https:api.flutter.dev/flutter/material/ScaffoldState-class.html)\> scaffoldKey -_final_ +_\final\_ @@ -21,7 +21,7 @@ _final_ ## Implementation ```dart -final GlobalKey scaffoldKey = GlobalKey(); +final GlobalKey\ scaffoldKey = GlobalKey\(); ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/showSnackBar.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/showSnackBar.md index aabf7b6b9d3..0809fa3ad62 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/showSnackBar.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/showSnackBar.md @@ -11,7 +11,7 @@ void showSnackBar -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) message) +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) message) @@ -23,9 +23,9 @@ void showSnackBar ## Implementation ```dart -void showSnackBar(String message) { +void showSnackBar(String message) \{ _navigationService.showTalawaErrorDialog(message, MessageType.error); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/updateSheetHeight.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/updateSheetHeight.md index e79f361a216..e5589701ab6 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/updateSheetHeight.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/updateSheetHeight.md @@ -23,10 +23,10 @@ void updateSheetHeight ## Implementation ```dart -void updateSheetHeight() { +void updateSheetHeight() \{ bottomSheetHeight = SizeConfig.screenHeight! * 0.65; notifyListeners(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/url.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/url.md index 0c2f3bed731..040d1d44802 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/url.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/url.md @@ -9,9 +9,9 @@ -[Box](https://pub.dev/documentation/hive/2.2.3/hive/Box-class.html) url +[Box](https:pub.dev/documentation/hive/2.2.3/hive/Box-class.html) url -_latefinal_ +_\late\\final\_ @@ -21,7 +21,7 @@ _latefinal_ ## Implementation ```dart -late final Box url; +late final Box\ url; ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/user.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/user.md index 441993dc65d..85cc876e267 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/user.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/user.md @@ -9,9 +9,9 @@ -[Box](https://pub.dev/documentation/hive/2.2.3/hive/Box-class.html)<[User](../../models_user_user_info/User-class.md)> user +[Box](https:pub.dev/documentation/hive/2.2.3/hive/Box-class.html)<[User](../../models_user_user_info/User-class.md)\> user -_latefinal_ +_\late\\final\_ @@ -21,7 +21,7 @@ _latefinal_ ## Implementation ```dart -late final Box user; +late final Box\ user; ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel-class.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel-class.md index 4050b66dffc..034ae6884c8 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel-class.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel-class.md @@ -11,21 +11,21 @@ -

CreateTaskViewModel class helps to interact with model to serve data -and react to user's input in Create Task view.

-

Methods include:

-
    -
  • fillTask
  • -
  • `editTask
  • -
  • createTask
  • -
+\CreateTaskViewModel class helps to interact with model to serve data +and react to user's input in Create Task view.\ +\Methods include:\ +\ +\\fillTask\\ +\`editTask\ +\\createTask\\ +\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) - [BaseModel](../view_model_base_view_model/BaseModel-class.md) - CreateTaskViewModel @@ -45,39 +45,39 @@ and react to user's input in Create Task view.

## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hasListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hasListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether any listeners are currently registered. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -86,43 +86,43 @@ _read-onlyinherited_ -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [taskDescriptionTextController](../view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskDescriptionTextController.md) → [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) +##### [taskDescriptionTextController](../view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskDescriptionTextController.md) → [TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) -_final_ +_\final\_ -##### [taskEndDate](../view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskEndDate.md) ↔ [DateTime](https://api.flutter.dev/flutter/dart-core/DateTime-class.html) +##### [taskEndDate](../view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskEndDate.md) ↔ [DateTime](https:api.flutter.dev/flutter/dart-core/DateTime-class.html) -_read / write_ +_\read / write\_ -##### [taskEndTime](../view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskEndTime.md) ↔ [TimeOfDay](https://api.flutter.dev/flutter/material/TimeOfDay-class.html) +##### [taskEndTime](../view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskEndTime.md) ↔ [TimeOfDay](https:api.flutter.dev/flutter/material/TimeOfDay-class.html) -_read / write_ +_\read / write\_ -##### [taskTitleTextController](../view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskTitleTextController.md) → [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) +##### [taskTitleTextController](../view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskTitleTextController.md) → [TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) -_final_ +_\final\_ @@ -130,21 +130,21 @@ _final_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be called when the object changes. -_inherited_ +_\inherited\_ -##### [createTask](../view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/createTask.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)> +##### [createTask](../view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/createTask.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)\> This function creates a new task for an event. -The function uses createTask method provided by Task Services. +The function uses \createTask\ method provided by Task Services. @@ -155,17 +155,17 @@ The function uses createTask method provided by Task Services. Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -
addListener will throw after the object is disposed). -_override_ +\addListener\ will throw after the object is disposed). +_\override\_ -##### [editTask](../view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/editTask.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) taskId) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)> +##### [editTask](../view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/editTask.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) taskId) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)\> This function updates the task. -The function uses editTask method provided by Task Services. +The function uses \editTask\ method provided by Task Services. @@ -179,31 +179,31 @@ This functions fills the task controller data. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void +##### [notifyListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void Call all the registered listeners. -_inherited_ +_\inherited\_ -##### [removeListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that are notified when the object changes. -_inherited_ +_\inherited\_ @@ -212,16 +212,16 @@ _inherited_ -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -229,12 +229,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/createTask.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/createTask.md index 5bcc17868a3..1a75ce749c2 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/createTask.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/createTask.md @@ -10,26 +10,26 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)> createTask -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)\> createTask +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId) -

This function creates a new task for an event. -The function uses createTask method provided by Task Services.

-

params:

-
    -
  • eventId : id of the event for which task need to be add.
  • -
+\This function creates a new task for an event. +The function uses \createTask\ method provided by Task Services.\ +\params:\ +\ +\\eventId\ : id of the event for which task need to be add.\ +\ ## Implementation ```dart -Future createTask(String eventId) async { +Future\ createTask(String eventId) async \{ final deadline = DateTime( taskEndDate.year, taskEndDate.month, @@ -43,7 +43,7 @@ Future createTask(String eventId) async { deadline: deadline.microsecondsSinceEpoch.toString(), eventId: eventId, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/dispose.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/dispose.md index 22041803378..766bf427332 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/dispose.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/dispose.md @@ -9,22 +9,22 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) void dispose () -_override_ +_\override\_ -

Discards any resources used by the object. After this is called, the +\Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -addListener will throw after the object is disposed).

-

This method should only be called by the object's owner.

-

This method does not notify listeners, and clears the listener list once +\addListener\ will throw after the object is disposed).\ +\This method should only be called by the object's owner.\ +\This method does not notify listeners, and clears the listener list once it is called. Consumers of this class must decide on whether to notify -listeners or not immediately before disposal.

+listeners or not immediately before disposal.\ @@ -32,11 +32,11 @@ listeners or not immediately before disposal.

```dart @override -void dispose() { +void dispose() \{ taskTitleTextController.dispose(); taskDescriptionTextController.dispose(); super.dispose(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/editTask.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/editTask.md index bb4079d46d3..d12c49ab2db 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/editTask.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/editTask.md @@ -10,26 +10,26 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)> editTask -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) taskId) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)\> editTask +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) taskId) -

This function updates the task. -The function uses editTask method provided by Task Services.

-

params:

-
    -
  • taskId : id of the task that needs to be updated.
  • -
+\This function updates the task. +The function uses \editTask\ method provided by Task Services.\ +\params:\ +\ +\\taskId\ : id of the task that needs to be updated.\ +\ ## Implementation ```dart -Future editTask(String taskId) async { +Future\ editTask(String taskId) async \{ final deadline = DateTime( taskEndDate.year, taskEndDate.month, @@ -43,7 +43,7 @@ Future editTask(String taskId) async { deadline: deadline.microsecondsSinceEpoch.toString(), taskId: taskId, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/fillTask.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/fillTask.md index 5bea4157aa3..581ba4b706b 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/fillTask.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/fillTask.md @@ -17,26 +17,26 @@ void fillTask -

This functions fills the task controller data.

-

params:

-
    -
  • task : Task type contain task data.
  • -
+\This functions fills the task controller data.\ +\params:\ +\ +\\task\ : \Task\ type contain task data.\ +\ ## Implementation ```dart -void fillTask(Task task) { +void fillTask(Task task) \{ taskTitleTextController.text = task.title; taskDescriptionTextController.text = task.description ?? ''; - if (task.deadline != null) { + if (task.deadline != null) \{ taskEndDate = DateTime.fromMicrosecondsSinceEpoch(int.parse(task.deadline!)); taskEndTime = TimeOfDay.fromDateTime(taskEndDate); - } -} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskDescriptionTextController.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskDescriptionTextController.md index 7f032da666b..f1b5f40c16e 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskDescriptionTextController.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskDescriptionTextController.md @@ -9,9 +9,9 @@ -[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) taskDescriptionTextController +[TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) taskDescriptionTextController -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskEndDate.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskEndDate.md index 696d43408e9..e82d34de468 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskEndDate.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskEndDate.md @@ -9,9 +9,9 @@ -[DateTime](https://api.flutter.dev/flutter/dart-core/DateTime-class.html) taskEndDate +[DateTime](https:api.flutter.dev/flutter/dart-core/DateTime-class.html) taskEndDate -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskEndTime.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskEndTime.md index 3e1250440ee..faacb2e2ce3 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskEndTime.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskEndTime.md @@ -9,9 +9,9 @@ -[TimeOfDay](https://api.flutter.dev/flutter/material/TimeOfDay-class.html) taskEndTime +[TimeOfDay](https:api.flutter.dev/flutter/material/TimeOfDay-class.html) taskEndTime -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskTitleTextController.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskTitleTextController.md index 9936df3991d..4f3f7ec5a81 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskTitleTextController.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskTitleTextController.md @@ -9,9 +9,9 @@ -[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) taskTitleTextController +[TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) taskTitleTextController -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel-class.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel-class.md index 688e124ea5e..2e74c81cb09 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel-class.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel-class.md @@ -11,21 +11,21 @@ -

ExploreTasksViewModel class helps to interact with model to serve data -and react to user's input in Explore Task section.

-

Methods include:

-
    -
  • fetchTasks
  • -
  • `fetchTasksByUser
  • -
  • deleteTask
  • -
+\ExploreTasksViewModel class helps to interact with model to serve data +and react to user's input in Explore Task section.\ +\Methods include:\ +\ +\\fetchTasks\\ +\`fetchTasksByUser\ +\\deleteTask\\ +\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) - [BaseModel](../view_model_base_view_model/BaseModel-class.md) - ExploreTasksViewModel @@ -45,39 +45,39 @@ and react to user's input in Explore Task section.

## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hasListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hasListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether any listeners are currently registered. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -86,16 +86,16 @@ _read-onlyinherited_ -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [tasks](../view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/tasks.md) → [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Task](../models_task_task_model/Task-class.md)> +##### [tasks](../view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/tasks.md) → [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Task](../models_task_task_model/Task-class.md)\> -_read-only_ +_\read-only\_ @@ -103,81 +103,81 @@ _read-only_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be called when the object changes. -_inherited_ +_\inherited\_ -##### [deleteTask](../view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/deleteTask.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) taskId, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) creatorId) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [deleteTask](../view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/deleteTask.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) taskId, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) creatorId) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> This function deletes the task for an event. -The function uses deleteTask method of Task Service. +The function uses \deleteTask\ method of Task Service. -##### [dispose](https://api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void +##### [dispose](https:api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -
addListener will throw after the object is disposed). -_inherited_ +\addListener\ will throw after the object is disposed). +_\inherited\_ -##### [fetchTasks](../view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/fetchTasks.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [fetchTasks](../view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/fetchTasks.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> This function fetch all the task for an event. -The function uses getTasksForEvent method of Task Service. +The function uses \getTasksForEvent\ method of Task Service. -##### [fetchTasksByUser](../view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/fetchTasksByUser.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [fetchTasksByUser](../view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/fetchTasksByUser.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> This function fetch tasks created by the current user for an event. -The function uses getTasksByUser method of Task Service. +The function uses \getTasksByUser\ method of Task Service. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void +##### [notifyListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void Call all the registered listeners. -_inherited_ +_\inherited\_ -##### [removeListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that are notified when the object changes. -_inherited_ +_\inherited\_ @@ -186,16 +186,16 @@ _inherited_ -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -203,12 +203,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/ExploreTasksViewModel.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/ExploreTasksViewModel.md index 3d09387b0f6..fc8633ea1eb 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/ExploreTasksViewModel.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/ExploreTasksViewModel.md @@ -18,9 +18,9 @@ ExploreTasksViewModel() ## Implementation ```dart -ExploreTasksViewModel() { - _taskService.callbackNotifyListeners = () => notifyListeners(); -} +ExploreTasksViewModel() \{ + _taskService.callbackNotifyListeners = () =\> notifyListeners(); +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/deleteTask.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/deleteTask.md index 45d4afc881e..809a7b42e96 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/deleteTask.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/deleteTask.md @@ -10,30 +10,30 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> deleteTask -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) taskId, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) creatorId) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> deleteTask +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) taskId, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) creatorId) -

This function deletes the task for an event. -The function uses deleteTask method of Task Service.

-

params:

-
    -
  • taskId : id of the task need to be deleted.
  • -
  • creatorId : id of the task creator.
  • -
+\This function deletes the task for an event. +The function uses \deleteTask\ method of Task Service.\ +\params:\ +\ +\\taskId\ : id of the task need to be deleted.\ +\\creatorId\ : id of the task creator.\ +\ ## Implementation ```dart -Future deleteTask(String taskId, String creatorId) async { +Future\ deleteTask(String taskId, String creatorId) async \{ await _taskService.deleteTask(taskId, creatorId); notifyListeners(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/fetchTasks.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/fetchTasks.md index fc7f652680e..a608bb433b9 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/fetchTasks.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/fetchTasks.md @@ -10,30 +10,30 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> fetchTasks -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> fetchTasks +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId) -

This function fetch all the task for an event. -The function uses getTasksForEvent method of Task Service.

-

params:

-
    -
  • eventId : id of an event for which tasks need to be fetched.
  • -
+\This function fetch all the task for an event. +The function uses \getTasksForEvent\ method of Task Service.\ +\params:\ +\ +\\eventId\ : id of an event for which tasks need to be fetched.\ +\ ## Implementation ```dart -Future fetchTasks(String eventId) async { +Future\ fetchTasks(String eventId) async \{ setState(ViewState.busy); await _taskService.getTasksForEvent(eventId); setState(ViewState.idle); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/fetchTasksByUser.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/fetchTasksByUser.md index 968e5f37421..294ff013f3e 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/fetchTasksByUser.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/fetchTasksByUser.md @@ -10,26 +10,26 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> fetchTasksByUser +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> fetchTasksByUser () -

This function fetch tasks created by the current user for an event. -The function uses getTasksByUser method of Task Service.

+\This function fetch tasks created by the current user for an event. +The function uses \getTasksByUser\ method of Task Service.\ ## Implementation ```dart -Future fetchTasksByUser() async { +Future\ fetchTasksByUser() async \{ setState(ViewState.busy); await _taskService.getTasksByUser(); setState(ViewState.idle); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/tasks.md b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/tasks.md index a04396c2917..b7d9b57ff43 100644 --- a/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/tasks.md +++ b/docs/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/tasks.md @@ -11,7 +11,7 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Task](../../models_task_task_model/Task-class.md)> tasks +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Task](../../models_task_task_model/Task-class.md)\> tasks @@ -23,7 +23,7 @@ ## Implementation ```dart -List get tasks => _taskService.tasks; +List\ get tasks =\> _taskService.tasks; ``` diff --git a/docs/talawa-mobile-docs/view_model_base_view_model/BaseModel-class.md b/docs/talawa-mobile-docs/view_model_base_view_model/BaseModel-class.md index 873cf71cf67..fa8f117fd7b 100644 --- a/docs/talawa-mobile-docs/view_model_base_view_model/BaseModel-class.md +++ b/docs/talawa-mobile-docs/view_model_base_view_model/BaseModel-class.md @@ -16,8 +16,8 @@ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) - BaseModel @@ -64,39 +64,39 @@ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hasListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hasListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether any listeners are currently registered. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-only_ +_\read-only\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -105,7 +105,7 @@ _read-onlyinherited_ -_read-only_ +_\read-only\_ @@ -113,51 +113,51 @@ _read-only_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be called when the object changes. -_inherited_ +_\inherited\_ -##### [dispose](https://api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void +##### [dispose](https:api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -
addListener will throw after the object is disposed). -_inherited_ +\addListener\ will throw after the object is disposed). +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void +##### [notifyListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void Call all the registered listeners. -_inherited_ +_\inherited\_ -##### [removeListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that are notified when the object changes. -_inherited_ +_\inherited\_ @@ -170,12 +170,12 @@ _inherited_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -183,12 +183,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/view_model_base_view_model/BaseModel/isBusy.md b/docs/talawa-mobile-docs/view_model_base_view_model/BaseModel/isBusy.md index e7de222ca2c..8ac0fd424bc 100644 --- a/docs/talawa-mobile-docs/view_model_base_view_model/BaseModel/isBusy.md +++ b/docs/talawa-mobile-docs/view_model_base_view_model/BaseModel/isBusy.md @@ -11,7 +11,7 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isBusy +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isBusy @@ -23,7 +23,7 @@ ## Implementation ```dart -bool get isBusy => _state == ViewState.busy; +bool get isBusy =\> _state == ViewState.busy; ``` diff --git a/docs/talawa-mobile-docs/view_model_base_view_model/BaseModel/setState.md b/docs/talawa-mobile-docs/view_model_base_view_model/BaseModel/setState.md index a225602b83c..cec8476f884 100644 --- a/docs/talawa-mobile-docs/view_model_base_view_model/BaseModel/setState.md +++ b/docs/talawa-mobile-docs/view_model_base_view_model/BaseModel/setState.md @@ -23,10 +23,10 @@ void setState ## Implementation ```dart -void setState(ViewState viewState) { +void setState(ViewState viewState) \{ _state = viewState; notifyListeners(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_base_view_model/BaseModel/state.md b/docs/talawa-mobile-docs/view_model_base_view_model/BaseModel/state.md index 1c802c49d1e..377527a6034 100644 --- a/docs/talawa-mobile-docs/view_model_base_view_model/BaseModel/state.md +++ b/docs/talawa-mobile-docs/view_model_base_view_model/BaseModel/state.md @@ -23,7 +23,7 @@ ## Implementation ```dart -ViewState get state => _state; +ViewState get state =\> _state; ``` diff --git a/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage-class.md b/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage-class.md index 2927d291db5..5835d2e3c3d 100644 --- a/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage-class.md +++ b/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage-class.md @@ -11,24 +11,24 @@ -

AppLanguage view model class interact with modal in the context of the App Language. -The class provides methods that set's the language, change the language in the modal.

-

Methods include:

-
    -
  • fetchLocale
  • -
  • changeLanguage
  • -
  • selectLanguagePress
  • -
  • dbLanguageUpdate
  • -
  • appLanguageQuery
  • -
  • userLanguageQuery
  • -
+\AppLanguage view model class interact with modal in the context of the App Language. +The class provides methods that set's the language, change the language in the modal.\ +\Methods include:\ +\ +\\fetchLocale\\ +\\changeLanguage\\ +\\selectLanguagePress\\ +\\dbLanguageUpdate\\ +\\appLanguageQuery\\ +\\userLanguageQuery\\ +\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) - [BaseModel](../view_model_base_view_model/BaseModel-class.md) - AppLanguage @@ -41,19 +41,19 @@ The class provides methods that set's the language, change the language in the m ## Constructors -[AppLanguage](../view_model_lang_view_model/AppLanguage/AppLanguage.md) ({[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isTest = false}) +[AppLanguage](../view_model_lang_view_model/AppLanguage/AppLanguage.md) (\{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isTest = false\}) ## Properties -##### [appLocal](../view_model_lang_view_model/AppLanguage/appLocal.md) → [Locale](https://api.flutter.dev/flutter/dart-ui/Locale-class.html) +##### [appLocal](../view_model_lang_view_model/AppLanguage/appLocal.md) → [Locale](https:api.flutter.dev/flutter/dart-ui/Locale-class.html) -_read-only_ +_\read-only\_ @@ -62,43 +62,43 @@ _read-only_ -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hasListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hasListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether any listeners are currently registered. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isTest](../view_model_lang_view_model/AppLanguage/isTest.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isTest](../view_model_lang_view_model/AppLanguage/isTest.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_final_ +_\final\_ @@ -107,16 +107,16 @@ _final_ -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -125,7 +125,7 @@ _read-onlyinherited_ -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -133,26 +133,26 @@ _read-onlyinherited_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be called when the object changes. -_inherited_ +_\inherited\_ -##### [appLanguageQuery](../view_model_lang_view_model/AppLanguage/appLanguageQuery.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [appLanguageQuery](../view_model_lang_view_model/AppLanguage/appLanguageQuery.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> This function perform graphQL query to check the app language. -The function uses gqlAuthQuery method provided by Database Functions Services. +The function uses \gqlAuthQuery\ method provided by Database Functions Services. -##### [changeLanguage](../view_model_lang_view_model/AppLanguage/changeLanguage.md)([Locale](https://api.flutter.dev/flutter/dart-ui/Locale-class.html) type) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [changeLanguage](../view_model_lang_view_model/AppLanguage/changeLanguage.md)([Locale](https:api.flutter.dev/flutter/dart-ui/Locale-class.html) type) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -161,27 +161,27 @@ This function change the app default language. -##### [dbLanguageUpdate](../view_model_lang_view_model/AppLanguage/dbLanguageUpdate.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [dbLanguageUpdate](../view_model_lang_view_model/AppLanguage/dbLanguageUpdate.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> -This function updates the Database Language by running the graphQL mutations. +This function updates the Database Language by running the graphQL \mutations\. -##### [dispose](https://api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void +##### [dispose](https:api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -
addListener will throw after the object is disposed). -_inherited_ +\addListener\ will throw after the object is disposed). +_\inherited\_ -##### [fetchLocale](../view_model_lang_view_model/AppLanguage/fetchLocale.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [fetchLocale](../view_model_lang_view_model/AppLanguage/fetchLocale.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -190,7 +190,7 @@ This function fetch the language of the user's app. -##### [initialize](../view_model_lang_view_model/AppLanguage/initialize.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [initialize](../view_model_lang_view_model/AppLanguage/initialize.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -199,40 +199,40 @@ This function fetch the language of the user's app. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void +##### [notifyListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void Call all the registered listeners. -_inherited_ +_\inherited\_ -##### [removeListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that are notified when the object changes. -_inherited_ +_\inherited\_ -##### [selectLanguagePress](../view_model_lang_view_model/AppLanguage/selectLanguagePress.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [selectLanguagePress](../view_model_lang_view_model/AppLanguage/selectLanguagePress.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> -This function navigate user to /appSettingsPage route if the user is authenticated -else navigate to /setUrl route. +This function navigate user to \/appSettingsPage\ route if the user is authenticated +else navigate to \/setUrl\ route. @@ -242,25 +242,25 @@ else navigate to /setUrl route. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [userLanguageQuery](../view_model_lang_view_model/AppLanguage/userLanguageQuery.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) userId) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [userLanguageQuery](../view_model_lang_view_model/AppLanguage/userLanguageQuery.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) userId) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> This function perform graphQL query to check the user's language in the database. -The function uses gqlAuthQuery method provided by Database Functions Services. +The function uses \gqlAuthQuery\ method provided by Database Functions Services. @@ -269,12 +269,12 @@ The function uses gqlAuthQuery method provided by Database Function ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/AppLanguage.md b/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/AppLanguage.md index 893a5b3d798..4269407df84 100644 --- a/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/AppLanguage.md +++ b/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/AppLanguage.md @@ -9,7 +9,7 @@ -AppLanguage({[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isTest = false}) +AppLanguage(\{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isTest = false\}) @@ -18,7 +18,7 @@ AppLanguage({[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) i ## Implementation ```dart -AppLanguage({this.isTest = false}); +AppLanguage(\{this.isTest = false\}); ``` diff --git a/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/appLanguageQuery.md b/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/appLanguageQuery.md index 5720f3225ea..0c80109b584 100644 --- a/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/appLanguageQuery.md +++ b/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/appLanguageQuery.md @@ -10,28 +10,28 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> appLanguageQuery +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> appLanguageQuery () -

This function perform graphQL query to check the app language. -The function uses gqlAuthQuery method provided by Database Functions Services.

+\This function perform graphQL query to check the app language. +The function uses \gqlAuthQuery\ method provided by Database Functions Services.\ ## Implementation ```dart -Future appLanguageQuery() async { - try { +Future\ appLanguageQuery() async \{ + try \{ await databaseFunctions.gqlAuthQuery(queries.userLanguage()); - } catch (e) { + \} catch (e) \{ print(e); - } -} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/appLocal.md b/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/appLocal.md index 6dfb7e02252..18db33ef7da 100644 --- a/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/appLocal.md +++ b/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/appLocal.md @@ -11,7 +11,7 @@ -[Locale](https://api.flutter.dev/flutter/dart-ui/Locale-class.html) appLocal +[Locale](https:api.flutter.dev/flutter/dart-ui/Locale-class.html) appLocal @@ -23,7 +23,7 @@ ## Implementation ```dart -Locale get appLocal => _appLocale; +Locale get appLocal =\> _appLocale; ``` diff --git a/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/changeLanguage.md b/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/changeLanguage.md index 623634d016f..f7c854850e8 100644 --- a/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/changeLanguage.md +++ b/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/changeLanguage.md @@ -10,80 +10,80 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> changeLanguage -([Locale](https://api.flutter.dev/flutter/dart-ui/Locale-class.html) type) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> changeLanguage +([Locale](https:api.flutter.dev/flutter/dart-ui/Locale-class.html) type) -

This function change the app default language.

-

params:

-
    -
  • type : Locale type, the language need to be updated with.
  • -
+\This function change the app default language.\ +\params:\ +\ +\\type\ : \Locale\ type, the language need to be updated with.\ +\ ## Implementation ```dart -Future changeLanguage(Locale type) async { - // if the app language is of same [type]. - if (_appLocale == type) { +Future\ changeLanguage(Locale type) async \{ + if the app language is of same [type]. + if (_appLocale == type) \{ return; - } + \} - if (isTest) { + if (isTest) \{ _appLocale = type; - } else { + \} else \{ final prefs = await SharedPreferences.getInstance(); - if (type == const Locale("es")) { - //If selected language is spanish + if (type == const Locale("es")) \{ + If selected language is spanish _appLocale = const Locale("es"); await prefs.setString('language_code', 'es'); await prefs.setString('countryCode', 'ES'); - } else if (type == const Locale("fr")) { - //If selected language is french + \} else if (type == const Locale("fr")) \{ + If selected language is french _appLocale = const Locale("fr"); await prefs.setString('language_code', 'fr'); await prefs.setString('countryCode', 'FR'); - } else if (type == const Locale("hi")) { - //If selected language is hindi + \} else if (type == const Locale("hi")) \{ + If selected language is hindi _appLocale = const Locale("hi"); await prefs.setString('language_code', 'hi'); await prefs.setString('countryCode', 'IN'); - } else if (type == const Locale("zh")) { - //If selected language is Chinese + \} else if (type == const Locale("zh")) \{ + If selected language is Chinese _appLocale = const Locale("zh"); await prefs.setString('language_code', 'zh'); await prefs.setString('countryCode', 'CN'); - } else if (type == const Locale("de")) { - //If selected language is Chinese + \} else if (type == const Locale("de")) \{ + If selected language is Chinese _appLocale = const Locale("de"); await prefs.setString('language_code', 'de'); await prefs.setString('countryCode', 'GE'); - } else if (type == const Locale("ja")) { - //If selected language is Chinese + \} else if (type == const Locale("ja")) \{ + If selected language is Chinese _appLocale = const Locale("ja"); await prefs.setString('language_code', 'ja'); await prefs.setString('countryCode', 'JP'); - } else if (type == const Locale("pt")) { - //If selected language is Chinese + \} else if (type == const Locale("pt")) \{ + If selected language is Chinese _appLocale = const Locale("pt"); await prefs.setString('language_code', 'pt'); await prefs.setString('countryCode', 'PT'); - } else { - //If selected language is english + \} else \{ + If selected language is english _appLocale = const Locale("en"); await prefs.setString('language_code', 'en'); await prefs.setString('countryCode', 'US'); - } - } + \} + \} - /// notifying the consumers + notifying the consumers notifyListeners(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/databaseFunctions.md b/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/databaseFunctions.md index 3d86d3cd693..eb7a3362f2a 100644 --- a/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/databaseFunctions.md +++ b/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/databaseFunctions.md @@ -11,7 +11,7 @@ [DataBaseMutationFunctions](../../services_database_mutation_functions/DataBaseMutationFunctions-class.md) databaseFunctions -_final_ +_\final\_ @@ -21,7 +21,7 @@ _final_ ## Implementation ```dart -final databaseFunctions = locator(); +final databaseFunctions = locator\(); ``` diff --git a/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/dbLanguageUpdate.md b/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/dbLanguageUpdate.md index 82e5677ef47..3b84f817cf0 100644 --- a/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/dbLanguageUpdate.md +++ b/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/dbLanguageUpdate.md @@ -10,29 +10,29 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> dbLanguageUpdate +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> dbLanguageUpdate () -

This function updates the Database Language by running the graphQL mutations.

+\This function updates the Database Language by running the graphQL \mutations\.\ ## Implementation ```dart -Future dbLanguageUpdate() async { - try { +Future\ dbLanguageUpdate() async \{ + try \{ await databaseFunctions .gqlAuthMutation(queries.updateLanguage(_appLocale.languageCode)); print('Language Updated in Database'); - } catch (e) { + \} catch (e) \{ print(e); - } -} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/fetchLocale.md b/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/fetchLocale.md index 6958ea21375..d3c8b5b86c1 100644 --- a/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/fetchLocale.md +++ b/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/fetchLocale.md @@ -10,27 +10,27 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> fetchLocale +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> fetchLocale () -

This function fetch the language of the user's app.

+\This function fetch the language of the user's app.\ ## Implementation ```dart -Future fetchLocale() async { +Future\ fetchLocale() async \{ final prefs = await SharedPreferences.getInstance(); final String langCode = prefs.getString('language_code') ?? 'en'; _appLocale = Locale(langCode); notifyListeners(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/initialize.md b/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/initialize.md index 8892ae6b8f1..e23b04b8a33 100644 --- a/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/initialize.md +++ b/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/initialize.md @@ -10,7 +10,7 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> initialize +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> initialize () @@ -23,10 +23,10 @@ ## Implementation ```dart -Future initialize() async { +Future\ initialize() async \{ _appLocale = const Locale('en'); await fetchLocale(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/isTest.md b/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/isTest.md index e6e920cdab2..228df70eb7e 100644 --- a/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/isTest.md +++ b/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/isTest.md @@ -9,9 +9,9 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isTest +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isTest -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/navigationService.md b/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/navigationService.md index e7dcec48a74..3b50edb0dcf 100644 --- a/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/navigationService.md +++ b/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/navigationService.md @@ -11,7 +11,7 @@ [NavigationService](../../services_navigation_service/NavigationService-class.md) navigationService -_final_ +_\final\_ @@ -21,7 +21,7 @@ _final_ ## Implementation ```dart -final navigationService = locator(); +final navigationService = locator\(); ``` diff --git a/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/selectLanguagePress.md b/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/selectLanguagePress.md index 22b21ec3f0c..1023d076aee 100644 --- a/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/selectLanguagePress.md +++ b/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/selectLanguagePress.md @@ -10,30 +10,30 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> selectLanguagePress +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> selectLanguagePress () -

This function navigate user to /appSettingsPage route if the user is authenticated -else navigate to /setUrl route.

+\This function navigate user to \/appSettingsPage\ route if the user is authenticated +else navigate to \/setUrl\ route.\ ## Implementation ```dart -Future selectLanguagePress() async { +Future\ selectLanguagePress() async \{ final bool userLoggedIn = await userConfig.userLoggedIn(); - if (userLoggedIn) { + if (userLoggedIn) \{ dbLanguageUpdate(); navigationService.popAndPushScreen('/appSettingsPage', arguments: ''); - } else { + \} else \{ navigationService.pushScreen('/setUrl', arguments: ''); - } -} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/userLanguageQuery.md b/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/userLanguageQuery.md index 2a4c097b7d3..f495a5747da 100644 --- a/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/userLanguageQuery.md +++ b/docs/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/userLanguageQuery.md @@ -10,32 +10,32 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> userLanguageQuery -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) userId) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> userLanguageQuery +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) userId) -

This function perform graphQL query to check the user's language in the database. -The function uses gqlAuthQuery method provided by Database Functions Services.

-

params:

-
    -
  • userId : user for which language need to be fetch.
  • -
+\This function perform graphQL query to check the user's language in the database. +The function uses \gqlAuthQuery\ method provided by Database Functions Services.\ +\params:\ +\ +\\userId\ : user for which language need to be fetch.\ +\ ## Implementation ```dart -Future userLanguageQuery(String userId) async { - try { +Future\ userLanguageQuery(String userId) async \{ + try \{ await databaseFunctions.gqlAuthQuery(queries.newUserLanguage(userId)); - } catch (e) { + \} catch (e) \{ print(e); - } -} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel-class.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel-class.md index 6935ca705f4..30cda924a5b 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel-class.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel-class.md @@ -11,25 +11,25 @@ -

MainScreenViewModel class provide methods to interact with the modal to serve data in user's action in Main Screen Views.

-

The functions in this class are -mainly in the context of Tutorials for different componenets of the App.

-

Functions include:

-
    -
  • showTutorial
  • -
  • showHome
  • -
  • tourEventTargets
  • -
  • tourAddPost
  • -
  • tourChat
  • -
  • tourProfile
  • -
+\MainScreenViewModel class provide methods to interact with the modal to serve data in user's action in Main Screen Views.\ +\The functions in this class are +mainly in the context of Tutorials for different componenets of the App.\ +\Functions include:\ +\ +\\showTutorial\\ +\\showHome\\ +\\tourEventTargets\\ +\\tourAddPost\\ +\\tourChat\\ +\\tourProfile\\ +\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) - [BaseModel](../view_model_base_view_model/BaseModel-class.md) - MainScreenViewModel @@ -49,282 +49,282 @@ mainly in the context of Tutorials for different componenets of the App.

## Properties -##### [context](../view_model_main_screen_view_model/MainScreenViewModel/context.md) ↔ [BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) +##### [context](../view_model_main_screen_view_model/MainScreenViewModel/context.md) ↔ [BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context consist of parent info. -_read / write_ +_\read / write\_ -##### [currentPageIndex](../view_model_main_screen_view_model/MainScreenViewModel/currentPageIndex.md) ↔ [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [currentPageIndex](../view_model_main_screen_view_model/MainScreenViewModel/currentPageIndex.md) ↔ [int](https:api.flutter.dev/flutter/dart-core/int-class.html) var for current page in index. -_read / write_ +_\read / write\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hasListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hasListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether any listeners are currently registered. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [keyBNChat](../view_model_main_screen_view_model/MainScreenViewModel/keyBNChat.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> +##### [keyBNChat](../view_model_main_screen_view_model/MainScreenViewModel/keyBNChat.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> static variables. -_final_ +_\final\_ -##### [keyBNEvents](../view_model_main_screen_view_model/MainScreenViewModel/keyBNEvents.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> +##### [keyBNEvents](../view_model_main_screen_view_model/MainScreenViewModel/keyBNEvents.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> static variables. -_final_ +_\final\_ -##### [keyBNHome](../view_model_main_screen_view_model/MainScreenViewModel/keyBNHome.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> +##### [keyBNHome](../view_model_main_screen_view_model/MainScreenViewModel/keyBNHome.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> static variables. -_final_ +_\final\_ -##### [keyBNPost](../view_model_main_screen_view_model/MainScreenViewModel/keyBNPost.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> +##### [keyBNPost](../view_model_main_screen_view_model/MainScreenViewModel/keyBNPost.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> static variables. -_final_ +_\final\_ -##### [keyBNProfile](../view_model_main_screen_view_model/MainScreenViewModel/keyBNProfile.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> +##### [keyBNProfile](../view_model_main_screen_view_model/MainScreenViewModel/keyBNProfile.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> static variables. -_final_ +_\final\_ -##### [keySEAdd](../view_model_main_screen_view_model/MainScreenViewModel/keySEAdd.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> +##### [keySEAdd](../view_model_main_screen_view_model/MainScreenViewModel/keySEAdd.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> static variables. -_final_ +_\final\_ -##### [keySECard](../view_model_main_screen_view_model/MainScreenViewModel/keySECard.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> +##### [keySECard](../view_model_main_screen_view_model/MainScreenViewModel/keySECard.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> static variables. -_final_ +_\final\_ -##### [keySECategoryMenu](../view_model_main_screen_view_model/MainScreenViewModel/keySECategoryMenu.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> +##### [keySECategoryMenu](../view_model_main_screen_view_model/MainScreenViewModel/keySECategoryMenu.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> static variables. -_final_ +_\final\_ -##### [keySEDateFilter](../view_model_main_screen_view_model/MainScreenViewModel/keySEDateFilter.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> +##### [keySEDateFilter](../view_model_main_screen_view_model/MainScreenViewModel/keySEDateFilter.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> static variables. -_final_ +_\final\_ -##### [keySHMenuIcon](../view_model_main_screen_view_model/MainScreenViewModel/keySHMenuIcon.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> +##### [keySHMenuIcon](../view_model_main_screen_view_model/MainScreenViewModel/keySHMenuIcon.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> static variables. -_final_ +_\final\_ -##### [keySHOrgName](../view_model_main_screen_view_model/MainScreenViewModel/keySHOrgName.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> +##### [keySHOrgName](../view_model_main_screen_view_model/MainScreenViewModel/keySHOrgName.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> static variables. -_final_ +_\final\_ -##### [keySHPinnedPost](../view_model_main_screen_view_model/MainScreenViewModel/keySHPinnedPost.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> +##### [keySHPinnedPost](../view_model_main_screen_view_model/MainScreenViewModel/keySHPinnedPost.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> static variables. -_final_ +_\final\_ -##### [keySHPost](../view_model_main_screen_view_model/MainScreenViewModel/keySHPost.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> +##### [keySHPost](../view_model_main_screen_view_model/MainScreenViewModel/keySHPost.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> static variables. -_final_ +_\final\_ -##### [keySPAppSetting](../view_model_main_screen_view_model/MainScreenViewModel/keySPAppSetting.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> +##### [keySPAppSetting](../view_model_main_screen_view_model/MainScreenViewModel/keySPAppSetting.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> static variables. -_final_ +_\final\_ -##### [keySPDonateUs](../view_model_main_screen_view_model/MainScreenViewModel/keySPDonateUs.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> +##### [keySPDonateUs](../view_model_main_screen_view_model/MainScreenViewModel/keySPDonateUs.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> static variables. -_final_ +_\final\_ -##### [keySPEditProfile](../view_model_main_screen_view_model/MainScreenViewModel/keySPEditProfile.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> +##### [keySPEditProfile](../view_model_main_screen_view_model/MainScreenViewModel/keySPEditProfile.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> static variables. -_final_ +_\final\_ -##### [keySPHelp](../view_model_main_screen_view_model/MainScreenViewModel/keySPHelp.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> +##### [keySPHelp](../view_model_main_screen_view_model/MainScreenViewModel/keySPHelp.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> static variables. -_final_ +_\final\_ -##### [keySPInvite](../view_model_main_screen_view_model/MainScreenViewModel/keySPInvite.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> +##### [keySPInvite](../view_model_main_screen_view_model/MainScreenViewModel/keySPInvite.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> static variables. -_final_ +_\final\_ -##### [keySPLogout](../view_model_main_screen_view_model/MainScreenViewModel/keySPLogout.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> +##### [keySPLogout](../view_model_main_screen_view_model/MainScreenViewModel/keySPLogout.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> static variables. -_final_ +_\final\_ -##### [keySPPalisadoes](../view_model_main_screen_view_model/MainScreenViewModel/keySPPalisadoes.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> +##### [keySPPalisadoes](../view_model_main_screen_view_model/MainScreenViewModel/keySPPalisadoes.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> static variables. -_final_ +_\final\_ -##### [navBarItems](../view_model_main_screen_view_model/MainScreenViewModel/navBarItems.md) ↔ [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[BottomNavigationBarItem](https://api.flutter.dev/flutter/widgets/BottomNavigationBarItem-class.html)> +##### [navBarItems](../view_model_main_screen_view_model/MainScreenViewModel/navBarItems.md) ↔ [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[BottomNavigationBarItem](https:api.flutter.dev/flutter/widgets/BottomNavigationBarItem-class.html)\> -Actual BottomNavigationBarItems that show up on the screen. -_read / write_ +Actual \BottomNavigationBarItem\s that show up on the screen. +_\read / write\_ -##### [pages](../view_model_main_screen_view_model/MainScreenViewModel/pages.md) ↔ [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html)> +##### [pages](../view_model_main_screen_view_model/MainScreenViewModel/pages.md) ↔ [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html)\> Contains the Widgets to be rendered for corresponding navbar items. -_read / write_ +_\read / write\_ -##### [pluginList](../view_model_main_screen_view_model/MainScreenViewModel/pluginList.md) ↔ [List](https://api.flutter.dev/flutter/dart-core/List-class.html) +##### [pluginList](../view_model_main_screen_view_model/MainScreenViewModel/pluginList.md) ↔ [List](https:api.flutter.dev/flutter/dart-core/List-class.html) list of all the pluginList. -_read / write_ +_\read / write\_ -##### [pluginPrototypeData](../view_model_main_screen_view_model/MainScreenViewModel/pluginPrototypeData.md) ↔ [Map](https://api.flutter.dev/flutter/dart-core/Map-class.html) +##### [pluginPrototypeData](../view_model_main_screen_view_model/MainScreenViewModel/pluginPrototypeData.md) ↔ [Map](https:api.flutter.dev/flutter/dart-core/Map-class.html) Maps the feature names with their proper Icon and Page. -_read / write_ +_\read / write\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [showAppTour](../view_model_main_screen_view_model/MainScreenViewModel/showAppTour.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [showAppTour](../view_model_main_screen_view_model/MainScreenViewModel/showAppTour.md) ↔ [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) bool to determine if we wanna show the apptour. -_read / write_ +_\read / write\_ @@ -333,43 +333,43 @@ _read / write_ -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [targets](../view_model_main_screen_view_model/MainScreenViewModel/targets.md) → [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[TargetFocus](https://pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TargetFocus-class.html)> +##### [targets](../view_model_main_screen_view_model/MainScreenViewModel/targets.md) → [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[TargetFocus](https:pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TargetFocus-class.html)\> array of target. -_final_ +_\final\_ -##### [tourComplete](../view_model_main_screen_view_model/MainScreenViewModel/tourComplete.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [tourComplete](../view_model_main_screen_view_model/MainScreenViewModel/tourComplete.md) ↔ [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) bool to determine if apptour is complete. -_read / write_ +_\read / write\_ -##### [tourSkipped](../view_model_main_screen_view_model/MainScreenViewModel/tourSkipped.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [tourSkipped](../view_model_main_screen_view_model/MainScreenViewModel/tourSkipped.md) ↔ [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) bool to determine if apptour is skipped. -_read / write_ +_\read / write\_ -##### [tutorialCoachMark](../view_model_main_screen_view_model/MainScreenViewModel/tutorialCoachMark.md) ↔ [TutorialCoachMark](https://pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TutorialCoachMark-class.html) +##### [tutorialCoachMark](../view_model_main_screen_view_model/MainScreenViewModel/tutorialCoachMark.md) ↔ [TutorialCoachMark](https:pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TutorialCoachMark-class.html) tutorialCoachMark consist of coach used to give tutorial. -_read / write_ +_\read / write\_ @@ -377,36 +377,36 @@ _read / write_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be called when the object changes. -_inherited_ +_\inherited\_ -##### [dispose](https://api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void +##### [dispose](https:api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -
addListener will throw after the object is disposed). -_inherited_ +\addListener\ will throw after the object is disposed). +_\inherited\_ -##### [fetchAndAddPlugins](../view_model_main_screen_view_model/MainScreenViewModel/fetchAndAddPlugins.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) void +##### [fetchAndAddPlugins](../view_model_main_screen_view_model/MainScreenViewModel/fetchAndAddPlugins.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) void -Dynamically adds BottomNavigationBarItems in BottomNavigationBar. +Dynamically adds \BottomNavigationBarItems\ in \BottomNavigationBar\. -##### [focusTarget](../view_model_main_screen_view_model/MainScreenViewModel/focusTarget.md)([GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> key, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) keyName, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) description, {[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isCircle = false, [ContentAlign](https://pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/ContentAlign.html) align = ContentAlign.bottom, [CrossAxisAlignment](https://api.flutter.dev/flutter/rendering/CrossAxisAlignment.html) crossAlign = CrossAxisAlignment.start, [Alignment](https://api.flutter.dev/flutter/painting/Alignment-class.html) skipAlignment = Alignment.topRight, [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html)? next, [CrossAxisAlignment](https://api.flutter.dev/flutter/rendering/CrossAxisAlignment.html) nextCrossAlign = CrossAxisAlignment.end, [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isEnd = false}) [TargetFocus](https://pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TargetFocus-class.html) +##### [focusTarget](../view_model_main_screen_view_model/MainScreenViewModel/focusTarget.md)([GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> key, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) keyName, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) description, \{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isCircle = false, [ContentAlign](https:pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/ContentAlign.html) align = ContentAlign.bottom, [CrossAxisAlignment](https:api.flutter.dev/flutter/rendering/CrossAxisAlignment.html) crossAlign = CrossAxisAlignment.start, [Alignment](https:api.flutter.dev/flutter/painting/Alignment-class.html) skipAlignment = Alignment.topRight, [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html)? next, [CrossAxisAlignment](https:api.flutter.dev/flutter/rendering/CrossAxisAlignment.html) nextCrossAlign = CrossAxisAlignment.end, [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isEnd = false\}) [TargetFocus](https:pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TargetFocus-class.html) @@ -415,7 +415,7 @@ This returns a widget for a step in a tutorial. -##### [initialise](../view_model_main_screen_view_model/MainScreenViewModel/initialise.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) ctx, {required [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) fromSignUp, required [int](https://api.flutter.dev/flutter/dart-core/int-class.html) mainScreenIndex}) void +##### [initialise](../view_model_main_screen_view_model/MainScreenViewModel/initialise.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) ctx, \{required [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) fromSignUp, required [int](https:api.flutter.dev/flutter/dart-core/int-class.html) mainScreenIndex\}) void @@ -424,40 +424,40 @@ Initalizing function. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void +##### [notifyListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void Call all the registered listeners. -_inherited_ +_\inherited\_ -##### [onTabTapped](../view_model_main_screen_view_model/MainScreenViewModel/onTabTapped.md)([int](https://api.flutter.dev/flutter/dart-core/int-class.html) index) void +##### [onTabTapped](../view_model_main_screen_view_model/MainScreenViewModel/onTabTapped.md)([int](https:api.flutter.dev/flutter/dart-core/int-class.html) index) void -Handles click on BottomNavigationBarItem. +Handles click on \BottomNavigationBarItem\. -##### [removeListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that are notified when the object changes. -_inherited_ +_\inherited\_ @@ -466,11 +466,11 @@ _inherited_ -_inherited_ +_\inherited\_ -##### [showHome](../view_model_main_screen_view_model/MainScreenViewModel/showHome.md)([TargetFocus](https://pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TargetFocus-class.html) clickedTarget) void +##### [showHome](../view_model_main_screen_view_model/MainScreenViewModel/showHome.md)([TargetFocus](https:pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TargetFocus-class.html) clickedTarget) void @@ -479,7 +479,7 @@ This function shows the Home screen. -##### [showTutorial](../view_model_main_screen_view_model/MainScreenViewModel/showTutorial.md)({required dynamic onClickTarget([TargetFocus](https://pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TargetFocus-class.html)), required dynamic onFinish()}) void +##### [showTutorial](../view_model_main_screen_view_model/MainScreenViewModel/showTutorial.md)(\{required dynamic onClickTarget([TargetFocus](https:pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TargetFocus-class.html)), required dynamic onFinish()\}) void @@ -488,12 +488,12 @@ This function show tutorial to user. -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -546,12 +546,12 @@ This function show the tutorial for the profile page. ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ @@ -559,48 +559,48 @@ _inherited_ ## Static Properties -##### [keyDrawerCurOrg](../view_model_main_screen_view_model/MainScreenViewModel/keyDrawerCurOrg.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> +##### [keyDrawerCurOrg](../view_model_main_screen_view_model/MainScreenViewModel/keyDrawerCurOrg.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> static variables. -_final_ +_\final\_ -##### [keyDrawerJoinOrg](../view_model_main_screen_view_model/MainScreenViewModel/keyDrawerJoinOrg.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> +##### [keyDrawerJoinOrg](../view_model_main_screen_view_model/MainScreenViewModel/keyDrawerJoinOrg.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> static variables. -_final_ +_\final\_ -##### [keyDrawerLeaveCurrentOrg](../view_model_main_screen_view_model/MainScreenViewModel/keyDrawerLeaveCurrentOrg.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> +##### [keyDrawerLeaveCurrentOrg](../view_model_main_screen_view_model/MainScreenViewModel/keyDrawerLeaveCurrentOrg.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> static variables. -_final_ +_\final\_ -##### [keyDrawerSwitchableOrg](../view_model_main_screen_view_model/MainScreenViewModel/keyDrawerSwitchableOrg.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> +##### [keyDrawerSwitchableOrg](../view_model_main_screen_view_model/MainScreenViewModel/keyDrawerSwitchableOrg.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> static variables. -_final_ +_\final\_ -##### [scaffoldKey](../view_model_main_screen_view_model/MainScreenViewModel/scaffoldKey.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[ScaffoldState](https://api.flutter.dev/flutter/material/ScaffoldState-class.html)> +##### [scaffoldKey](../view_model_main_screen_view_model/MainScreenViewModel/scaffoldKey.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[ScaffoldState](https:api.flutter.dev/flutter/material/ScaffoldState-class.html)\> static variables. -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/context.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/context.md index e4087fcab82..5bc8df2639d 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/context.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/context.md @@ -9,13 +9,13 @@ -[BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context +[BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context -_read / write_ +_\read / write\_ -

context consist of parent info.

+\context consist of parent info.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/currentPageIndex.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/currentPageIndex.md index 93f29526092..94671863825 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/currentPageIndex.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/currentPageIndex.md @@ -9,13 +9,13 @@ -[int](https://api.flutter.dev/flutter/dart-core/int-class.html) currentPageIndex +[int](https:api.flutter.dev/flutter/dart-core/int-class.html) currentPageIndex -_read / write_ +_\read / write\_ -

var for current page in index.

+\var for current page in index.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/fetchAndAddPlugins.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/fetchAndAddPlugins.md index 9e2ca01050e..8780f2b5098 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/fetchAndAddPlugins.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/fetchAndAddPlugins.md @@ -11,20 +11,20 @@ void fetchAndAddPlugins -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -

Dynamically adds BottomNavigationBarItems in BottomNavigationBar.

-

by mapping over the data received from the server.

-

params:

-
    -
  • context: its the same context you use everywhere in the flutter framework refer flutter docs for more info.
  • -
-

returns: - None

+\Dynamically adds \BottomNavigationBarItems\ in \BottomNavigationBar\.\ +\by mapping over the data received from the server.\ +\\params\:\ +\ +\\context\: its the same context you use everywhere in the flutter framework refer flutter docs for more info.\ +\ +\\returns\: + None\ @@ -33,7 +33,7 @@ void fetchAndAddPlugins ```dart void fetchAndAddPlugins( BuildContext context, -) { +) \{ navBarItems = [ BottomNavigationBarItem( icon: Icon( @@ -94,18 +94,18 @@ void fetchAndAddPlugins( ), ]; - pluginList = (Hive.box('pluginBox').get('plugins') ?? []) as List; + pluginList = (Hive.box('pluginBox').get('plugins') ?? []) as List\; - pluginList.forEach((plugin) { + pluginList.forEach((plugin) \{ if (pluginPrototypeData.containsKey( - (plugin as Map)["pluginName"] as String, + (plugin as Map\)["pluginName"] as String, ) && - plugin["pluginInstallStatus"] as bool) { + plugin["pluginInstallStatus"] as bool) \{ navBarItems.add( BottomNavigationBarItem( icon: Icon( (pluginPrototypeData[plugin["pluginName"]] - as Map)["icon"] as IconData, + as Map\)["icon"] as IconData, ), label: AppLocalizations.of(context)!.strictTranslate( plugin["pluginName"] as String, @@ -114,24 +114,23 @@ void fetchAndAddPlugins( ); pages.add( (pluginPrototypeData[plugin["pluginName"]] - as Map)["class"] as StatelessWidget, + as Map\)["class"] as StatelessWidget, ); - } - }); + \} + \}); - /// Causes the app check the plugins updates in every 300 sec - /// - /// updated and re-render the navbar - Timer.periodic(const Duration(seconds: 300), (timer) { + Causes the app check the plugins updates in every 300 sec + updated and re-render the navbar + Timer.periodic(const Duration(seconds: 300), (timer) \{ FetchPluginList(); final newPluginList = - (Hive.box('pluginBox').get('plugins') ?? []) as List; + (Hive.box('pluginBox').get('plugins') ?? []) as List\; - if (listEquals(pluginList, newPluginList)) { + if (listEquals(pluginList, newPluginList)) \{ notifyListeners(); - } - }); -} + \} + \}); +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/focusTarget.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/focusTarget.md index 0e1e09f121f..5e3364db50d 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/focusTarget.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/focusTarget.md @@ -10,31 +10,31 @@ -[TargetFocus](https://pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TargetFocus-class.html) focusTarget -([GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> key, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) keyName, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) description, {[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isCircle = false, [ContentAlign](https://pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/ContentAlign.html) align = ContentAlign.bottom, [CrossAxisAlignment](https://api.flutter.dev/flutter/rendering/CrossAxisAlignment.html) crossAlign = CrossAxisAlignment.start, [Alignment](https://api.flutter.dev/flutter/painting/Alignment-class.html) skipAlignment = Alignment.topRight, [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html)? next, [CrossAxisAlignment](https://api.flutter.dev/flutter/rendering/CrossAxisAlignment.html) nextCrossAlign = CrossAxisAlignment.end, [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isEnd = false}) +[TargetFocus](https:pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TargetFocus-class.html) focusTarget +([GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> key, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) keyName, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) description, \{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isCircle = false, [ContentAlign](https:pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/ContentAlign.html) align = ContentAlign.bottom, [CrossAxisAlignment](https:api.flutter.dev/flutter/rendering/CrossAxisAlignment.html) crossAlign = CrossAxisAlignment.start, [Alignment](https:api.flutter.dev/flutter/painting/Alignment-class.html) skipAlignment = Alignment.topRight, [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html)? next, [CrossAxisAlignment](https:api.flutter.dev/flutter/rendering/CrossAxisAlignment.html) nextCrossAlign = CrossAxisAlignment.end, [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isEnd = false\}) -

This returns a widget for a step in a tutorial.

-

params:

-
    -
  • key: key of type GlobalKey.
  • -
  • keyName: key where the widget shows.
  • -
  • description: description of the step.
  • -
  • isCircle: bool to specify if circle
  • -
  • align: align of type ContentAlign to align button.
  • -
  • crossAlign: Cross align axes
  • -
  • skipAlignment: to give alignment of skip option
  • -
  • next: Functiontype, this show the next step orkey` to show the tour of.
  • -
  • nextCrossAlign: nextCrossAlign to give alignment of next option
  • -
  • isEnd: true if last step of the tour.
  • -
-

returns:

-
    -
  • TargetFocus: This return widget foa a step in a tut
  • -
+\This returns a widget for a step in a tutorial.\ +\\params\:\ +\ +\\key\: key of type GlobalKey.\ +\\keyName\: key where the widget shows.\ +\\description\: description of the step.\ +\\isCircle\: bool to specify if circle\ +\\align\: align of type ContentAlign to align button.\ +\\crossAlign\: Cross align axes\ +\\skipAlignment\: to give alignment of skip option\ +\\next\: Function\type, this show the next step or\key` to show the tour of.\ +\\nextCrossAlign\: nextCrossAlign to give alignment of next option\ +\\isEnd\: true if last step of the tour.\ +\ +\\returns\:\ +\ +\\TargetFocus\: This return widget foa a step in a tut\ +\ @@ -44,7 +44,7 @@ TargetFocus focusTarget( GlobalKey key, String keyName, - String description, { + String description, \{ bool isCircle = false, ContentAlign align = ContentAlign.bottom, CrossAxisAlignment crossAlign = CrossAxisAlignment.start, @@ -52,7 +52,7 @@ TargetFocus focusTarget( Function? next, CrossAxisAlignment nextCrossAlign = CrossAxisAlignment.end, bool isEnd = false, -}) { +\}) \{ return TargetFocus( enableOverlayTab: true, color: Colors.transparent, @@ -63,12 +63,12 @@ TargetFocus focusTarget( contents: [ TargetContent( align: align, - builder: (context, controller) { + builder: (context, controller) \{ return Container( child: Column( mainAxisSize: MainAxisSize.max, crossAxisAlignment: crossAlign, - children: [ + children: \[ Text( description, style: TextStyle( @@ -79,26 +79,26 @@ TargetFocus focusTarget( ], ), ); - }, + \}, ), TargetContent( align: ContentAlign.custom, customPosition: CustomTargetContentPosition( bottom: SizeConfig.screenHeight! * 0.025, ), - builder: (context, controller) { + builder: (context, controller) \{ return GestureDetector( - onTap: () { - if (next != null) { - // ignore: avoid_dynamic_calls + onTap: () \{ + if (next != null) \{ + ignore: avoid_dynamic_calls next(); - } + \} tutorialCoachMark.next(); - }, + \}, child: Column( mainAxisSize: MainAxisSize.min, crossAxisAlignment: nextCrossAlign, - children: [ + children: \[ Text( isEnd ? 'COMPLETE' : 'NEXT', style: TextStyle( @@ -109,11 +109,11 @@ TargetFocus focusTarget( ], ), ); - }, + \}, ), ], ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/initialise.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/initialise.md index 6f369532606..1b4db44ba91 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/initialise.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/initialise.md @@ -11,21 +11,21 @@ void initialise -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) ctx, {required [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) fromSignUp, required [int](https://api.flutter.dev/flutter/dart-core/int-class.html) mainScreenIndex}) +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) ctx, \{required [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) fromSignUp, required [int](https:api.flutter.dev/flutter/dart-core/int-class.html) mainScreenIndex\}) -

Initalizing function.

-

params:

-
    -
  • ctx: BuildContext, contain parent info
  • -
  • fromSignUp: Bool to find user entry
  • -
  • mainScreenIndex: Index to find tab on mainScreen
  • -
-

returns: - None

+\Initalizing function.\ +\\params\:\ +\ +\\ctx\: BuildContext, contain parent info\ +\\fromSignUp\: Bool to find user entry\ +\\mainScreenIndex\: Index to find tab on mainScreen\ +\ +\\returns\: + None\ @@ -33,48 +33,48 @@ void initialise ```dart void initialise( - BuildContext ctx, { + BuildContext ctx, \{ required bool fromSignUp, required int mainScreenIndex, -}) { +\}) \{ currentPageIndex = mainScreenIndex; showAppTour = fromSignUp; - pluginPrototypeData = { - "Donation": { + pluginPrototypeData = \{ + "Donation": \{ "icon": Icons.attach_money_outlined, "page": const ChangeThemeTile(), - } - }; + \} + \}; notifyListeners(); - if (!showAppTour) { + if (!showAppTour) \{ tourComplete = true; tourSkipped = false; - } else { + \} else \{ Future.delayed( const Duration(seconds: 1), - () => navigationService.pushDialog( + () =\> navigationService.pushDialog( CustomAlertDialog( dialogTitle: 'App Tour', dialogSubTitle: 'Start app tour to know talawa functioning', successText: 'Start', secondaryButtonText: 'Skip', - success: () { + success: () \{ context = ctx; navigationService.pop(); tourHomeTargets(); - }, - secondaryButtonTap: () { + \}, + secondaryButtonTap: () \{ tourComplete = false; tourSkipped = true; notifyListeners(); - }, + \}, ), ), ); - } -} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNChat.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNChat.md index b879914b132..a4b75abd48b 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNChat.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNChat.md @@ -9,13 +9,13 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> keyBNChat +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> keyBNChat -_final_ +_\final\_ -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNEvents.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNEvents.md index e30a54fde13..9a08a68876d 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNEvents.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNEvents.md @@ -9,13 +9,13 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> keyBNEvents +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> keyBNEvents -_final_ +_\final\_ -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNHome.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNHome.md index 76999440539..e5b97a32b83 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNHome.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNHome.md @@ -9,13 +9,13 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> keyBNHome +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> keyBNHome -_final_ +_\final\_ -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNPost.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNPost.md index fffa6690138..2d4e431f05f 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNPost.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNPost.md @@ -9,13 +9,13 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> keyBNPost +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> keyBNPost -_final_ +_\final\_ -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNProfile.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNProfile.md index 911ddc8b60d..eddf34a5fb6 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNProfile.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNProfile.md @@ -9,13 +9,13 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> keyBNProfile +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> keyBNProfile -_final_ +_\final\_ -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerCurOrg.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerCurOrg.md index e719516e791..776377da4fa 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerCurOrg.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerCurOrg.md @@ -9,13 +9,13 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> keyDrawerCurOrg +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> keyDrawerCurOrg -_final_ +_\final\_ -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerJoinOrg.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerJoinOrg.md index 384fecced58..6f2795d822d 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerJoinOrg.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerJoinOrg.md @@ -9,13 +9,13 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> keyDrawerJoinOrg +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> keyDrawerJoinOrg -_final_ +_\final\_ -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerLeaveCurrentOrg.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerLeaveCurrentOrg.md index 1c4a7087d70..2ab946ca5ea 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerLeaveCurrentOrg.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerLeaveCurrentOrg.md @@ -9,13 +9,13 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> keyDrawerLeaveCurrentOrg +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> keyDrawerLeaveCurrentOrg -_final_ +_\final\_ -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerSwitchableOrg.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerSwitchableOrg.md index decbb607254..09e8f9baca6 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerSwitchableOrg.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerSwitchableOrg.md @@ -9,13 +9,13 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> keyDrawerSwitchableOrg +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> keyDrawerSwitchableOrg -_final_ +_\final\_ -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySEAdd.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySEAdd.md index 0644acd2de0..499a8b3b5a3 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySEAdd.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySEAdd.md @@ -9,13 +9,13 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> keySEAdd +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> keySEAdd -_final_ +_\final\_ -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySECard.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySECard.md index 52a9e67ab4d..0b381a62670 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySECard.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySECard.md @@ -9,13 +9,13 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> keySECard +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> keySECard -_final_ +_\final\_ -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySECategoryMenu.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySECategoryMenu.md index 729b2b95e0f..67acb45f00d 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySECategoryMenu.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySECategoryMenu.md @@ -9,13 +9,13 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> keySECategoryMenu +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> keySECategoryMenu -_final_ +_\final\_ -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySEDateFilter.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySEDateFilter.md index f2d5f5e1d75..67db5df21c7 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySEDateFilter.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySEDateFilter.md @@ -9,13 +9,13 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> keySEDateFilter +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> keySEDateFilter -_final_ +_\final\_ -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHMenuIcon.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHMenuIcon.md index 89c78447f50..e502f95141e 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHMenuIcon.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHMenuIcon.md @@ -9,13 +9,13 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> keySHMenuIcon +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> keySHMenuIcon -_final_ +_\final\_ -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHOrgName.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHOrgName.md index 2960a23f968..a92ea915ecf 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHOrgName.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHOrgName.md @@ -9,13 +9,13 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> keySHOrgName +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> keySHOrgName -_final_ +_\final\_ -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHPinnedPost.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHPinnedPost.md index 3afe3994321..9cb2bd3d742 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHPinnedPost.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHPinnedPost.md @@ -9,13 +9,13 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> keySHPinnedPost +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> keySHPinnedPost -_final_ +_\final\_ -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHPost.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHPost.md index 1dcf20665a2..847e54c4b2f 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHPost.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHPost.md @@ -9,13 +9,13 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> keySHPost +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> keySHPost -_final_ +_\final\_ -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPAppSetting.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPAppSetting.md index fec00207785..bbf234f0067 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPAppSetting.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPAppSetting.md @@ -9,13 +9,13 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> keySPAppSetting +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> keySPAppSetting -_final_ +_\final\_ -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPDonateUs.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPDonateUs.md index c912d760f58..4c565ae3017 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPDonateUs.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPDonateUs.md @@ -9,13 +9,13 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> keySPDonateUs +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> keySPDonateUs -_final_ +_\final\_ -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPEditProfile.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPEditProfile.md index 9d406c2f98c..2e542549b89 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPEditProfile.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPEditProfile.md @@ -9,13 +9,13 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> keySPEditProfile +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> keySPEditProfile -_final_ +_\final\_ -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPHelp.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPHelp.md index f1e340f2123..eeea24a17f0 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPHelp.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPHelp.md @@ -9,13 +9,13 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> keySPHelp +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> keySPHelp -_final_ +_\final\_ -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPInvite.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPInvite.md index 8bda57f92b9..3fa601efe9a 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPInvite.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPInvite.md @@ -9,13 +9,13 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> keySPInvite +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> keySPInvite -_final_ +_\final\_ -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPLogout.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPLogout.md index 4189652428b..a18a2c14293 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPLogout.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPLogout.md @@ -9,13 +9,13 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> keySPLogout +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> keySPLogout -_final_ +_\final\_ -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPPalisadoes.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPPalisadoes.md index 71ef98a278d..46297257572 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPPalisadoes.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPPalisadoes.md @@ -9,13 +9,13 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> keySPPalisadoes +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> keySPPalisadoes -_final_ +_\final\_ -

static variables.

+\static variables.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/navBarItems.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/navBarItems.md index 48e1b405b22..1faac4cb267 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/navBarItems.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/navBarItems.md @@ -9,20 +9,20 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[BottomNavigationBarItem](https://api.flutter.dev/flutter/widgets/BottomNavigationBarItem-class.html)> navBarItems +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[BottomNavigationBarItem](https:api.flutter.dev/flutter/widgets/BottomNavigationBarItem-class.html)\> navBarItems -_read / write_ +_\read / write\_ -

Actual BottomNavigationBarItems that show up on the screen.

+\Actual \BottomNavigationBarItem\s that show up on the screen.\ ## Implementation ```dart -List navBarItems = []; +List\ navBarItems = []; ``` diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/onTabTapped.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/onTabTapped.md index 7bae5460f93..64c45756cbe 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/onTabTapped.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/onTabTapped.md @@ -11,29 +11,29 @@ void onTabTapped -([int](https://api.flutter.dev/flutter/dart-core/int-class.html) index) +([int](https:api.flutter.dev/flutter/dart-core/int-class.html) index) -

Handles click on BottomNavigationBarItem.

-

params:

-
    -
  • index: it is track of current page index.
  • -
-

returns: - None

+\Handles click on \BottomNavigationBarItem\.\ +\\params\:\ +\ +\\index\: it is track of current page index.\ +\ +\\returns\: + None\ ## Implementation ```dart -void onTabTapped(int index) { +void onTabTapped(int index) \{ currentPageIndex = index; notifyListeners(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/pages.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/pages.md index d4bc8e82f3f..5878afa055b 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/pages.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/pages.md @@ -9,21 +9,21 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html)> pages +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html)\> pages -_read / write_ +_\read / write\_ -

Contains the Widgets to be rendered for corresponding navbar items.

-

Features that should be implemented as plugins should be kept here.

+\Contains the Widgets to be rendered for corresponding navbar items.\ +\Features that should be implemented as plugins should be kept here.\ ## Implementation ```dart -List pages = []; +List\ pages = []; ``` diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/pluginList.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/pluginList.md index 8b7b6fca19f..743a37a43ba 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/pluginList.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/pluginList.md @@ -9,20 +9,20 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html) pluginList +[List](https:api.flutter.dev/flutter/dart-core/List-class.html) pluginList -_read / write_ +_\read / write\_ -

list of all the pluginList.

+\list of all the pluginList.\ ## Implementation ```dart -List pluginList = []; +List\ pluginList = []; ``` diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/pluginPrototypeData.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/pluginPrototypeData.md index 3974228ed0e..658e47de6cc 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/pluginPrototypeData.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/pluginPrototypeData.md @@ -9,24 +9,24 @@ -[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html) pluginPrototypeData +[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html) pluginPrototypeData -_read / write_ +_\read / write\_ -

Maps the feature names with their proper Icon and Page.

-

icon contains the IconData corresponding to plugin's icon. -page contains the corresponding page to be displayed. -Name of the feature provided by the admin must exactly match with the. -name stored here.

+\Maps the feature names with their proper Icon and Page.\ +\\icon\ contains the \IconData\ corresponding to plugin's icon. +\page\ contains the corresponding page to be displayed. +Name of the feature provided by the admin must \exactly\ match with the. +name stored here.\ ## Implementation ```dart -Map pluginPrototypeData = {}; +Map\ pluginPrototypeData = \{\}; ``` diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/scaffoldKey.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/scaffoldKey.md index e72672b7e8f..744fb4734e9 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/scaffoldKey.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/scaffoldKey.md @@ -9,21 +9,21 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[ScaffoldState](https://api.flutter.dev/flutter/material/ScaffoldState-class.html)> scaffoldKey +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[ScaffoldState](https:api.flutter.dev/flutter/material/ScaffoldState-class.html)\> scaffoldKey -_final_ +_\final\_ -

static variables.

+\static variables.\ ## Implementation ```dart -static final GlobalKey scaffoldKey = - GlobalKey(); +static final GlobalKey\ scaffoldKey = + GlobalKey\(); ``` diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/showAppTour.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/showAppTour.md index a1d5c5f111a..35fa4a558db 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/showAppTour.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/showAppTour.md @@ -9,13 +9,13 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) showAppTour +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) showAppTour -_read / write_ +_\read / write\_ -

bool to determine if we wanna show the apptour.

+\bool to determine if we wanna show the apptour.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/showHome.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/showHome.md index b91cffd6813..bdd6f57079d 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/showHome.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/showHome.md @@ -11,34 +11,34 @@ void showHome -([TargetFocus](https://pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TargetFocus-class.html) clickedTarget) +([TargetFocus](https:pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TargetFocus-class.html) clickedTarget) -

This function shows the Home screen.

-

params:

-
    -
  • clickedTarget: object to identify clickedTarget.
  • -
-

returns: - None

+\This function shows the Home screen.\ +\\params\:\ +\ +\\clickedTarget\: object to identify clickedTarget.\ +\ +\\returns\: + None\ ## Implementation ```dart -void showHome(TargetFocus clickedTarget) { - switch (clickedTarget.identify) { +void showHome(TargetFocus clickedTarget) \{ + switch (clickedTarget.identify) \{ case "keySHMenuIcon": scaffoldKey.currentState!.openDrawer(); break; case "keyDrawerLeaveCurrentOrg": navigationService.pop(); - } -} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/showTutorial.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/showTutorial.md index 010e415b6b8..aa633fb48f8 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/showTutorial.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/showTutorial.md @@ -11,30 +11,30 @@ void showTutorial -({required dynamic onClickTarget([TargetFocus](https://pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TargetFocus-class.html)), required dynamic onFinish()}) +(\{required dynamic onClickTarget([TargetFocus](https:pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TargetFocus-class.html)), required dynamic onFinish()\}) -

This function show tutorial to user.

-

params:

-
    -
  • onClickTarget: Its a function which is required to run desired tasks on click.
  • -
  • onFinish: Its a function which is required to run desired tasks on finish
  • -
-

returns: - None

+\This function show tutorial to user.\ +\\params\:\ +\ +\\onClickTarget\: Its a function which is required to run desired tasks on click.\ +\\onFinish\: Its a function which is required to run desired tasks on finish\ +\ +\\returns\: + None\ ## Implementation ```dart -void showTutorial({ +void showTutorial(\{ required dynamic Function(TargetFocus) onClickTarget, required dynamic Function() onFinish, -}) { +\}) \{ tutorialCoachMark = TutorialCoachMark( targets: targets, colorShadow: Theme.of(context).colorScheme.secondaryContainer, @@ -47,18 +47,18 @@ void showTutorial({ opacityShadow: 1.0, onFinish: onFinish, onClickTarget: onClickTarget, - onSkip: () { - if (scaffoldKey.currentState!.isDrawerOpen) { + onSkip: () \{ + if (scaffoldKey.currentState!.isDrawerOpen) \{ navigationService.pop(); - } + \} tourSkipped = true; onTabTapped(0); - }, - onClickOverlay: (target) { + \}, + onClickOverlay: (target) \{ onClickTarget(target); - }, + \}, )..show(context: context); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/targets.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/targets.md index 1a70dc39133..e1ae7f2e774 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/targets.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/targets.md @@ -9,20 +9,20 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[TargetFocus](https://pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TargetFocus-class.html)> targets +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[TargetFocus](https:pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TargetFocus-class.html)\> targets -_final_ +_\final\_ -

array of target.

+\array of target.\ ## Implementation ```dart -final List targets = []; +final List\ targets = []; ``` diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourAddPost.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourAddPost.md index aff76a55630..55320461a44 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourAddPost.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourAddPost.md @@ -17,18 +17,18 @@ void tourAddPost -

This function show the tutorial to add Post in the organization.

-

params: - None

-

returns: - None

+\This function show the tutorial to add Post in the organization.\ +\\params\: + None\ +\\returns\: + None\ ## Implementation ```dart -void tourAddPost() { +void tourAddPost() \{ targets.clear(); targets.add( focusTarget( @@ -40,15 +40,15 @@ void tourAddPost() { ), ); showTutorial( - onFinish: () { + onFinish: () \{ onTabTapped(currentPageIndex + 1); - if (!tourComplete && !tourSkipped) { + if (!tourComplete && !tourSkipped) \{ tourChat(); - } - }, - onClickTarget: (TargetFocus a) {}, + \} + \}, + onClickTarget: (TargetFocus a) \{\}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourChat.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourChat.md index 9386279f522..b8decf64cfc 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourChat.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourChat.md @@ -17,18 +17,18 @@ void tourChat -

This function show the tour of chats.

-

params: - None

-

returns: - None

+\This function show the tour of chats.\ +\\params\: + None\ +\\returns\: + None\ ## Implementation ```dart -void tourChat() { +void tourChat() \{ targets.clear(); targets.add( focusTarget( @@ -40,15 +40,15 @@ void tourChat() { ), ); showTutorial( - onFinish: () { + onFinish: () \{ onTabTapped(currentPageIndex + 1); - if (!tourComplete && !tourSkipped) { + if (!tourComplete && !tourSkipped) \{ tourProfile(); - } - }, - onClickTarget: (TargetFocus a) {}, + \} + \}, + onClickTarget: (TargetFocus a) \{\}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourComplete.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourComplete.md index f95abfaf6db..13695f6d8cf 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourComplete.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourComplete.md @@ -9,13 +9,13 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) tourComplete +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) tourComplete -_read / write_ +_\read / write\_ -

bool to determine if apptour is complete.

+\bool to determine if apptour is complete.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourEventTargets.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourEventTargets.md index 35a5377474a..fa8c6370f3c 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourEventTargets.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourEventTargets.md @@ -17,18 +17,18 @@ void tourEventTargets -

This function show the tutorial for Events.

-

params: - None

-

returns: - None

+\This function show the tutorial for Events.\ +\\params\: + None\ +\\returns\: + None\ ## Implementation ```dart -void tourEventTargets() { +void tourEventTargets() \{ targets.clear(); targets.add( focusTarget( @@ -69,15 +69,15 @@ void tourEventTargets() { ), ); showTutorial( - onFinish: () { + onFinish: () \{ onTabTapped(currentPageIndex + 1); - if (!tourComplete && !tourSkipped) { + if (!tourComplete && !tourSkipped) \{ tourAddPost(); - } - }, - onClickTarget: (TargetFocus a) {}, + \} + \}, + onClickTarget: (TargetFocus a) \{\}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourHomeTargets.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourHomeTargets.md index 8a9dbd83ba1..15285e7caa0 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourHomeTargets.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourHomeTargets.md @@ -17,18 +17,18 @@ void tourHomeTargets -

this functions starts the tour and info to be displayed is mentioned in this functions.

-

params: - None

-

returns: - None

+\this functions starts the tour and info to be displayed is mentioned in this functions.\ +\\params\: + None\ +\\returns\: + None\ ## Implementation ```dart -void tourHomeTargets() { +void tourHomeTargets() \{ targets.clear(); targets.add( focusTarget( @@ -43,7 +43,7 @@ void tourHomeTargets() { 'keySHMenuIcon', 'Click this button to see options related to switching, joining and leaving organization(s)', isCircle: true, - next: () => scaffoldKey.currentState!.openDrawer(), + next: () =\> scaffoldKey.currentState!.openDrawer(), ), ); targets.add( @@ -74,7 +74,7 @@ void tourHomeTargets() { 'keyDrawerLeaveCurrentOrg', "To leave the current organization you can use this option", align: ContentAlign.top, - next: () => navigationService.pop(), + next: () =\> navigationService.pop(), ), ); targets.add( @@ -104,14 +104,14 @@ void tourHomeTargets() { ); showTutorial( onClickTarget: showHome, - onFinish: () { + onFinish: () \{ onTabTapped(currentPageIndex + 1); - if (!tourComplete && !tourSkipped) { + if (!tourComplete && !tourSkipped) \{ tourEventTargets(); - } - }, + \} + \}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourProfile.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourProfile.md index 9aae9bc6484..c06c7faefe6 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourProfile.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourProfile.md @@ -17,18 +17,18 @@ void tourProfile -

This function show the tutorial for the profile page.

-

params: - None

-

returns: - None

+\This function show the tutorial for the profile page.\ +\\params\: + None\ +\\returns\: + None\ ## Implementation ```dart -void tourProfile() { +void tourProfile() \{ targets.clear(); targets.add( focusTarget( @@ -77,15 +77,15 @@ void tourProfile() { ), ); showTutorial( - onFinish: () { - if (!tourComplete && !tourSkipped) { + onFinish: () \{ + if (!tourComplete && !tourSkipped) \{ tourComplete = true; onTabTapped(0); - } - }, - onClickTarget: (TargetFocus a) {}, + \} + \}, + onClickTarget: (TargetFocus a) \{\}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourSkipped.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourSkipped.md index 46465249e34..040d5361215 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourSkipped.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourSkipped.md @@ -9,13 +9,13 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) tourSkipped +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) tourSkipped -_read / write_ +_\read / write\_ -

bool to determine if apptour is skipped.

+\bool to determine if apptour is skipped.\ diff --git a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tutorialCoachMark.md b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tutorialCoachMark.md index e6c7406f7eb..f50bcf16a8a 100644 --- a/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tutorialCoachMark.md +++ b/docs/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tutorialCoachMark.md @@ -9,13 +9,13 @@ -[TutorialCoachMark](https://pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TutorialCoachMark-class.html) tutorialCoachMark +[TutorialCoachMark](https:pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TutorialCoachMark-class.html) tutorialCoachMark -_read / write_ +_\read / write\_ -

tutorialCoachMark consist of coach used to give tutorial.

+\tutorialCoachMark consist of coach used to give tutorial.\ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel-class.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel-class.md index c2c1a9d0994..59727e69fa3 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel-class.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel-class.md @@ -11,19 +11,19 @@ -

LoginViewModel class helps to interact with model to serve data -and react to user's input in Login View.

-

Methods include:

-
    -
  • login
  • -
+\LoginViewModel class helps to interact with model to serve data +and react to user's input in Login View.\ +\Methods include:\ +\ +\\login\\ +\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) - [BaseModel](../view_model_base_view_model/BaseModel-class.md) - LoginViewModel @@ -43,102 +43,102 @@ and react to user's input in Login View.

## Properties -##### [email](../view_model_pre_auth_view_models_login_view_model/LoginViewModel/email.md) ↔ [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) +##### [email](../view_model_pre_auth_view_models_login_view_model/LoginViewModel/email.md) ↔ [TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) -_read / write_ +_\read / write\_ -##### [emailFocus](../view_model_pre_auth_view_models_login_view_model/LoginViewModel/emailFocus.md) ↔ [FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) +##### [emailFocus](../view_model_pre_auth_view_models_login_view_model/LoginViewModel/emailFocus.md) ↔ [FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) -_read / write_ +_\read / write\_ -##### [formKey](../view_model_pre_auth_view_models_login_view_model/LoginViewModel/formKey.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[FormState](https://api.flutter.dev/flutter/widgets/FormState-class.html)> +##### [formKey](../view_model_pre_auth_view_models_login_view_model/LoginViewModel/formKey.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[FormState](https:api.flutter.dev/flutter/widgets/FormState-class.html)\> -_final_ +_\final\_ -##### [greeting](../view_model_pre_auth_view_models_login_view_model/LoginViewModel/greeting.md) ↔ [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic>> +##### [greeting](../view_model_pre_auth_view_models_login_view_model/LoginViewModel/greeting.md) ↔ [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> -_read / write_ +_\read / write\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hasListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hasListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether any listeners are currently registered. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hidePassword](../view_model_pre_auth_view_models_login_view_model/LoginViewModel/hidePassword.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hidePassword](../view_model_pre_auth_view_models_login_view_model/LoginViewModel/hidePassword.md) ↔ [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read / write_ +_\read / write\_ -##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [password](../view_model_pre_auth_view_models_login_view_model/LoginViewModel/password.md) ↔ [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) +##### [password](../view_model_pre_auth_view_models_login_view_model/LoginViewModel/password.md) ↔ [TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) -_read / write_ +_\read / write\_ -##### [passwordFocus](../view_model_pre_auth_view_models_login_view_model/LoginViewModel/passwordFocus.md) ↔ [FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) +##### [passwordFocus](../view_model_pre_auth_view_models_login_view_model/LoginViewModel/passwordFocus.md) ↔ [FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) -_read / write_ +_\read / write\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -147,16 +147,16 @@ _read-onlyinherited_ -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [validate](../view_model_pre_auth_view_models_login_view_model/LoginViewModel/validate.md) ↔ [AutovalidateMode](https://api.flutter.dev/flutter/widgets/AutovalidateMode.html) +##### [validate](../view_model_pre_auth_view_models_login_view_model/LoginViewModel/validate.md) ↔ [AutovalidateMode](https:api.flutter.dev/flutter/widgets/AutovalidateMode.html) -_read / write_ +_\read / write\_ @@ -164,23 +164,23 @@ _read / write_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be called when the object changes. -_inherited_ +_\inherited\_ -##### [dispose](https://api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void +##### [dispose](https:api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -
addListener will throw after the object is disposed). -_inherited_ +\addListener\ will throw after the object is disposed). +_\inherited\_ @@ -193,7 +193,7 @@ _inherited_ -##### [login](../view_model_pre_auth_view_models_login_view_model/LoginViewModel/login.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [login](../view_model_pre_auth_view_models_login_view_model/LoginViewModel/login.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -202,31 +202,31 @@ This function is used to sign-in the user into application. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void +##### [notifyListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void Call all the registered listeners. -_inherited_ +_\inherited\_ -##### [removeListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that are notified when the object changes. -_inherited_ +_\inherited\_ @@ -235,16 +235,16 @@ _inherited_ -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -252,12 +252,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/email.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/email.md index 8fc948122f5..d33030efd93 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/email.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/email.md @@ -9,9 +9,9 @@ -[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) email +[TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) email -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/emailFocus.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/emailFocus.md index ecd01d588e0..d528de3d028 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/emailFocus.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/emailFocus.md @@ -9,9 +9,9 @@ -[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) emailFocus +[FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) emailFocus -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/formKey.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/formKey.md index d7de0e859ad..b2f0242bc8f 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/formKey.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/formKey.md @@ -9,9 +9,9 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[FormState](https://api.flutter.dev/flutter/widgets/FormState-class.html)> formKey +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[FormState](https:api.flutter.dev/flutter/widgets/FormState-class.html)\> formKey -_final_ +_\final\_ @@ -21,7 +21,7 @@ _final_ ## Implementation ```dart -final formKey = GlobalKey(); +final formKey = GlobalKey\(); ``` diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/greeting.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/greeting.md index de486919b3f..d8389804b58 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/greeting.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/greeting.md @@ -9,9 +9,9 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic>> greeting +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> greeting -_read / write_ +_\read / write\_ @@ -21,7 +21,7 @@ _read / write_ ## Implementation ```dart -late List> greeting; +late List\\> greeting; ``` diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/hidePassword.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/hidePassword.md index bd2ce20b961..c26d7bdd115 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/hidePassword.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/hidePassword.md @@ -9,9 +9,9 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) hidePassword +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) hidePassword -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/initialize.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/initialize.md index 048ef7ef85e..a7c3abba6dd 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/initialize.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/initialize.md @@ -23,37 +23,37 @@ void initialize ## Implementation ```dart -void initialize() { - // greating message +void initialize() \{ + greating message greeting = [ - { + \{ 'text': "We're ", 'textStyle': Theme.of(navigationService.navigatorKey.currentContext!) .textTheme .headlineSmall - }, - { + \}, + \{ 'text': 'Glad ', 'textStyle': Theme.of(navigationService.navigatorKey.currentContext!) .textTheme .titleLarge! .copyWith(fontSize: 24) - }, - { + \}, + \{ 'text': "you're ", 'textStyle': Theme.of(navigationService.navigatorKey.currentContext!) .textTheme .headlineSmall - }, - { + \}, + \{ 'text': 'Back ', 'textStyle': Theme.of(navigationService.navigatorKey.currentContext!) .textTheme .titleLarge! .copyWith(fontSize: 24) - }, + \}, ]; -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/login.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/login.md index dc101fdbe27..49a155f9fa7 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/login.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/login.md @@ -10,47 +10,47 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> login +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> login () -

This function is used to sign-in the user into application.

+\This function is used to sign-in the user into application.\ ## Implementation ```dart -Future login() async { +Future\ login() async \{ emailFocus.unfocus(); passwordFocus.unfocus(); validate = AutovalidateMode.always; - // if the email and password are not empty. - if (formKey.currentState!.validate()) { + if the email and password are not empty. + if (formKey.currentState!.validate()) \{ validate = AutovalidateMode.disabled; navigationService .pushDialog(const CustomProgressDialog(key: Key('LoginProgress'))); databaseFunctions.init(); - try { - // run the graph QL query to login the user, passing `email` and `password`. + try \{ + run the graph QL query to login the user, passing `email` and `password`. final result = await databaseFunctions .gqlNonAuthMutation(queries.loginUser(email.text, password.text)); navigationService.pop(); - // if user found. - if (result != null) { + if user found. + if (result != null) \{ final User loggedInUser = - User.fromJson(result.data!['login'] as Map); + User.fromJson(result.data!['login'] as Map\); userConfig.updateUser(loggedInUser); - // if user has not already joined any organization. - if (userConfig.currentUser.joinedOrganizations!.isEmpty) { + if user has not already joined any organization. + if (userConfig.currentUser.joinedOrganizations!.isEmpty) \{ navigationService.removeAllAndPush( Routes.waitingScreen, Routes.splashScreen, ); - } else { + \} else \{ userConfig.saveCurrentOrgInHive( userConfig.currentUser.joinedOrganizations![0], ); @@ -59,14 +59,14 @@ Future login() async { Routes.splashScreen, arguments: MainScreenArgs(mainScreenIndex: 0, fromSignUp: false), ); - } - final loginResult = result.data['login'] as Map; + \} + final loginResult = result.data['login'] as Map\; androidFirebaseOptions = - loginResult['androidFirebaseOptions'] as Map; + loginResult['androidFirebaseOptions'] as Map\; iosFirebaseOptions = - loginResult['iosFirebaseOptions'] as Map; + loginResult['iosFirebaseOptions'] as Map\; if (androidFirebaseOptions['apiKey'] != null || - iosFirebaseOptions['apiKey'] != null) { + iosFirebaseOptions['apiKey'] != null) \{ await setUpFirebase(); final token = await FirebaseMessaging.instance.getToken(); @@ -89,14 +89,14 @@ Future login() async { 'iosFirebaseOptions', iosFirebaseOptions, ); - } - } - } on Exception catch (e) { + \} + \} + \} on Exception catch (e) \{ print('here'); print(e); - } - } -} + \} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/password.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/password.md index b344a9fede7..31497c1146a 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/password.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/password.md @@ -9,9 +9,9 @@ -[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) password +[TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) password -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/passwordFocus.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/passwordFocus.md index 2b7716a5dc3..9ab193a7bab 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/passwordFocus.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/passwordFocus.md @@ -9,9 +9,9 @@ -[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) passwordFocus +[FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) passwordFocus -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/validate.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/validate.md index 7dd63a4d447..2abd528167e 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/validate.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/validate.md @@ -9,9 +9,9 @@ -[AutovalidateMode](https://api.flutter.dev/flutter/widgets/AutovalidateMode.html) validate +[AutovalidateMode](https:api.flutter.dev/flutter/widgets/AutovalidateMode.html) validate -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md index f7fa3a76d4d..c44f4da0b42 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md @@ -11,20 +11,20 @@ -

SelectOrganizationViewModel class helps to interact with model to serve data -and react to user's input in Select Organization View.

-

Methods include:

-
    -
  • selectOrg
  • -
  • onTapJoin
  • -
+\SelectOrganizationViewModel class helps to interact with model to serve data +and react to user's input in Select Organization View.\ +\Methods include:\ +\ +\\selectOrg\\ +\\onTapJoin\\ +\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) - [BaseModel](../view_model_base_view_model/BaseModel-class.md) - SelectOrganizationViewModel @@ -44,120 +44,120 @@ and react to user's input in Select Organization View.

## Properties -##### [allOrgController](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/allOrgController.md) → [ScrollController](https://api.flutter.dev/flutter/widgets/ScrollController-class.html) +##### [allOrgController](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/allOrgController.md) → [ScrollController](https:api.flutter.dev/flutter/widgets/ScrollController-class.html) -_final_ +_\final\_ -##### [controller](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/controller.md) → [ScrollController](https://api.flutter.dev/flutter/widgets/ScrollController-class.html) +##### [controller](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/controller.md) → [ScrollController](https:api.flutter.dev/flutter/widgets/ScrollController-class.html) -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hasListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hasListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether any listeners are currently registered. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [organizations](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/organizations.md) ↔ [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)> +##### [organizations](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/organizations.md) ↔ [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)\> -_read / write_ +_\read / write\_ -##### [orgId](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/orgId.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [orgId](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/orgId.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_read / write_ +_\read / write\_ -##### [qrKey](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/qrKey.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> +##### [qrKey](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/qrKey.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> -_final_ +_\final\_ -##### [result](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/result.md) ↔ [Barcode](https://pub.dev/documentation/qr_code_scanner/1.0.1/qr_code_scanner/Barcode-class.html) +##### [result](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/result.md) ↔ [Barcode](https:pub.dev/documentation/qr_code_scanner/1.0.1/qr_code_scanner/Barcode-class.html) -_read / write_ +_\read / write\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [searchController](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchController.md) → [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) +##### [searchController](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchController.md) → [TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) -_final_ +_\final\_ -##### [searchFocus](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchFocus.md) → [FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) +##### [searchFocus](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchFocus.md) → [FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) -_final_ +_\final\_ -##### [searching](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searching.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [searching](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searching.md) ↔ [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read / write_ +_\read / write\_ @@ -166,16 +166,16 @@ _read / write_ -_read / write_ +_\read / write\_ -##### [showSearchOrgList](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/showSearchOrgList.md) ↔ [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [showSearchOrgList](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/showSearchOrgList.md) ↔ [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) -_read / write_ +_\read / write\_ @@ -184,7 +184,7 @@ _read / write_ -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -192,27 +192,27 @@ _read-onlyinherited_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be called when the object changes. -_inherited_ +_\inherited\_ -##### [dispose](https://api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void +##### [dispose](https:api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -
addListener will throw after the object is disposed). -_inherited_ +\addListener\ will throw after the object is disposed). +_\inherited\_ -##### [fetchMoreHelper](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/fetchMoreHelper.md)([FetchMore](https://pub.dev/documentation/graphql_flutter/5.2.0-beta.5/graphql_flutter/FetchMore.html)<[Object](https://api.flutter.dev/flutter/dart-core/Object-class.html)?> fetchMore, [List](https://api.flutter.dev/flutter/dart-core/List-class.html) organizations) void +##### [fetchMoreHelper](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/fetchMoreHelper.md)([FetchMore](https:pub.dev/documentation/graphql_flutter/5.2.0-beta.5/graphql_flutter/FetchMore.html)<[Object](https:api.flutter.dev/flutter/dart-core/Object-class.html)?\> fetchMore, [List](https:api.flutter.dev/flutter/dart-core/List-class.html) organizations) void @@ -221,7 +221,7 @@ This function fetch more option. -##### [initialise](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/initialise.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) initialData) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [initialise](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/initialise.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) initialData) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -230,21 +230,21 @@ This function fetch more option. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void +##### [notifyListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void Call all the registered listeners. -_inherited_ +_\inherited\_ @@ -257,23 +257,23 @@ _inherited_ -##### [onTapJoin](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/onTapJoin.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [onTapJoin](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/onTapJoin.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> This function make user to join the selected organization. -The function uses joinOrgById graph QL query. +The function uses \joinOrgById\ graph QL query. -##### [removeListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that are notified when the object changes. -_inherited_ +_\inherited\_ @@ -286,7 +286,7 @@ _inherited_ -##### [selectOrg](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/selectOrg.md)([OrgInfo](../models_organization_org_info/OrgInfo-class.md) item) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [selectOrg](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/selectOrg.md)([OrgInfo](../models_organization_org_info/OrgInfo-class.md) item) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -300,16 +300,16 @@ This function select the organization. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -317,12 +317,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/allOrgController.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/allOrgController.md index 0e3bcabd30f..da95455cb35 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/allOrgController.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/allOrgController.md @@ -9,9 +9,9 @@ -[ScrollController](https://api.flutter.dev/flutter/widgets/ScrollController-class.html) allOrgController +[ScrollController](https:api.flutter.dev/flutter/widgets/ScrollController-class.html) allOrgController -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/controller.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/controller.md index 00b8f4d3b3b..c0979dd5f7f 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/controller.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/controller.md @@ -9,9 +9,9 @@ -[ScrollController](https://api.flutter.dev/flutter/widgets/ScrollController-class.html) controller +[ScrollController](https:api.flutter.dev/flutter/widgets/ScrollController-class.html) controller -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/fetchMoreHelper.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/fetchMoreHelper.md index e7c1a59725e..47815b561e0 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/fetchMoreHelper.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/fetchMoreHelper.md @@ -11,37 +11,37 @@ void fetchMoreHelper -([FetchMore](https://pub.dev/documentation/graphql_flutter/5.2.0-beta.5/graphql_flutter/FetchMore.html)<[Object](https://api.flutter.dev/flutter/dart-core/Object-class.html)?> fetchMore, [List](https://api.flutter.dev/flutter/dart-core/List-class.html) organizations) +([FetchMore](https:pub.dev/documentation/graphql_flutter/5.2.0-beta.5/graphql_flutter/FetchMore.html)<[Object](https:api.flutter.dev/flutter/dart-core/Object-class.html)?\> fetchMore, [List](https:api.flutter.dev/flutter/dart-core/List-class.html) organizations) -

This function fetch more option.

+\This function fetch more option.\ ## Implementation ```dart -void fetchMoreHelper(FetchMore fetchMore, List organizations) { +void fetchMoreHelper(FetchMore fetchMore, List organizations) \{ fetchMore( FetchMoreOptions( - variables: { + variables: \{ "first": organizations.length + 15, "skip": organizations.length, - }, - updateQuery: (existingOrganizations, newOrganizations) { - return { + \}, + updateQuery: (existingOrganizations, newOrganizations) \{ + return \{ 'organizationsConnection': [ ...existingOrganizations!["organizationsConnection"], ...newOrganizations!['organizationsConnection'], ], - }; - }, + \}; + \}, ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/initialise.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/initialise.md index a13f60bf169..4ff77fd9368 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/initialise.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/initialise.md @@ -10,8 +10,8 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> initialise -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) initialData) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> initialise +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) initialData) @@ -23,25 +23,25 @@ ## Implementation ```dart -Future initialise(String initialData) async { +Future\ initialise(String initialData) async \{ searchFocus.addListener(searchActive); - if (!initialData.contains('-1')) { + if (!initialData.contains('-1')) \{ databaseFunctions.init(); final fetch = await databaseFunctions.fetchOrgById(initialData); - if (fetch.runtimeType == OrgInfo) { + if (fetch.runtimeType == OrgInfo) \{ selectedOrganization = fetch as OrgInfo; - if (userConfig.currentUser.refreshToken?.isEmpty ?? true) { + if (userConfig.currentUser.refreshToken?.isEmpty ?? true) \{ navigationService.pushScreen( Routes.signupDetailScreen, arguments: selectedOrganization, ); - } else { + \} else \{ selectOrg(selectedOrganization); - } + \} setState(ViewState.idle); - } - } -} + \} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/onTapContinue.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/onTapContinue.md index 916f8b18a00..8af30401476 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/onTapContinue.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/onTapContinue.md @@ -23,21 +23,21 @@ void onTapContinue ## Implementation ```dart -void onTapContinue() { - // if user selected any organization. - if (selectedOrganization.id != '-1') { +void onTapContinue() \{ + if user selected any organization. + if (selectedOrganization.id != '-1') \{ navigationService.pushScreen( Routes.signupDetailScreen, arguments: selectedOrganization, ); - } else { + \} else \{ navigationService.showTalawaErrorSnackBar( 'Select one organization to continue', MessageType.warning, duration: const Duration(milliseconds: 750), ); - } -} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/onTapJoin.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/onTapJoin.md index c1323323711..c49177252ed 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/onTapJoin.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/onTapJoin.md @@ -10,39 +10,39 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> onTapJoin +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> onTapJoin () -

This function make user to join the selected organization. -The function uses joinOrgById graph QL query.

+\This function make user to join the selected organization. +The function uses \joinOrgById\ graph QL query.\ ## Implementation ```dart -Future onTapJoin() async { - // if `selectedOrganization` is public. - if (selectedOrganization.isPublic == true) { - try { - // run the graph QL mutation +Future\ onTapJoin() async \{ + if `selectedOrganization` is public. + if (selectedOrganization.isPublic == true) \{ + try \{ + run the graph QL mutation final QueryResult result = await databaseFunctions.gqlAuthMutation( queries.joinOrgById(selectedOrganization.id!), ) as QueryResult; - final List? joinedOrg = + final List\? joinedOrg = ((result.data!['joinPublicOrganization'] - as Map)['joinedOrganizations'] - as List?) - ?.map((e) => OrgInfo.fromJson(e as Map)) + as Map\)['joinedOrganizations'] + as List\?) + ?.map((e) =\> OrgInfo.fromJson(e as Map\)) .toList(); userConfig.updateUserJoinedOrg(joinedOrg!); - // if user joined organization length is 1 - if (userConfig.currentUser.joinedOrganizations!.length == 1) { + if user joined organization length is 1 + if (userConfig.currentUser.joinedOrganizations!.length == 1) \{ userConfig.saveCurrentOrgInHive( userConfig.currentUser.joinedOrganizations![0], ); @@ -51,33 +51,33 @@ Future onTapJoin() async { Routes.splashScreen, arguments: MainScreenArgs(mainScreenIndex: 0), ); - } else { + \} else \{ navigationService.pop(); navigationService.showTalawaErrorSnackBar( - 'Joined ${selectedOrganization.name} successfully', + 'Joined $\{selectedOrganization.name\} successfully', MessageType.info, ); - } - } on Exception catch (e) { + \} + \} on Exception catch (e) \{ print(e); navigationService.showTalawaErrorSnackBar( 'SomeThing went wrong', MessageType.error, ); - } - } - // else { - // try { - // // navigationService.pushScreen(Routes.requestAccess); - // } on Exception catch (e) { - // print(e); - // navigationService.showTalawaErrorSnackBar( - // 'SomeThing went wrong', - // MessageType.error, - // ); - // } - // } -} + \} + \} + else \{ + try \{ + navigationService.pushScreen(Routes.requestAccess); + \} on Exception catch (e) \{ + print(e); + navigationService.showTalawaErrorSnackBar( + 'SomeThing went wrong', + MessageType.error, + ); + \} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/orgId.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/orgId.md index 8401c3532ac..5c5f8cccfb5 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/orgId.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/orgId.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) orgId -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/organizations.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/organizations.md index d267d675bd7..84e4a7f0815 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/organizations.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/organizations.md @@ -9,9 +9,9 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)> organizations +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)\> organizations -_read / write_ +_\read / write\_ @@ -21,7 +21,7 @@ _read / write_ ## Implementation ```dart -late List organizations = []; +late List\ organizations = []; ``` diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/qrKey.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/qrKey.md index 1106a10ec04..2d1f73d97b9 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/qrKey.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/qrKey.md @@ -9,9 +9,9 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> qrKey +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> qrKey -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/result.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/result.md index 9e5c1d6a2b1..801eb25e2e9 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/result.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/result.md @@ -9,9 +9,9 @@ -[Barcode](https://pub.dev/documentation/qr_code_scanner/1.0.1/qr_code_scanner/Barcode-class.html) result +[Barcode](https:pub.dev/documentation/qr_code_scanner/1.0.1/qr_code_scanner/Barcode-class.html) result -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchActive.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchActive.md index da4b165c2d9..ae424f67411 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchActive.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchActive.md @@ -23,13 +23,13 @@ void searchActive ## Implementation ```dart -void searchActive() { - if (searchFocus.hasFocus) { +void searchActive() \{ + if (searchFocus.hasFocus) \{ organizations = []; searching = true; setState(ViewState.idle); - } -} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchController.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchController.md index 5f278031af1..b09bccca3b5 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchController.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchController.md @@ -9,9 +9,9 @@ -[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) searchController +[TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) searchController -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchFocus.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchFocus.md index a2cadd52566..5bffb1b1c54 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchFocus.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchFocus.md @@ -9,9 +9,9 @@ -[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) searchFocus +[FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) searchFocus -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searching.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searching.md index 427df2c30fa..75f2a579eaa 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searching.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searching.md @@ -9,9 +9,9 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) searching +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) searching -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/selectOrg.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/selectOrg.md index 6a6ccd37b0f..baee044062a 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/selectOrg.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/selectOrg.md @@ -10,77 +10,77 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> selectOrg +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> selectOrg ([OrgInfo](../../models_organization_org_info/OrgInfo-class.md) item) -

This function select the organization.

-

params:

-
    -
  • item : Selected organization data.
  • -
+\This function select the organization.\ +\params:\ +\ +\\item\ : Selected organization data.\ +\ ## Implementation ```dart -Future selectOrg(OrgInfo item) async { +Future\ selectOrg(OrgInfo item) async \{ print(item.id); bool orgAlreadyJoined = false; bool orgRequestAlreadyPresent = false; final bool userLoggedIn = await userConfig.userLoggedIn(); - // if user session not expirec - if (userLoggedIn) { - // check if user has already joined the selected organization. - userConfig.currentUser.joinedOrganizations!.forEach((element) { - if (element.id! == item.id) { + if user session not expirec + if (userLoggedIn) \{ + check if user has already joined the selected organization. + userConfig.currentUser.joinedOrganizations!.forEach((element) \{ + if (element.id! == item.id) \{ orgAlreadyJoined = true; - } - }); - // check if user has already send the membership request to the selected organization. - userConfig.currentUser.membershipRequests!.forEach((element) { - if (element.id! == item.id) { + \} + \}); + check if user has already send the membership request to the selected organization. + userConfig.currentUser.membershipRequests!.forEach((element) \{ + if (element.id! == item.id) \{ orgRequestAlreadyPresent = true; - } - }); - // if not already joined and not memebrship request. - if (!orgAlreadyJoined && !orgRequestAlreadyPresent) { + \} + \}); + if not already joined and not memebrship request. + if (!orgAlreadyJoined && !orgRequestAlreadyPresent) \{ selectedOrganization = item; notifyListeners(); onTapJoin(); - // print(selectedOrganization.isPublic); + print(selectedOrganization.isPublic); - if (!selectedOrganization.isPublic!) { + if (!selectedOrganization.isPublic!) \{ navigationService.pushScreen( Routes.requestAccess, arguments: selectedOrganization, ); - } - } else if (orgAlreadyJoined) { + \} + \} else if (orgAlreadyJoined) \{ selectedOrganization = OrgInfo(id: '-1'); navigationService.showTalawaErrorSnackBar( 'Organisation already joined', MessageType.warning, ); - } else { + \} else \{ navigationService.showTalawaErrorSnackBar( 'Membership request already sent', MessageType.warning, ); - } - } else { + \} + \} else \{ selectedOrganization = item; notifyListeners(); navigationService.pushScreen( Routes.signupDetailScreen, arguments: selectedOrganization, ); - } -} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/selectedOrganization.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/selectedOrganization.md index 1c7a65ca8a9..120b783f224 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/selectedOrganization.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/selectedOrganization.md @@ -11,7 +11,7 @@ [OrgInfo](../../models_organization_org_info/OrgInfo-class.md) selectedOrganization -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/showSearchOrgList.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/showSearchOrgList.md index c8c83bdd4d3..d2364111180 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/showSearchOrgList.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/showSearchOrgList.md @@ -9,9 +9,9 @@ -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) showSearchOrgList +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) showSearchOrgList -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel-class.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel-class.md index eea1cc27f43..6077f80aaf4 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel-class.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel-class.md @@ -11,25 +11,25 @@ -

SetUrlViewModel class helps to interact with model to serve data.

-

and react to user's input for Set Url Section. -Methods include:

-
    -
  • checkURLandNavigate
  • -
  • scanQR
  • -
  • initialise
  • -
  • checkURLandNavigate
  • -
  • checkURLandShowPopUp
  • -
  • scanQR
  • -
  • _onQRViewCreated
  • -
+\SetUrlViewModel class helps to interact with model to serve data.\ +\and react to user's input for Set Url Section. +Methods include:\ +\ +\\checkURLandNavigate\\ +\\scanQR\\ +\\initialise\\ +\\checkURLandNavigate\\ +\\checkURLandShowPopUp\\ +\\scanQR\\ +\\_onQRViewCreated\\ +\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) - [BaseModel](../view_model_base_view_model/BaseModel-class.md) - SetUrlViewModel @@ -49,84 +49,84 @@ Methods include:

## Properties -##### [formKey](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/formKey.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[FormState](https://api.flutter.dev/flutter/widgets/FormState-class.html)> +##### [formKey](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/formKey.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[FormState](https:api.flutter.dev/flutter/widgets/FormState-class.html)\> formKey. -_final_ +_\final\_ -##### [greeting](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/greeting.md) ↔ [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic>> +##### [greeting](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/greeting.md) ↔ [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> qrController. -_read / write_ +_\read / write\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hasListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hasListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether any listeners are currently registered. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [orgId](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/orgId.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [orgId](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/orgId.md) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html) organizationID. -_read / write_ +_\read / write\_ -##### [qrKey](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/qrKey.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> +##### [qrKey](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/qrKey.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> qrKey. -_final_ +_\final\_ -##### [result](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/result.md) ↔ [Barcode](https://pub.dev/documentation/qr_code_scanner/1.0.1/qr_code_scanner/Barcode-class.html) +##### [result](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/result.md) ↔ [Barcode](https:pub.dev/documentation/qr_code_scanner/1.0.1/qr_code_scanner/Barcode-class.html) qrText. -_read / write_ +_\read / write\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -135,34 +135,34 @@ _read-onlyinherited_ -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [url](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/url.md) ↔ [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) +##### [url](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/url.md) ↔ [TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) url. -_read / write_ +_\read / write\_ -##### [urlFocus](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/urlFocus.md) ↔ [FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) +##### [urlFocus](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/urlFocus.md) ↔ [FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) urlFocus. -_read / write_ +_\read / write\_ -##### [validate](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/validate.md) ↔ [AutovalidateMode](https://api.flutter.dev/flutter/widgets/AutovalidateMode.html) +##### [validate](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/validate.md) ↔ [AutovalidateMode](https:api.flutter.dev/flutter/widgets/AutovalidateMode.html) qrValidator. -_read / write_ +_\read / write\_ @@ -170,16 +170,16 @@ _read / write_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be called when the object changes. -_inherited_ +_\inherited\_ -##### [checkURLandNavigate](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/checkURLandNavigate.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) navigateTo, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) argument) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [checkURLandNavigate](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/checkURLandNavigate.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) navigateTo, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) argument) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -188,7 +188,7 @@ This function check the URL and navigate to the respective URL. -##### [checkURLandShowPopUp](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/checkURLandShowPopUp.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) argument) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [checkURLandShowPopUp](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/checkURLandShowPopUp.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) argument) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -197,18 +197,18 @@ This function check the URL and navigate to the respective URL. -##### [dispose](https://api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void +##### [dispose](https:api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -
addListener will throw after the object is disposed). -_inherited_ +\addListener\ will throw after the object is disposed). +_\inherited\_ -##### [initialise](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/initialise.md)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) inviteUrl = ''}) void +##### [initialise](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/initialise.md)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) inviteUrl = ''\}) void @@ -217,35 +217,35 @@ This function initialises the variables. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void +##### [notifyListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void Call all the registered listeners. -_inherited_ +_\inherited\_ -##### [removeListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that are notified when the object changes. -_inherited_ +_\inherited\_ -##### [scanQR](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/scanQR.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) void +##### [scanQR](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/scanQR.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) void @@ -259,16 +259,16 @@ This function create a widget which is used to scan the QR-code. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -276,12 +276,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ @@ -294,7 +294,7 @@ _inherited_ ## Constants -##### [imageUrlKey](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/imageUrlKey-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [imageUrlKey](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/imageUrlKey-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) @@ -303,7 +303,7 @@ imageUrlKey. -##### [urlKey](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/urlKey-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [urlKey](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/urlKey-constant.md) const [String](https:api.flutter.dev/flutter/dart-core/String-class.html) diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/checkURLandNavigate.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/checkURLandNavigate.md index 3d400b25762..6583ee47d9a 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/checkURLandNavigate.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/checkURLandNavigate.md @@ -10,42 +10,42 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> checkURLandNavigate -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) navigateTo, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) argument) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> checkURLandNavigate +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) navigateTo, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) argument) -

This function check the URL and navigate to the respective URL.

-

params:

-
    -
  • navigateTo: url
  • -
  • argument: message
  • -
-

returns:

-
    -
  • Future<void>: void
  • -
+\This function check the URL and navigate to the respective URL.\ +\\params\:\ +\ +\\navigateTo\: url\ +\\argument\: message\ +\ +\\returns\:\ +\ +\\Future<void>\: void\ +\ ## Implementation ```dart -Future checkURLandNavigate(String navigateTo, String argument) async { +Future\ checkURLandNavigate(String navigateTo, String argument) async \{ urlFocus.unfocus(); validate = AutovalidateMode.always; - /// if the url is valid. - if (formKey.currentState!.validate()) { + if the url is valid. + if (formKey.currentState!.validate()) \{ navigationService .pushDialog(const CustomProgressDialog(key: Key('UrlCheckProgress'))); validate = AutovalidateMode.disabled; final String uri = url.text.trim(); final bool? urlPresent = - await locator().validateUrlExistence(uri); - if (urlPresent! == true) { + await locator\().validateUrlExistence(uri); + if (urlPresent! == true) \{ final box = Hive.box('url'); box.put(urlKey, uri); box.put(imageUrlKey, "$uri/talawa/"); @@ -53,15 +53,15 @@ Future checkURLandNavigate(String navigateTo, String argument) async { navigationService.pop(); graphqlConfig.getOrgUrl(); navigationService.pushScreen(navigateTo, arguments: argument); - } else { + \} else \{ navigationService.pop(); navigationService.showTalawaErrorSnackBar( "URL doesn't exist/no connection please check", MessageType.error, ); - } - } -} + \} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/checkURLandShowPopUp.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/checkURLandShowPopUp.md index bdfe2ca4610..6e638be3424 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/checkURLandShowPopUp.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/checkURLandShowPopUp.md @@ -10,34 +10,34 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> checkURLandShowPopUp -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) argument) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> checkURLandShowPopUp +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) argument) -

This function check the URL and navigate to the respective URL.

-

params:

-
    -
  • argument: message
  • -
-

returns:

-
    -
  • Future<void>: sdf
  • -
+\This function check the URL and navigate to the respective URL.\ +\\params\:\ +\ +\\argument\: message\ +\ +\\returns\:\ +\ +\\Future<void>\: sdf\ +\ ## Implementation ```dart -Future checkURLandShowPopUp(String argument) async { +Future\ checkURLandShowPopUp(String argument) async \{ urlFocus.unfocus(); validate = AutovalidateMode.always; - // if the url is valid. - if (formKey.currentState!.validate()) { + if the url is valid. + if (formKey.currentState!.validate()) \{ navigationService.pushDialog( const CustomProgressDialog( key: Key('UrlCheckProgress'), @@ -46,23 +46,23 @@ Future checkURLandShowPopUp(String argument) async { validate = AutovalidateMode.disabled; final String uri = url.text.trim(); final bool? urlPresent = - await locator().validateUrlExistence(uri); - if (urlPresent! == true) { + await locator\().validateUrlExistence(uri); + if (urlPresent! == true) \{ final box = Hive.box('url'); box.put(urlKey, uri); box.put(imageUrlKey, "$uri/talawa/"); navigationService.pop(); graphqlConfig.getOrgUrl(); navigationService.showSnackBar("Url is valid"); - } else { + \} else \{ navigationService.pop(); navigationService.showTalawaErrorDialog( "URL doesn't exist/no connection please check", MessageType.info, ); - } - } -} + \} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/formKey.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/formKey.md index dc694cea695..21dc0b8a71e 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/formKey.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/formKey.md @@ -9,20 +9,20 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[FormState](https://api.flutter.dev/flutter/widgets/FormState-class.html)> formKey +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[FormState](https:api.flutter.dev/flutter/widgets/FormState-class.html)\> formKey -_final_ +_\final\_ -

formKey.

+\formKey.\ ## Implementation ```dart -final formKey = GlobalKey(); +final formKey = GlobalKey\(); ``` diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/greeting.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/greeting.md index 3c142332fdb..6e7eac812ca 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/greeting.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/greeting.md @@ -9,20 +9,20 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic>> greeting +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> greeting -_read / write_ +_\read / write\_ -

qrController.

+\qrController.\ ## Implementation ```dart -late List> greeting; +late List\\> greeting; ``` diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/imageUrlKey-constant.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/imageUrlKey-constant.md index 6c8a4090ae4..09dd551ae10 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/imageUrlKey-constant.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/imageUrlKey-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const imageUrlKey +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const imageUrlKey -

imageUrlKey.

+\imageUrlKey.\ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/initialise.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/initialise.md index 828addb8fa7..b055171349d 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/initialise.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/initialise.md @@ -11,74 +11,74 @@ void initialise -({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) inviteUrl = ''}) +(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) inviteUrl = ''\}) -

This function initialises the variables.

-

params:

-
    -
  • inviteUrl: url
  • -
-

returns: - None

+\This function initialises the variables.\ +\\params\:\ +\ +\\inviteUrl\: url\ +\ +\\returns\: + None\ ## Implementation ```dart -void initialise({String inviteUrl = ''}) { +void initialise(\{String inviteUrl = ''\}) \{ final uri = inviteUrl; - if (uri.isNotEmpty) { - /// assigning the invite server url to the url text controller. + if (uri.isNotEmpty) \{ + assigning the invite server url to the url text controller. url.text = uri; final box = Hive.box('url'); box.put(urlKey, uri); box.put(imageUrlKey, "$uri/talawa/"); graphqlConfig.getOrgUrl(); - } + \} - /// greeting message. + greeting message. greeting = [ - { + \{ 'text': 'Join ', 'textStyle': Theme.of(navigationService.navigatorKey.currentContext!) .textTheme .titleLarge! .copyWith(fontSize: 24, fontWeight: FontWeight.w700) - }, - { + \}, + \{ 'text': 'and ', 'textStyle': Theme.of(navigationService.navigatorKey.currentContext!) .textTheme .headlineSmall - }, - { + \}, + \{ 'text': 'Collaborate ', 'textStyle': Theme.of(navigationService.navigatorKey.currentContext!) .textTheme .titleLarge! .copyWith(fontSize: 24, fontWeight: FontWeight.w700) - }, - { + \}, + \{ 'text': 'with your ', 'textStyle': Theme.of(navigationService.navigatorKey.currentContext!) .textTheme .headlineSmall - }, - { + \}, + \{ 'text': 'Organizations', 'textStyle': Theme.of(navigationService.navigatorKey.currentContext!) .textTheme .headlineSmall! .copyWith(fontSize: 24, color: const Color(0xFF4285F4)) - }, + \}, ]; notifyListeners(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/orgId.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/orgId.md index 0dd4df4332a..734b62f3bd2 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/orgId.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/orgId.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) orgId -_read / write_ +_\read / write\_ -

organizationID.

+\organizationID.\ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/qrKey.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/qrKey.md index 911a3ddbb5a..697f2b2f77f 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/qrKey.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/qrKey.md @@ -9,13 +9,13 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)>> qrKey +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html)\>\> qrKey -_final_ +_\final\_ -

qrKey.

+\qrKey.\ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/result.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/result.md index e23ab60614d..62a28d40dd4 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/result.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/result.md @@ -9,13 +9,13 @@ -[Barcode](https://pub.dev/documentation/qr_code_scanner/1.0.1/qr_code_scanner/Barcode-class.html) result +[Barcode](https:pub.dev/documentation/qr_code_scanner/1.0.1/qr_code_scanner/Barcode-class.html) result -_read / write_ +_\read / write\_ -

qrText.

+\qrText.\ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/scanQR.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/scanQR.md index ead578be170..f1820dd6c3a 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/scanQR.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/scanQR.md @@ -11,26 +11,26 @@ void scanQR -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -

This function create a widget which is used to scan the QR-code.

-

params:

-
    -
  • context: BuildContext
  • -
-

returns: - None

+\This function create a widget which is used to scan the QR-code.\ +\\params\:\ +\ +\\context\: BuildContext\ +\ +\\returns\: + None\ ## Implementation ```dart -void scanQR(BuildContext context) { +void scanQR(BuildContext context) \{ showModalBottomSheet( context: context, barrierColor: Colors.transparent, @@ -40,7 +40,7 @@ void scanQR(BuildContext context) { topRight: Radius.circular(30), ), ), - builder: (BuildContext context) { + builder: (BuildContext context) \{ return ClipRRect( borderRadius: const BorderRadius.only( topLeft: Radius.circular(30), @@ -80,9 +80,9 @@ void scanQR(BuildContext context) { ), ), ); - }, + \}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/url.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/url.md index 2f3e57fc87f..dfe7a82e769 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/url.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/url.md @@ -9,13 +9,13 @@ -[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) url +[TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) url -_read / write_ +_\read / write\_ -

url.

+\url.\ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/urlFocus.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/urlFocus.md index bc8e159cf7e..2009c7ec390 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/urlFocus.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/urlFocus.md @@ -9,13 +9,13 @@ -[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) urlFocus +[FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) urlFocus -_read / write_ +_\read / write\_ -

urlFocus.

+\urlFocus.\ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/urlKey-constant.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/urlKey-constant.md index 3e462eee9d2..099b11fa5a2 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/urlKey-constant.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/urlKey-constant.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const urlKey +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) const urlKey -

urlKey.

+\urlKey.\ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/validate.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/validate.md index 4c75388901b..cbdace511ba 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/validate.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/validate.md @@ -9,13 +9,13 @@ -[AutovalidateMode](https://api.flutter.dev/flutter/widgets/AutovalidateMode.html) validate +[AutovalidateMode](https:api.flutter.dev/flutter/widgets/AutovalidateMode.html) validate -_read / write_ +_\read / write\_ -

qrValidator.

+\qrValidator.\ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel-class.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel-class.md index 68a80ada53d..2e5892add64 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel-class.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel-class.md @@ -11,19 +11,19 @@ -

SignupDetailsViewModel class helps to interact with model to serve data -and react to user's input for Sign Up Details section.

-

Methods include:

-
    -
  • signUp
  • -
+\SignupDetailsViewModel class helps to interact with model to serve data +and react to user's input for Sign Up Details section.\ +\Methods include:\ +\ +\\signUp\\ +\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) - [BaseModel](../view_model_base_view_model/BaseModel-class.md) - SignupDetailsViewModel @@ -43,120 +43,120 @@ and react to user's input for Sign Up Details section.

## Properties -##### [confirmFocus](../view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/confirmFocus.md) ↔ [FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) +##### [confirmFocus](../view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/confirmFocus.md) ↔ [FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) -_read / write_ +_\read / write\_ -##### [confirmPassword](../view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/confirmPassword.md) ↔ [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) +##### [confirmPassword](../view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/confirmPassword.md) ↔ [TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) -_read / write_ +_\read / write\_ -##### [email](../view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/email.md) ↔ [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) +##### [email](../view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/email.md) ↔ [TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) -_read / write_ +_\read / write\_ -##### [firstName](../view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/firstName.md) ↔ [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) +##### [firstName](../view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/firstName.md) ↔ [TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) -_read / write_ +_\read / write\_ -##### [formKey](../view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/formKey.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[FormState](https://api.flutter.dev/flutter/widgets/FormState-class.html)> +##### [formKey](../view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/formKey.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[FormState](https:api.flutter.dev/flutter/widgets/FormState-class.html)\> -_final_ +_\final\_ -##### [greeting](../view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/greeting.md) ↔ [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic>> +##### [greeting](../view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/greeting.md) ↔ [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> -_read / write_ +_\read / write\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hasListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hasListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether any listeners are currently registered. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hidePassword](../view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/hidePassword.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hidePassword](../view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/hidePassword.md) ↔ [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read / write_ +_\read / write\_ -##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [lastName](../view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/lastName.md) ↔ [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) +##### [lastName](../view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/lastName.md) ↔ [TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) -_read / write_ +_\read / write\_ -##### [password](../view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/password.md) ↔ [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) +##### [password](../view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/password.md) ↔ [TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) -_read / write_ +_\read / write\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -165,7 +165,7 @@ _read-onlyinherited_ -_read / write_ +_\read / write\_ @@ -174,16 +174,16 @@ _read / write_ -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [validate](../view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/validate.md) ↔ [AutovalidateMode](https://api.flutter.dev/flutter/widgets/AutovalidateMode.html) +##### [validate](../view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/validate.md) ↔ [AutovalidateMode](https:api.flutter.dev/flutter/widgets/AutovalidateMode.html) -_read / write_ +_\read / write\_ @@ -191,23 +191,23 @@ _read / write_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be called when the object changes. -_inherited_ +_\inherited\_ -##### [dispose](https://api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void +##### [dispose](https:api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -
addListener will throw after the object is disposed). -_inherited_ +\addListener\ will throw after the object is disposed). +_\inherited\_ @@ -220,31 +220,31 @@ _inherited_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void +##### [notifyListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void Call all the registered listeners. -_inherited_ +_\inherited\_ -##### [removeListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that are notified when the object changes. -_inherited_ +_\inherited\_ @@ -253,26 +253,26 @@ _inherited_ -_inherited_ +_\inherited\_ -##### [signUp](../view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/signUp.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [signUp](../view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/signUp.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> This function is used to sign up the user into the application by passing the data to database query. -The function uses gqlNonAuthMutation method provided by databaseFunctions services. +The function uses \gqlNonAuthMutation\ method provided by \databaseFunctions\ services. -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -280,12 +280,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/confirmFocus.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/confirmFocus.md index 66b9c41cbff..b82659f44d6 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/confirmFocus.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/confirmFocus.md @@ -9,9 +9,9 @@ -[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) confirmFocus +[FocusNode](https:api.flutter.dev/flutter/widgets/FocusNode-class.html) confirmFocus -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/confirmPassword.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/confirmPassword.md index be24345f1f8..0e3d7890979 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/confirmPassword.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/confirmPassword.md @@ -9,9 +9,9 @@ -[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) confirmPassword +[TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) confirmPassword -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/email.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/email.md index 8fc948122f5..d33030efd93 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/email.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/email.md @@ -9,9 +9,9 @@ -[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) email +[TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) email -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/firstName.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/firstName.md index 05e3d39ab14..ea324582c43 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/firstName.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/firstName.md @@ -9,9 +9,9 @@ -[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) firstName +[TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) firstName -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/formKey.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/formKey.md index d7de0e859ad..b2f0242bc8f 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/formKey.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/formKey.md @@ -9,9 +9,9 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[FormState](https://api.flutter.dev/flutter/widgets/FormState-class.html)> formKey +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[FormState](https:api.flutter.dev/flutter/widgets/FormState-class.html)\> formKey -_final_ +_\final\_ @@ -21,7 +21,7 @@ _final_ ## Implementation ```dart -final formKey = GlobalKey(); +final formKey = GlobalKey\(); ``` diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/greeting.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/greeting.md index de486919b3f..d8389804b58 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/greeting.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/greeting.md @@ -9,9 +9,9 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic>> greeting +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> greeting -_read / write_ +_\read / write\_ @@ -21,7 +21,7 @@ _read / write_ ## Implementation ```dart -late List> greeting; +late List\\> greeting; ``` diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/hidePassword.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/hidePassword.md index bd2ce20b961..c26d7bdd115 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/hidePassword.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/hidePassword.md @@ -9,9 +9,9 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) hidePassword +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) hidePassword -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/initialise.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/initialise.md index eb0ac9473e8..28448ce1a04 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/initialise.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/initialise.md @@ -23,37 +23,37 @@ void initialise ## Implementation ```dart -void initialise(OrgInfo org) { +void initialise(OrgInfo org) \{ selectedOrganization = org; - // greeting message + greeting message greeting = [ - { + \{ 'text': "Let's ", 'textStyle': Theme.of(navigationService.navigatorKey.currentContext!) .textTheme .headlineSmall - }, - { + \}, + \{ 'text': 'get ', 'textStyle': Theme.of(navigationService.navigatorKey.currentContext!) .textTheme .headlineSmall - }, - { + \}, + \{ 'text': "you ", 'textStyle': Theme.of(navigationService.navigatorKey.currentContext!) .textTheme .headlineSmall - }, - { + \}, + \{ 'text': 'SignUp ', 'textStyle': Theme.of(navigationService.navigatorKey.currentContext!) .textTheme .titleLarge! .copyWith(fontSize: 24) - }, + \}, ]; -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/lastName.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/lastName.md index 7f599f4922c..eb822742c62 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/lastName.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/lastName.md @@ -9,9 +9,9 @@ -[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) lastName +[TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) lastName -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/password.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/password.md index b344a9fede7..31497c1146a 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/password.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/password.md @@ -9,9 +9,9 @@ -[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) password +[TextEditingController](https:api.flutter.dev/flutter/widgets/TextEditingController-class.html) password -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/selectedOrganization.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/selectedOrganization.md index 627e15c4da0..30a1714f4be 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/selectedOrganization.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/selectedOrganization.md @@ -11,7 +11,7 @@ [OrgInfo](../../models_organization_org_info/OrgInfo-class.md) selectedOrganization -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/signUp.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/signUp.md index a21b802c3b8..2099c3cbd64 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/signUp.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/signUp.md @@ -10,32 +10,32 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> signUp +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> signUp () -

This function is used to sign up the user into the application by passing the data to database query. -The function uses gqlNonAuthMutation method provided by databaseFunctions services.

+\This function is used to sign up the user into the application by passing the data to database query. +The function uses \gqlNonAuthMutation\ method provided by \databaseFunctions\ services.\ ## Implementation ```dart -Future signUp() async { +Future\ signUp() async \{ FocusScope.of(navigationService.navigatorKey.currentContext!).unfocus(); setState(ViewState.busy); validate = AutovalidateMode.always; setState(ViewState.idle); - if (formKey.currentState!.validate()) { + if (formKey.currentState!.validate()) \{ validate = AutovalidateMode.disabled; navigationService .pushDialog(const CustomProgressDialog(key: Key('SignUpProgress'))); databaseFunctions.init(); - try { + try \{ final result = await databaseFunctions.gqlNonAuthMutation( queries.registerUser( firstName.text, @@ -45,25 +45,25 @@ Future signUp() async { ), ); navigationService.pop(); - if (result != null) { + if (result != null) \{ final User signedInUser = - User.fromJson(result.data!['signUp'] as Map); + User.fromJson(result.data!['signUp'] as Map\); final bool userSaved = await userConfig.updateUser(signedInUser); final bool tokenRefreshed = await graphqlConfig.getToken() as bool; - // if user successfully saved and access token is also generated. - if (userSaved && tokenRefreshed) { - // if the selected organization is public. - if (selectedOrganization.isPublic!) { - try { + if user successfully saved and access token is also generated. + if (userSaved && tokenRefreshed) \{ + if the selected organization is public. + if (selectedOrganization.isPublic!) \{ + try \{ final QueryResult result = await databaseFunctions.gqlAuthMutation( queries.joinOrgById(selectedOrganization.id!), ) as QueryResult; - final List? joinedOrg = (result + final List\? joinedOrg = (result .data!['joinPublicOrganization'] - ['joinedOrganizations'] as List?) - ?.map((e) => OrgInfo.fromJson(e as Map)) + ['joinedOrganizations'] as List\?) + ?.map((e) =\> OrgInfo.fromJson(e as Map\)) .toList(); userConfig.updateUserJoinedOrg(joinedOrg!); userConfig.saveCurrentOrgInHive( @@ -75,15 +75,15 @@ Future signUp() async { arguments: MainScreenArgs(mainScreenIndex: 0, fromSignUp: true), ); - } on Exception catch (e) { + \} on Exception catch (e) \{ print(e); navigationService.showTalawaErrorSnackBar( 'SomeThing went wrong', MessageType.error, ); - } - } else { - try { + \} + \} else \{ + try \{ final QueryResult result = await databaseFunctions.gqlAuthMutation( queries.sendMembershipRequest(selectedOrganization.id!), @@ -91,7 +91,7 @@ Future signUp() async { final OrgInfo membershipRequest = OrgInfo.fromJson( result.data!['sendMembershipRequest']['organization'] - as Map, + as Map\, ); userConfig.updateUserMemberRequestOrg([membershipRequest]); navigationService.pop(); @@ -99,25 +99,25 @@ Future signUp() async { Routes.waitingScreen, Routes.splashScreen, ); - } on Exception catch (e) { + \} on Exception catch (e) \{ print(e); navigationService.showTalawaErrorSnackBar( 'SomeThing went wrong', MessageType.error, ); - } - } - } - } - } on Exception catch (e) { + \} + \} + \} + \} + \} on Exception catch (e) \{ print(e); navigationService.showTalawaErrorSnackBar( 'SomeThing went wrong', MessageType.error, ); - } - } -} + \} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/validate.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/validate.md index 7dd63a4d447..2abd528167e 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/validate.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/validate.md @@ -9,9 +9,9 @@ -[AutovalidateMode](https://api.flutter.dev/flutter/widgets/AutovalidateMode.html) validate +[AutovalidateMode](https:api.flutter.dev/flutter/widgets/AutovalidateMode.html) validate -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel-class.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel-class.md index 71a25decac3..dba3c02c257 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel-class.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel-class.md @@ -11,19 +11,19 @@ -

WaitingViewModel class helps to interact with model to serve data -and react to user's input for Waiting section.

-

Methods include:

-
    -
  • logout
  • -
+\WaitingViewModel class helps to interact with model to serve data +and react to user's input for Waiting section.\ +\Methods include:\ +\ +\\logout\\ +\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) - [BaseModel](../view_model_base_view_model/BaseModel-class.md) - WaitingViewModel @@ -48,61 +48,61 @@ and react to user's input for Waiting section.

-_read / write_ +_\read / write\_ -##### [greeting](../view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/greeting.md) ↔ [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic>> +##### [greeting](../view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/greeting.md) ↔ [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> -_read / write_ +_\read / write\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hasListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hasListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether any listeners are currently registered. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [pendingRequestOrg](../view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/pendingRequestOrg.md) ↔ [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)> +##### [pendingRequestOrg](../view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/pendingRequestOrg.md) ↔ [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)\> -_read / write_ +_\read / write\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -111,7 +111,7 @@ _read-onlyinherited_ -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -119,27 +119,27 @@ _read-onlyinherited_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be called when the object changes. -_inherited_ +_\inherited\_ -##### [dispose](https://api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void +##### [dispose](https:api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -
addListener will throw after the object is disposed). -_inherited_ +\addListener\ will throw after the object is disposed). +_\inherited\_ -##### [initialise](../view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/initialise.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) void +##### [initialise](../view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/initialise.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) void @@ -166,31 +166,31 @@ This function ends the session for the user or logout the user from the applicat -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void +##### [notifyListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void Call all the registered listeners. -_inherited_ +_\inherited\_ -##### [removeListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that are notified when the object changes. -_inherited_ +_\inherited\_ @@ -199,16 +199,16 @@ _inherited_ -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -216,12 +216,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/currentUser.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/currentUser.md index e955d406240..58980d18f65 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/currentUser.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/currentUser.md @@ -11,7 +11,7 @@ [User](../../models_user_user_info/User-class.md) currentUser -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/greeting.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/greeting.md index de486919b3f..d8389804b58 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/greeting.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/greeting.md @@ -9,9 +9,9 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic>> greeting +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> greeting -_read / write_ +_\read / write\_ @@ -21,7 +21,7 @@ _read / write_ ## Implementation ```dart -late List> greeting; +late List\\> greeting; ``` diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/initialise.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/initialise.md index 7dce45b3416..7297a776681 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/initialise.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/initialise.md @@ -11,7 +11,7 @@ void initialise -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) @@ -23,26 +23,26 @@ void initialise ## Implementation ```dart -void initialise(BuildContext context) { +void initialise(BuildContext context) \{ currentUser = userConfig.currentUser; pendingRequestOrg = currentUser.membershipRequests!; - // greetings + greetings greeting = [ - { + \{ 'text': "Please wait", 'textStyle': Theme.of(context).textTheme.headlineSmall - }, - { - 'text': " ${currentUser.firstName} ", + \}, + \{ + 'text': " $\{currentUser.firstName\} ", 'textStyle': Theme.of(context).textTheme.titleLarge!.copyWith(fontSize: 24) - }, - { + \}, + \{ 'text': "for organisation(s) to accept your invitation.", 'textStyle': Theme.of(context).textTheme.headlineSmall - }, + \}, ]; -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/joinOrg.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/joinOrg.md index 428ddfc2979..9f417ee9816 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/joinOrg.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/joinOrg.md @@ -23,9 +23,9 @@ void joinOrg ## Implementation ```dart -void joinOrg() { +void joinOrg() \{ navigationService.pushScreen(Routes.joinOrg, arguments: '-1'); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/logout.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/logout.md index 278a53c3ed2..c8b28832c17 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/logout.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/logout.md @@ -17,15 +17,15 @@ void logout -

This function ends the session for the user or logout the user from the application.

+\This function ends the session for the user or logout the user from the application.\ ## Implementation ```dart -void logout() { - final user = Hive.box('currentUser'); +void logout() \{ + final user = Hive.box\('currentUser'); final url = Hive.box('url'); user.clear(); url.clear(); @@ -34,7 +34,7 @@ void logout() { Routes.splashScreen, arguments: '0', ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/pendingRequestOrg.md b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/pendingRequestOrg.md index 9ca3922f29f..f1769ef9aac 100644 --- a/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/pendingRequestOrg.md +++ b/docs/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/pendingRequestOrg.md @@ -9,9 +9,9 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)> pendingRequestOrg +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)\> pendingRequestOrg -_read / write_ +_\read / write\_ @@ -21,7 +21,7 @@ _read / write_ ## Implementation ```dart -late List pendingRequestOrg; +late List\ pendingRequestOrg; ``` diff --git a/docs/talawa-mobile-docs/view_model_theme_view_model/AppTheme-class.md b/docs/talawa-mobile-docs/view_model_theme_view_model/AppTheme-class.md index 237c0f90f86..51ca21ec848 100644 --- a/docs/talawa-mobile-docs/view_model_theme_view_model/AppTheme-class.md +++ b/docs/talawa-mobile-docs/view_model_theme_view_model/AppTheme-class.md @@ -11,18 +11,18 @@ -

AppTheme class is a type of View Model to serve data from modal to views in the context of App Themes.

-

Methods include:

-
    -
  • switchTheme
  • -
+\AppTheme class is a type of View Model to serve data from modal to views in the context of App Themes.\ +\Methods include:\ +\ +\\switchTheme\\ +\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) - [BaseModel](../view_model_base_view_model/BaseModel-class.md) - AppTheme @@ -42,57 +42,57 @@ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hasListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hasListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether any listeners are currently registered. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isdarkTheme](../view_model_theme_view_model/AppTheme/isdarkTheme.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isdarkTheme](../view_model_theme_view_model/AppTheme/isdarkTheme.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-only_ +_\read-only\_ -##### [key](../view_model_theme_view_model/AppTheme/key.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [key](../view_model_theme_view_model/AppTheme/key.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -101,7 +101,7 @@ _read-onlyinherited_ -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -109,23 +109,23 @@ _read-onlyinherited_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be called when the object changes. -_inherited_ +_\inherited\_ -##### [dispose](https://api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void +##### [dispose](https:api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -
addListener will throw after the object is disposed). -_inherited_ +\addListener\ will throw after the object is disposed). +_\inherited\_ @@ -138,31 +138,31 @@ _inherited_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void +##### [notifyListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void Call all the registered listeners. -_inherited_ +_\inherited\_ -##### [removeListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that are notified when the object changes. -_inherited_ +_\inherited\_ @@ -171,11 +171,11 @@ _inherited_ -_inherited_ +_\inherited\_ -##### [switchTheme](../view_model_theme_view_model/AppTheme/switchTheme.md)({required [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isOn}) void +##### [switchTheme](../view_model_theme_view_model/AppTheme/switchTheme.md)(\{required [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isOn\}) void @@ -184,12 +184,12 @@ This function switches the app theme. -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -197,12 +197,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/view_model_theme_view_model/AppTheme/initialize.md b/docs/talawa-mobile-docs/view_model_theme_view_model/AppTheme/initialize.md index da8232bbd38..ab9f3c51fc6 100644 --- a/docs/talawa-mobile-docs/view_model_theme_view_model/AppTheme/initialize.md +++ b/docs/talawa-mobile-docs/view_model_theme_view_model/AppTheme/initialize.md @@ -23,10 +23,10 @@ void initialize ## Implementation ```dart -void initialize() { +void initialize() \{ _isDarkMode = true; _loadFromPrefs(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_theme_view_model/AppTheme/isdarkTheme.md b/docs/talawa-mobile-docs/view_model_theme_view_model/AppTheme/isdarkTheme.md index 4c2bac3ff54..81207a9e32b 100644 --- a/docs/talawa-mobile-docs/view_model_theme_view_model/AppTheme/isdarkTheme.md +++ b/docs/talawa-mobile-docs/view_model_theme_view_model/AppTheme/isdarkTheme.md @@ -11,7 +11,7 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isdarkTheme +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isdarkTheme @@ -23,7 +23,7 @@ ## Implementation ```dart -bool get isdarkTheme => _isDarkMode; +bool get isdarkTheme =\> _isDarkMode; ``` diff --git a/docs/talawa-mobile-docs/view_model_theme_view_model/AppTheme/key.md b/docs/talawa-mobile-docs/view_model_theme_view_model/AppTheme/key.md index ca431678204..b426072107f 100644 --- a/docs/talawa-mobile-docs/view_model_theme_view_model/AppTheme/key.md +++ b/docs/talawa-mobile-docs/view_model_theme_view_model/AppTheme/key.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) key +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) key -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/view_model_theme_view_model/AppTheme/switchTheme.md b/docs/talawa-mobile-docs/view_model_theme_view_model/AppTheme/switchTheme.md index 25663ba89b3..4b585d112ea 100644 --- a/docs/talawa-mobile-docs/view_model_theme_view_model/AppTheme/switchTheme.md +++ b/docs/talawa-mobile-docs/view_model_theme_view_model/AppTheme/switchTheme.md @@ -11,28 +11,28 @@ void switchTheme -({required [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isOn}) +(\{required [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isOn\}) -

This function switches the app theme.

-
    -
  • Dart -> Light
  • -
  • Light -> Dark
  • -
+\This function switches the app theme.\ +\ +\\Dart\ -> \Light\\ +\\Light\ -> \Dark\\ +\ ## Implementation ```dart -void switchTheme({required bool isOn}) { +void switchTheme(\{required bool isOn\}) \{ _isDarkMode = isOn; _saveToPrefs(); notifyListeners(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel-class.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel-class.md index 4e83dc40971..65938512d38 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel-class.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel-class.md @@ -11,20 +11,20 @@ -

CommentsViewModel class helps to serve the data from model -and to react to user's input for Comment Widget.

-

Methods include:

-
    -
  • getComments : to get all comments on the post.
  • -
  • createComment : to add comment on the post.
  • -
+\CommentsViewModel class helps to serve the data from model +and to react to user's input for Comment Widget.\ +\Methods include:\ +\ +\\getComments\ : to get all comments on the post.\ +\\createComment\ : to add comment on the post.\ +\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) - [BaseModel](../view_model_base_view_model/BaseModel-class.md) - CommentsViewModel @@ -44,57 +44,57 @@ and to react to user's input for Comment Widget.

## Properties -##### [commentList](../view_model_widgets_view_models_comments_view_model/CommentsViewModel/commentList.md) → [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Comment](../models_comment_comment_model/Comment-class.md)> +##### [commentList](../view_model_widgets_view_models_comments_view_model/CommentsViewModel/commentList.md) → [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Comment](../models_comment_comment_model/Comment-class.md)\> -_read-only_ +_\read-only\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hasListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hasListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether any listeners are currently registered. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [postId](../view_model_widgets_view_models_comments_view_model/CommentsViewModel/postId.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [postId](../view_model_widgets_view_models_comments_view_model/CommentsViewModel/postId.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_read-only_ +_\read-only\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -103,7 +103,7 @@ _read-onlyinherited_ -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -111,7 +111,7 @@ _read-onlyinherited_ ## Methods -##### [addCommentLocally](../view_model_widgets_view_models_comments_view_model/CommentsViewModel/addCommentLocally.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) msg) void +##### [addCommentLocally](../view_model_widgets_view_models_comments_view_model/CommentsViewModel/addCommentLocally.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) msg) void @@ -120,47 +120,47 @@ _read-onlyinherited_ -##### [addListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be called when the object changes. -_inherited_ +_\inherited\_ -##### [createComment](../view_model_widgets_view_models_comments_view_model/CommentsViewModel/createComment.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) msg) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) +##### [createComment](../view_model_widgets_view_models_comments_view_model/CommentsViewModel/createComment.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) msg) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) This function add comment on the post. -The function uses createComments method provided by Comment Service. +The function uses \createComments\ method provided by Comment Service. -##### [dispose](https://api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void +##### [dispose](https:api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -
addListener will throw after the object is disposed). -_inherited_ +\addListener\ will throw after the object is disposed). +_\inherited\_ -##### [getComments](../view_model_widgets_view_models_comments_view_model/CommentsViewModel/getComments.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) +##### [getComments](../view_model_widgets_view_models_comments_view_model/CommentsViewModel/getComments.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) This methods fetch all comments on the post. -The function uses getCommentsForPost method by Comment Service. +The function uses \getCommentsForPost\ method by Comment Service. -##### [initialise](../view_model_widgets_view_models_comments_view_model/CommentsViewModel/initialise.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) postID) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) +##### [initialise](../view_model_widgets_view_models_comments_view_model/CommentsViewModel/initialise.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) postID) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) @@ -169,31 +169,31 @@ The function uses getCommentsForPost method by Comment Service. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void +##### [notifyListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void Call all the registered listeners. -_inherited_ +_\inherited\_ -##### [removeListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that are notified when the object changes. -_inherited_ +_\inherited\_ @@ -202,16 +202,16 @@ _inherited_ -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -219,12 +219,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/addCommentLocally.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/addCommentLocally.md index 093423e4e21..24a763f8d74 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/addCommentLocally.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/addCommentLocally.md @@ -11,7 +11,7 @@ void addCommentLocally -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) msg) +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) msg) @@ -23,7 +23,7 @@ void addCommentLocally ## Implementation ```dart -void addCommentLocally(String msg) { +void addCommentLocally(String msg) \{ _postService.addCommentLocally(_postID); final creator = _userConfig.currentUser; final Comment localComment = Comment( @@ -33,7 +33,7 @@ void addCommentLocally(String msg) { ); _commentlist.insert(0, localComment); notifyListeners(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/commentList.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/commentList.md index 520c4d7315f..bbdec5594f8 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/commentList.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/commentList.md @@ -11,7 +11,7 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Comment](../../models_comment_comment_model/Comment-class.md)> commentList +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Comment](../../models_comment_comment_model/Comment-class.md)\> commentList @@ -23,7 +23,7 @@ ## Implementation ```dart -List get commentList => _commentlist; +List\ get commentList =\> _commentlist; ``` diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/createComment.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/createComment.md index 28f2ea742cc..079d1e42ea1 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/createComment.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/createComment.md @@ -10,30 +10,30 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) createComment -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) msg) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) createComment +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) msg) -

This function add comment on the post. -The function uses createComments method provided by Comment Service.

-

params:

-
    -
  • msg : text of the comment to add.
  • -
+\This function add comment on the post. +The function uses \createComments\ method provided by Comment Service.\ +\params:\ +\ +\\msg\ : text of the comment to add.\ +\ ## Implementation ```dart -Future createComment(String msg) async { +Future createComment(String msg) async \{ print("comment viewModel called"); await _commentService.createComments(_postID, msg); addCommentLocally(msg); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/getComments.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/getComments.md index 8969fdda410..fbc0020ee2d 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/getComments.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/getComments.md @@ -10,31 +10,31 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) getComments +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) getComments () -

This methods fetch all comments on the post. -The function uses getCommentsForPost method by Comment Service.

+\This methods fetch all comments on the post. +The function uses \getCommentsForPost\ method by Comment Service.\ ## Implementation ```dart -Future getComments() async { +Future getComments() async \{ setState(ViewState.busy); final List commentsJSON = await _commentService.getCommentsForPost(_postID) as List; print(commentsJSON); - commentsJSON.forEach((commentJson) { - _commentlist.add(Comment.fromJson(commentJson as Map)); - }); + commentsJSON.forEach((commentJson) \{ + _commentlist.add(Comment.fromJson(commentJson as Map\)); + \}); setState(ViewState.idle); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/initialise.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/initialise.md index 7515645c571..647da916af2 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/initialise.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/initialise.md @@ -10,8 +10,8 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) initialise -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) postID) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html) initialise +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) postID) @@ -23,15 +23,15 @@ ## Implementation ```dart -Future initialise(String postID) async { +Future initialise(String postID) async \{ _commentlist = []; _postID = postID; - _commentService = locator(); - _userConfig = locator(); - _postService = locator(); + _commentService = locator\(); + _userConfig = locator\(); + _postService = locator\(); notifyListeners(); await getComments(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/postId.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/postId.md index fe08747d2ee..e8c61c2cbd9 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/postId.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/postId.md @@ -11,7 +11,7 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) postId +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) postId @@ -23,7 +23,7 @@ ## Implementation ```dart -String get postId => _postID; +String get postId =\> _postID; ``` diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel-class.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel-class.md index 5379596e0a7..a7189308604 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel-class.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel-class.md @@ -11,21 +11,21 @@ -

CustomDrawerViewModel class helps to serve the data and -to react to user's input for Custom Dialog Widget.

-

Functions include:

-
    -
  • switchOrg
  • -
  • isPresentinSwitchableOrg
  • -
  • setSelectedOrganizationName
  • -
+\CustomDrawerViewModel class helps to serve the data and +to react to user's input for Custom Dialog Widget.\ +\Functions include:\ +\ +\\switchOrg\\ +\\isPresentinSwitchableOrg\\ +\\setSelectedOrganizationName\\ +\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) - [BaseModel](../view_model_base_view_model/BaseModel-class.md) - CustomDrawerViewModel @@ -45,48 +45,48 @@ to react to user's input for Custom Dialog Widget.

## Properties -##### [controller](../view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/controller.md) → [ScrollController](https://api.flutter.dev/flutter/widgets/ScrollController-class.html) +##### [controller](../view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/controller.md) → [ScrollController](https:api.flutter.dev/flutter/widgets/ScrollController-class.html) -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hasListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hasListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether any listeners are currently registered. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -95,7 +95,7 @@ _read-onlyinherited_ -_read-only_ +_\read-only\_ @@ -104,34 +104,34 @@ _read-only_ -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [switchAbleOrg](../view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/switchAbleOrg.md) ↔ [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)> +##### [switchAbleOrg](../view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/switchAbleOrg.md) ↔ [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../models_organization_org_info/OrgInfo-class.md)\> -_read / write_ +_\read / write\_ -##### [targets](../view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/targets.md) → [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[TargetFocus](https://pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TargetFocus-class.html)> +##### [targets](../view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/targets.md) → [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[TargetFocus](https:pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TargetFocus-class.html)\> -_final_ +_\final\_ -##### [tutorialCoachMark](../view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/tutorialCoachMark.md) ↔ [TutorialCoachMark](https://pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TutorialCoachMark-class.html) +##### [tutorialCoachMark](../view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/tutorialCoachMark.md) ↔ [TutorialCoachMark](https:pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TutorialCoachMark-class.html) -_read / write_ +_\read / write\_ @@ -139,12 +139,12 @@ _read / write_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be called when the object changes. -_inherited_ +_\inherited\_ @@ -154,12 +154,12 @@ _inherited_ Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -
addListener will throw after the object is disposed). -_override_ +\addListener\ will throw after the object is disposed). +_\override\_ -##### [initialize](../view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/initialize.md)([MainScreenViewModel](../view_model_main_screen_view_model/MainScreenViewModel-class.md) homeModel, [BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) void +##### [initialize](../view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/initialize.md)([MainScreenViewModel](../view_model_main_screen_view_model/MainScreenViewModel-class.md) homeModel, [BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) void @@ -168,21 +168,21 @@ _override_ -##### [isPresentinSwitchableOrg](../view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/isPresentinSwitchableOrg.md)([OrgInfo](../models_organization_org_info/OrgInfo-class.md) switchToOrg) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isPresentinSwitchableOrg](../view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/isPresentinSwitchableOrg.md)([OrgInfo](../models_organization_org_info/OrgInfo-class.md) switchToOrg) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -This function checks switchOrg is present in the switchAbleOrg. +This function checks \switchOrg\ is present in the \switchAbleOrg\. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ @@ -191,17 +191,17 @@ _inherited_ Call all the registered listeners. -_override_ +_\override\_ -##### [removeListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that are notified when the object changes. -_inherited_ +_\inherited\_ @@ -219,7 +219,7 @@ This function switches the current organization to new organization. -_inherited_ +_\inherited\_ @@ -233,12 +233,12 @@ if the organization(want switch to) is present. -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -246,12 +246,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/controller.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/controller.md index 00b8f4d3b3b..c0979dd5f7f 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/controller.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/controller.md @@ -9,9 +9,9 @@ -[ScrollController](https://api.flutter.dev/flutter/widgets/ScrollController-class.html) controller +[ScrollController](https:api.flutter.dev/flutter/widgets/ScrollController-class.html) controller -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/dispose.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/dispose.md index b73e68485b0..e960e8e46ee 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/dispose.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/dispose.md @@ -9,22 +9,22 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) void dispose () -_override_ +_\override\_ -

Discards any resources used by the object. After this is called, the +\Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -addListener will throw after the object is disposed).

-

This method should only be called by the object's owner.

-

This method does not notify listeners, and clears the listener list once +\addListener\ will throw after the object is disposed).\ +\This method should only be called by the object's owner.\ +\This method does not notify listeners, and clears the listener list once it is called. Consumers of this class must decide on whether to notify -listeners or not immediately before disposal.

+listeners or not immediately before disposal.\ @@ -32,11 +32,11 @@ listeners or not immediately before disposal.

```dart @override -void dispose() { +void dispose() \{ _disposed = true; _currentOrganizationStreamSubscription?.cancel(); super.dispose(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/initialize.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/initialize.md index 8d3d536fe10..e8b84f6d0a8 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/initialize.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/initialize.md @@ -11,7 +11,7 @@ void initialize -([MainScreenViewModel](../../view_model_main_screen_view_model/MainScreenViewModel-class.md) homeModel, [BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +([MainScreenViewModel](../../view_model_main_screen_view_model/MainScreenViewModel-class.md) homeModel, [BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) @@ -23,17 +23,17 @@ void initialize ## Implementation ```dart -void initialize(MainScreenViewModel homeModel, BuildContext context) { +void initialize(MainScreenViewModel homeModel, BuildContext context) \{ _currentOrganizationStreamSubscription = userConfig.currentOrgInfoStream.listen( - (updatedOrganization) { + (updatedOrganization) \{ setSelectedOrganizationName(updatedOrganization); - }, + \}, ); _currentUser = userConfig.currentUser; _selectedOrg = userConfig.currentOrg; _switchAbleOrg = _currentUser.joinedOrganizations!; -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/isPresentinSwitchableOrg.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/isPresentinSwitchableOrg.md index ccf6f13c79c..84039b86890 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/isPresentinSwitchableOrg.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/isPresentinSwitchableOrg.md @@ -10,33 +10,33 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isPresentinSwitchableOrg +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isPresentinSwitchableOrg ([OrgInfo](../../models_organization_org_info/OrgInfo-class.md) switchToOrg) -

This function checks switchOrg is present in the switchAbleOrg.

-

params:

-
    -
  • switchToOrg : OrgInfo type of organization want to switch into.
  • -
+\This function checks \switchOrg\ is present in the \switchAbleOrg\.\ +\params:\ +\ +\\switchToOrg\ : \OrgInfo\ type of organization want to switch into.\ +\ ## Implementation ```dart -bool isPresentinSwitchableOrg(OrgInfo switchToOrg) { +bool isPresentinSwitchableOrg(OrgInfo switchToOrg) \{ var isPresent = false; - for (final OrgInfo orgs in switchAbleOrg) { - if (orgs.id == switchToOrg.id) { + for (final OrgInfo orgs in switchAbleOrg) \{ + if (orgs.id == switchToOrg.id) \{ isPresent = true; - } - } + \} + \} return isPresent; -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/notifyListeners.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/notifyListeners.md index 1256555b55e..c919b83d9f3 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/notifyListeners.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/notifyListeners.md @@ -9,26 +9,26 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) void notifyListeners () -_override_ +_\override\_ -

Call all the registered listeners.

-

Call this method whenever the object changes, to notify any clients the +\Call all the registered listeners.\ +\Call this method whenever the object changes, to notify any clients the object may have changed. Listeners that are added during this iteration will not be visited. Listeners that are removed during this iteration will -not be visited after they are removed.

-

Exceptions thrown by listeners will be caught and reported using -FlutterError.reportError.

-

This method must not be called after dispose has been called.

-

Surprising behavior can result when reentrantly removing a listener (e.g. +not be visited after they are removed.\ +\Exceptions thrown by listeners will be caught and reported using +\FlutterError.reportError\.\ +\This method must not be called after \dispose\ has been called.\ +\Surprising behavior can result when reentrantly removing a listener (e.g. in response to a notification) that has been registered multiple times. -See the discussion at removeListener.

+See the discussion at \removeListener\.\ @@ -36,11 +36,11 @@ See the discussion at final_ +_\final\_ @@ -21,7 +21,7 @@ _final_ ## Implementation ```dart -final List targets = []; +final List\ targets = []; ``` diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/tutorialCoachMark.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/tutorialCoachMark.md index 8267cc6f147..b6fa97ca61c 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/tutorialCoachMark.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/tutorialCoachMark.md @@ -9,9 +9,9 @@ -[TutorialCoachMark](https://pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TutorialCoachMark-class.html) tutorialCoachMark +[TutorialCoachMark](https:pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TutorialCoachMark-class.html) tutorialCoachMark -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel-class.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel-class.md index f314993621a..76a6c8e1a4a 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel-class.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel-class.md @@ -11,21 +11,21 @@ -

LikeButtonViewModel class helps to serve the data and -to react to user's input for Like Button Widget.

-

Methods include:

-
    -
  • toggleIsLiked
  • -
  • setIsLiked
  • -
  • updatePost
  • -
+\LikeButtonViewModel class helps to serve the data and +to react to user's input for Like Button Widget.\ +\Methods include:\ +\ +\\toggleIsLiked\\ +\\setIsLiked\\ +\\updatePost\\ +\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) - [BaseModel](../view_model_base_view_model/BaseModel-class.md) - LikeButtonViewModel @@ -45,66 +45,66 @@ to react to user's input for Like Button Widget.

## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hasListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hasListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether any listeners are currently registered. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isLiked](../view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/isLiked.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isLiked](../view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/isLiked.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-only_ +_\read-only\_ -##### [likedBy](../view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/likedBy.md) → [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[LikedBy](../models_post_post_model/LikedBy-class.md)> +##### [likedBy](../view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/likedBy.md) → [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[LikedBy](../models_post_post_model/LikedBy-class.md)\> -_read-only_ +_\read-only\_ -##### [likesCount](../view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/likesCount.md) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [likesCount](../view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/likesCount.md) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) -_read-only_ +_\read-only\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -113,7 +113,7 @@ _read-onlyinherited_ -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -121,12 +121,12 @@ _read-onlyinherited_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be called when the object changes. -_inherited_ +_\inherited\_ @@ -145,12 +145,12 @@ _inherited_ Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -
addListener will throw after the object is disposed). -_override_ +\addListener\ will throw after the object is disposed). +_\override\_ -##### [initialize](../view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/initialize.md)([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[LikedBy](../models_post_post_model/LikedBy-class.md)> likedBy, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) postID) void +##### [initialize](../view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/initialize.md)([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[LikedBy](../models_post_post_model/LikedBy-class.md)\> likedBy, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) postID) void @@ -159,39 +159,39 @@ _override_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void +##### [notifyListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void Call all the registered listeners. -_inherited_ +_\inherited\_ -##### [removeListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that are notified when the object changes. -_inherited_ +_\inherited\_ -##### [setIsLiked](../view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/setIsLiked.md)({[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) val = true}) void +##### [setIsLiked](../view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/setIsLiked.md)(\{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) val = true\}) void -This function set _isLike to true. +This function set \_isLike\ to true. @@ -201,7 +201,7 @@ This function set _isLike to true. -_inherited_ +_\inherited\_ @@ -215,12 +215,12 @@ remove the like from the post if liked. -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -237,12 +237,12 @@ This function updates the Post. ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/checkAndSetTheIsLiked.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/checkAndSetTheIsLiked.md index 067e2a13cef..93f88274e52 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/checkAndSetTheIsLiked.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/checkAndSetTheIsLiked.md @@ -23,14 +23,14 @@ void checkAndSetTheIsLiked ## Implementation ```dart -void checkAndSetTheIsLiked() { +void checkAndSetTheIsLiked() \{ setIsLiked(val: false); - for (var i = 0; i < _likedBy.length; i++) { - if (_likedBy[i].sId == _user.id) { + for (var i = 0; i \< _likedBy.length; i++) \{ + if (_likedBy[i].sId == _user.id) \{ setIsLiked(); - } - } -} + \} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/dispose.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/dispose.md index f93ec9beb65..6fbc26bf368 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/dispose.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/dispose.md @@ -9,22 +9,22 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) void dispose () -_override_ +_\override\_ -

Discards any resources used by the object. After this is called, the +\Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -addListener will throw after the object is disposed).

-

This method should only be called by the object's owner.

-

This method does not notify listeners, and clears the listener list once +\addListener\ will throw after the object is disposed).\ +\This method should only be called by the object's owner.\ +\This method does not notify listeners, and clears the listener list once it is called. Consumers of this class must decide on whether to notify -listeners or not immediately before disposal.

+listeners or not immediately before disposal.\ @@ -32,10 +32,10 @@ listeners or not immediately before disposal.

```dart @override -// ignore: must_call_super -void dispose() { +ignore: must_call_super +void dispose() \{ _updatePostSubscription.cancel(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/initialize.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/initialize.md index 24b3ef3a858..fc7a07ccbb0 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/initialize.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/initialize.md @@ -11,7 +11,7 @@ void initialize -([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[LikedBy](../../models_post_post_model/LikedBy-class.md)> likedBy, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) postID) +([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[LikedBy](../../models_post_post_model/LikedBy-class.md)\> likedBy, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) postID) @@ -23,15 +23,15 @@ void initialize ## Implementation ```dart -void initialize(List likedBy, String postID) { +void initialize(List\ likedBy, String postID) \{ _postID = postID; _user = _userConfig.currentUser; _likedBy = likedBy; notifyListeners(); checkAndSetTheIsLiked(); _updatePostSubscription = - _postService.updatedPostStream.listen((post) => updatePost(post)); -} + _postService.updatedPostStream.listen((post) =\> updatePost(post)); +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/isLiked.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/isLiked.md index e1e07b47db3..53b3dd35ac1 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/isLiked.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/isLiked.md @@ -11,7 +11,7 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isLiked +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isLiked @@ -23,7 +23,7 @@ ## Implementation ```dart -bool get isLiked => _isLiked; +bool get isLiked =\> _isLiked; ``` diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/likedBy.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/likedBy.md index d35d176b50a..6a3915467b4 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/likedBy.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/likedBy.md @@ -11,7 +11,7 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[LikedBy](../../models_post_post_model/LikedBy-class.md)> likedBy +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[LikedBy](../../models_post_post_model/LikedBy-class.md)\> likedBy @@ -23,7 +23,7 @@ ## Implementation ```dart -List get likedBy => _likedBy; +List\ get likedBy =\> _likedBy; ``` diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/likesCount.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/likesCount.md index 8766c21d527..66f720f9848 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/likesCount.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/likesCount.md @@ -11,7 +11,7 @@ -[int](https://api.flutter.dev/flutter/dart-core/int-class.html) likesCount +[int](https:api.flutter.dev/flutter/dart-core/int-class.html) likesCount @@ -23,7 +23,7 @@ ## Implementation ```dart -int get likesCount => _likedBy.length; +int get likesCount =\> _likedBy.length; ``` diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/setIsLiked.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/setIsLiked.md index 0f471fd1690..41b36a738ee 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/setIsLiked.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/setIsLiked.md @@ -11,23 +11,23 @@ void setIsLiked -({[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) val = true}) +(\{[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) val = true\}) -

This function set _isLike to true.

+\This function set \_isLike\ to true.\ ## Implementation ```dart -void setIsLiked({bool val = true}) { +void setIsLiked(\{bool val = true\}) \{ _isLiked = val; notifyListeners(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/toggleIsLiked.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/toggleIsLiked.md index 02c2ab66ecb..cbd064c737c 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/toggleIsLiked.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/toggleIsLiked.md @@ -17,21 +17,21 @@ void toggleIsLiked -

This function add like to the post if not liked and -remove the like from the post if liked.

+\This function add like to the post if not liked and +remove the like from the post if liked.\ ## Implementation ```dart -void toggleIsLiked() { - if (!_isLiked) { +void toggleIsLiked() \{ + if (!_isLiked) \{ _postService.addLike(_postID); - } else { + \} else \{ _postService.removeLike(_postID); - } -} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/updatePost.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/updatePost.md index 4076fffea5e..4e047104a02 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/updatePost.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/updatePost.md @@ -17,21 +17,21 @@ void updatePost -

This function updates the Post.

-

params: -post : Post type, the post that need to be updated.

+\This function updates the Post.\ +\params: +\post\ : \Post\ type, the post that need to be updated.\ ## Implementation ```dart -void updatePost(Post post) { - if (_postID == post.sId) { +void updatePost(Post post) \{ + if (_postID == post.sId) \{ _likedBy = post.likedBy!; checkAndSetTheIsLiked(); - } -} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel-class.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel-class.md index 1fb945caabd..92ebc2b24f5 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel-class.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel-class.md @@ -11,15 +11,15 @@ -

ProgressDialogViewModel class helps to serve the data and -to react to user's input for Progress Dialog Widget.

+\ProgressDialogViewModel class helps to serve the data and +to react to user's input for Progress Dialog Widget.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) - [BaseModel](../view_model_base_view_model/BaseModel-class.md) - ProgressDialogViewModel @@ -39,57 +39,57 @@ to react to user's input for Progress Dialog Widget.

## Properties -##### [connectivityPresent](../view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/connectivityPresent.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [connectivityPresent](../view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/connectivityPresent.md) ↔ [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read / write_ +_\read / write\_ -##### [connectivityResult](../view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/connectivityResult.md) ↔ [ConnectivityResult](https://pub.dev/documentation/connectivity_plus_platform_interface/1.2.4/connectivity_plus_platform_interface/ConnectivityResult.html) +##### [connectivityResult](../view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/connectivityResult.md) ↔ [ConnectivityResult](https:pub.dev/documentation/connectivity_plus_platform_interface/1.2.4/connectivity_plus_platform_interface/ConnectivityResult.html) -_read / write_ +_\read / write\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [hasListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [hasListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) Whether any listeners are currently registered. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -98,7 +98,7 @@ _read-onlyinherited_ -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -106,27 +106,27 @@ _read-onlyinherited_ ## Methods -##### [addListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [addListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Register a closure to be called when the object changes. -_inherited_ +_\inherited\_ -##### [dispose](https://api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void +##### [dispose](https:api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html)() void Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to -
addListener will throw after the object is disposed). -_inherited_ +\addListener\ will throw after the object is disposed). +_\inherited\_ -##### [initialise](../view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/initialise.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> +##### [initialise](../view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/initialise.md)() [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> @@ -135,31 +135,31 @@ _inherited_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void +##### [notifyListeners](https:api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void Call all the registered listeners. -_inherited_ +_\inherited\_ -##### [removeListener](https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void +##### [removeListener](https:api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) listener) void Remove a previously registered closure from the list of closures that are notified when the object changes. -_inherited_ +_\inherited\_ @@ -168,16 +168,16 @@ _inherited_ -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -185,12 +185,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/connectivityPresent.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/connectivityPresent.md index db77d704ccc..eee6488ac9d 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/connectivityPresent.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/connectivityPresent.md @@ -9,9 +9,9 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) connectivityPresent +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) connectivityPresent -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/connectivityResult.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/connectivityResult.md index f3c500a1277..1ed490a6f9a 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/connectivityResult.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/connectivityResult.md @@ -9,9 +9,9 @@ -[ConnectivityResult](https://pub.dev/documentation/connectivity_plus_platform_interface/1.2.4/connectivity_plus_platform_interface/ConnectivityResult.html) connectivityResult +[ConnectivityResult](https:pub.dev/documentation/connectivity_plus_platform_interface/1.2.4/connectivity_plus_platform_interface/ConnectivityResult.html) connectivityResult -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/initialise.md b/docs/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/initialise.md index 7389c3d9291..595b72f88ea 100644 --- a/docs/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/initialise.md +++ b/docs/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/initialise.md @@ -10,7 +10,7 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> initialise +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<void\> initialise () @@ -23,18 +23,18 @@ ## Implementation ```dart -Future initialise() async { +Future\ initialise() async \{ setState(ViewState.busy); connectivityResult = await connectivity.checkConnectivity(); - if (connectivityResult == ConnectivityResult.none) { + if (connectivityResult == ConnectivityResult.none) \{ connectivityPresent = false; Future.delayed(const Duration(seconds: 2)) - .then((value) => navigationService.pop()); - } else { + .then((value) =\> navigationService.pop()); + \} else \{ connectivityPresent = true; - } + \} setState(ViewState.idle); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost-class.md index f61800c2df5..5f15eabb808 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost-class.md @@ -11,16 +11,16 @@ -

AddPost returns a widget to add(upload) the post.

+\AddPost returns a widget to add(upload) the post.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - AddPost @@ -32,46 +32,46 @@ ## Constructors -[AddPost](../views_after_auth_screens_add_post_page/AddPost/AddPost.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[ScaffoldState](https://api.flutter.dev/flutter/material/ScaffoldState-class.html)>? drawerKey}) +[AddPost](../views_after_auth_screens_add_post_page/AddPost/AddPost.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[ScaffoldState](https:api.flutter.dev/flutter/material/ScaffoldState-class.html)\>? drawerKey\}) _const_ ## Properties -##### [drawerKey](../views_after_auth_screens_add_post_page/AddPost/drawerKey.md) → [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[ScaffoldState](https://api.flutter.dev/flutter/material/ScaffoldState-class.html)>? +##### [drawerKey](../views_after_auth_screens_add_post_page/AddPost/drawerKey.md) → [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[ScaffoldState](https:api.flutter.dev/flutter/material/ScaffoldState-class.html)\>? DrawerKey. -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -79,95 +79,95 @@ _read-onlyinherited_ ## Methods -##### [build](../views_after_auth_screens_add_post_page/AddPost/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../views_after_auth_screens_add_post_page/AddPost/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -175,12 +175,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost/AddPost.md b/docs/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost/AddPost.md index a98f0d2a1a4..2914afdc279 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost/AddPost.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost/AddPost.md @@ -9,7 +9,7 @@ const -AddPost({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, [GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[ScaffoldState](https://api.flutter.dev/flutter/material/ScaffoldState-class.html)>? drawerKey}) +AddPost(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, [GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[ScaffoldState](https:api.flutter.dev/flutter/material/ScaffoldState-class.html)\>? drawerKey\}) @@ -18,7 +18,7 @@ AddPost({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, ## Implementation ```dart -const AddPost({Key? key, this.drawerKey}) : super(key: key); +const AddPost(\{Key? key, this.drawerKey\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost/build.md b/docs/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost/build.md index dc744fe0ae4..36696f62cdf 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost/build.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,15 +58,15 @@ and ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ return Scaffold( resizeToAvoidBottomInset: false, - // header for the widget + header for the widget appBar: AppBar( backgroundColor: Theme.of(context).primaryColor, elevation: 0.9, centerTitle: true, - // header title + header title title: Text( AppLocalizations.of(context)!.strictTranslate('Share News'), style: Theme.of(context).textTheme.titleLarge!.copyWith( @@ -75,17 +75,17 @@ Widget build(BuildContext context) { ), ), leading: IconButton( - //TODO: showing the null pointer exception + TODO: showing the null pointer exception key: const Key('add_post_icon_button1'), color: Theme.of(context).iconTheme.color, icon: const Icon(Icons.menu), - onPressed: () => drawerKey!.currentState!.openDrawer(), + onPressed: () =\> drawerKey!.currentState!.openDrawer(), ), - // button to upload the post. + button to upload the post. actions: [ TextButton( key: const Key('add_post_text_btn1'), - onPressed: () => model.uploadPost(), + onPressed: () =\> model.uploadPost(), child: Text( AppLocalizations.of(context)!.strictTranslate("Post"), style: Theme.of(context).textTheme.headlineSmall!.copyWith( @@ -96,14 +96,14 @@ Widget build(BuildContext context) { ), ], ), - body: BaseView( - onModelReady: (m) { + body: BaseView\( + onModelReady: (m) \{ m.initialise(); model = m; - }, - builder: (context, model, child) => SingleChildScrollView( + \}, + builder: (context, model, child) =\> SingleChildScrollView( child: Column( - children: [ + children: \[ ListTile( leading: const CircleAvatar(radius: 25), title: Text(model.userName), @@ -111,33 +111,33 @@ Widget build(BuildContext context) { AppLocalizations.of(context)!.strictTranslate(model.orgName), ), ), - // renders icon button to upload post files. + renders icon button to upload post files. Row( - children: [ - // button to select the photo from gallery. + children: \[ + button to select the photo from gallery. IconButton( key: const Key('add_post_icon_button2'), - onPressed: () => model.getImageFromGallery(), + onPressed: () =\> model.getImageFromGallery(), icon: const Icon(Icons.photo), ), - // button to capture the image. + button to capture the image. IconButton( key: const Key('add_post_icon_button3'), - onPressed: () => model.getImageFromGallery(camera: true), + onPressed: () =\> model.getImageFromGallery(camera: true), icon: const Icon(Icons.camera_alt), ), - // button to select file + button to select file IconButton( key: const Key('add_post_icon_button4'), - onPressed: () {}, + onPressed: () \{\}, icon: const Icon(Icons.file_upload), ), - // button to add hastags to the post. + button to add hastags to the post. TextButton( key: const Key('add_post_text_btn2'), - onPressed: () {}, + onPressed: () \{\}, child: Text( - '# ${AppLocalizations.of(context)!.strictTranslate("Add hashtag")}', + '# $\{AppLocalizations.of(context)!.strictTranslate("Add hashtag")\}', style: Theme.of(context).textTheme.titleLarge, ), ), @@ -148,7 +148,7 @@ Widget build(BuildContext context) { padding: const EdgeInsets.symmetric(horizontal: 16.0), child: TextField( controller: model.titleController, - // input field to write the description of the post. + input field to write the description of the post. decoration: InputDecoration( border: InputBorder.none, focusedBorder: InputBorder.none, @@ -172,7 +172,7 @@ Widget build(BuildContext context) { child: TextField( controller: model.controller, maxLines: null, - // input field to write the description of the post. + input field to write the description of the post. decoration: InputDecoration( border: InputBorder.none, focusedBorder: InputBorder.none, @@ -185,9 +185,9 @@ Widget build(BuildContext context) { ), ), ), - // if the image for the post is added then render button to remove it. + if the image for the post is added then render button to remove it. model.imageFile != null - // ignore: sized_box_for_whitespace + ignore: sized_box_for_whitespace ? Container( height: 230, padding: const EdgeInsets.all(8.0), @@ -202,7 +202,7 @@ Widget build(BuildContext context) { right: 5, top: 5, child: IconButton( - onPressed: () => model.removeImage(), + onPressed: () =\> model.removeImage(), icon: const Icon( Icons.cancel, color: Colors.black, @@ -218,7 +218,7 @@ Widget build(BuildContext context) { ), ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost/drawerKey.md b/docs/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost/drawerKey.md index e50f7f58b22..e5df3b285b3 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost/drawerKey.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost/drawerKey.md @@ -9,20 +9,20 @@ -[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[ScaffoldState](https://api.flutter.dev/flutter/material/ScaffoldState-class.html)>? drawerKey +[GlobalKey](https:api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[ScaffoldState](https:api.flutter.dev/flutter/material/ScaffoldState-class.html)\>? drawerKey -_final_ +_\final\_ -

DrawerKey.

+\DrawerKey.\ ## Implementation ```dart -final GlobalKey? drawerKey; +final GlobalKey\? drawerKey; ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_add_post_page/model.md b/docs/talawa-mobile-docs/views_after_auth_screens_add_post_page/model.md index b885e47961f..8a599d6240e 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_add_post_page/model.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_add_post_page/model.md @@ -13,11 +13,11 @@ [AddPostViewModel](../view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel-class.md) model -_read / write_ +_\read / write\_ -

Add Post View Model.

+\Add Post View Model.\ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_add_post_page/views_after_auth_screens_add_post_page-library.md b/docs/talawa-mobile-docs/views_after_auth_screens_add_post_page/views_after_auth_screens_add_post_page-library.md index 1283c8ee081..06fe6d4bd3e 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_add_post_page/views_after_auth_screens_add_post_page-library.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_add_post_page/views_after_auth_screens_add_post_page-library.md @@ -34,7 +34,7 @@ AddPost returns a widget to add(upload) the post. Add Post View Model. -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage-class.md index b86bb1fbdaf..df1f12e057d 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage-class.md @@ -11,16 +11,16 @@ -

AppSettingsPage is a widget that has mutable state _AppSettingsPageState.

+\AppSettingsPage is a widget that has mutable state _AppSettingsPageState.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html) - AppSettingsPage @@ -32,37 +32,37 @@ ## Constructors -[AppSettingsPage](../views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage/AppSettingsPage.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +[AppSettingsPage](../views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage/AppSettingsPage.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -70,12 +70,12 @@ _read-onlyinherited_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a
StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ @@ -84,81 +84,81 @@ _inherited_ Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -166,12 +166,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage/AppSettingsPage.md b/docs/talawa-mobile-docs/views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage/AppSettingsPage.md index cef89c44bc3..578b8ffea7e 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage/AppSettingsPage.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage/AppSettingsPage.md @@ -9,7 +9,7 @@ const -AppSettingsPage({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +AppSettingsPage(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) @@ -18,7 +18,7 @@ AppSettingsPage({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html ## Implementation ```dart -const AppSettingsPage({Key? key}) : super(key: key); +const AppSettingsPage(\{Key? key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage/createState.md b/docs/talawa-mobile-docs/views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage/createState.md index f6f01c5f1db..72f0cdf813f 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage/createState.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) _AppSettingsPageState createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -71,95 +71,95 @@ _read-onlyinherited_ ## Methods -##### [build](../views_after_auth_screens_chat_chat_list_screen/ChatPage/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../views_after_auth_screens_chat_chat_list_screen/ChatPage/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -167,12 +167,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_list_screen/ChatPage/ChatPage.md b/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_list_screen/ChatPage/ChatPage.md index c9653c01c9e..03b7b4797bb 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_list_screen/ChatPage/ChatPage.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_list_screen/ChatPage/ChatPage.md @@ -9,7 +9,7 @@ const -ChatPage({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +ChatPage(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) @@ -18,7 +18,7 @@ ChatPage({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key} ## Implementation ```dart -const ChatPage({Key? key}) : super(key: key); +const ChatPage(\{Key? key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_list_screen/ChatPage/build.md b/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_list_screen/ChatPage/build.md index 11b31fb2a52..d7e99beeafa 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_list_screen/ChatPage/build.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_list_screen/ChatPage/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,7 +58,7 @@ and ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ return DefaultTabController( length: 2, child: Scaffold( @@ -84,7 +84,7 @@ Widget build(BuildContext context) { ], ), ), - // returns a tabs on the top for current user to switch between DirectChats and EventChats. + returns a tabs on the top for current user to switch between DirectChats and EventChats. body: const TabBarView( children: [ DirectChats(), @@ -92,18 +92,18 @@ Widget build(BuildContext context) { ], ), floatingActionButton: FloatingActionButton( - // onPressed to FloatingActionButton renders SelectContact Widget to chat with other users in the connection. - onPressed: () { + onPressed to FloatingActionButton renders SelectContact Widget to chat with other users in the connection. + onPressed: () \{ Navigator.push( context, - MaterialPageRoute(builder: (context) => const SelectContact()), + MaterialPageRoute(builder: (context) =\> const SelectContact()), ); - }, + \}, child: const Icon(Icons.add), ), ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen-class.md index 131bed19672..5b6c7450a87 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen-class.md @@ -11,16 +11,16 @@ -

ChatMessageScreen returns a StatelessWidget for showing the chat message screen.

+\ChatMessageScreen returns a StatelessWidget for showing the chat message screen.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - ChatMessageScreen @@ -32,37 +32,37 @@ ## Constructors -[ChatMessageScreen](../views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/ChatMessageScreen.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) chatId, required [DirectChatViewModel](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md) model}) +[ChatMessageScreen](../views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/ChatMessageScreen.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) chatId, required [DirectChatViewModel](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md) model\}) _const_ ## Properties -##### [chatId](../views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/chatId.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [chatId](../views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/chatId.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ @@ -71,16 +71,16 @@ _finalinherited_ -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -88,95 +88,95 @@ _read-onlyinherited_ ## Methods -##### [build](../views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -184,12 +184,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/ChatMessageScreen.md b/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/ChatMessageScreen.md index f6d0c8a5e6b..decb151fd4d 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/ChatMessageScreen.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/ChatMessageScreen.md @@ -9,7 +9,7 @@ const -ChatMessageScreen({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) chatId, required [DirectChatViewModel](../../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md) model}) +ChatMessageScreen(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) chatId, required [DirectChatViewModel](../../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md) model\}) @@ -18,7 +18,7 @@ ChatMessageScreen({[Key](https://api.flutter.dev/flutter/foundation/Key-class.ht ## Implementation ```dart -const ChatMessageScreen({Key? key, required this.chatId, required this.model}) +const ChatMessageScreen(\{Key? key, required this.chatId, required this.model\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/build.md b/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/build.md index 0ba68ed5810..314404d09b4 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/build.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,7 +58,7 @@ and ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ model.getChatMessages(chatId); model.chatName(chatId); return Scaffold( @@ -68,7 +68,7 @@ Widget build(BuildContext context) { children: [ IconButton( icon: const Icon(Icons.arrow_back), - onPressed: () => Navigator.pop(context), + onPressed: () =\> Navigator.pop(context), ), SizedBox(width: SizeConfig.safeBlockHorizontal! * 3), CircleAvatar( @@ -76,14 +76,14 @@ Widget build(BuildContext context) { radius: SizeConfig.blockSizeVertical! * 2.3, ), SizedBox(width: SizeConfig.safeBlockHorizontal! * 3), - Text('${model.name}'), + Text('$\{model.name\}'), ], ), ), - body: BaseView( - onModelReady: (model) => model.getChatMessages(chatId), - builder: (context, model, child) => - (Provider.of(context).chatState == + body: BaseView\( + onModelReady: (model) =\> model.getChatMessages(chatId), + builder: (context, model, child) =\> + (Provider.of\(context).chatState == ChatState.complete) ? Column( children: [ @@ -94,12 +94,12 @@ Widget build(BuildContext context) { ), child: ListView.builder( itemCount: model.chatMessagesByUser[chatId]!.length, - itemBuilder: (context, index) { + itemBuilder: (context, index) \{ return Message( message: model.chatMessagesByUser[chatId]![index], ); - }, + \}, ), ), ), @@ -111,7 +111,7 @@ Widget build(BuildContext context) { ), ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/chatId.md b/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/chatId.md index 2dc5c3bec5c..40517959bf0 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/chatId.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/chatId.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) chatId +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) chatId -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/model.md b/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/model.md index 45becc144aa..3bcd5a7830d 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/model.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/model.md @@ -11,7 +11,7 @@ [DirectChatViewModel](../../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md) model -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile-class.md index aa7aa3b8907..ec38b4cceda 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile-class.md @@ -11,16 +11,16 @@ -

ChatTile return a widget for a tile in the list of Direct Chats in the Chat List Screen.

+\ChatTile return a widget for a tile in the list of Direct Chats in the Chat List Screen.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - ChatTile @@ -32,7 +32,7 @@ ## Constructors -[ChatTile](../views_after_auth_screens_chat_direct_chats/ChatTile/ChatTile.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [ChatListTileDataModel](../models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md) chat, required [DirectChatViewModel](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md) model}) +[ChatTile](../views_after_auth_screens_chat_direct_chats/ChatTile/ChatTile.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [ChatListTileDataModel](../models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md) chat, required [DirectChatViewModel](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md) model\}) _const_ @@ -44,25 +44,25 @@ -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ @@ -71,16 +71,16 @@ _finalinherited_ -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -88,95 +88,95 @@ _read-onlyinherited_ ## Methods -##### [build](../views_after_auth_screens_chat_direct_chats/ChatTile/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../views_after_auth_screens_chat_direct_chats/ChatTile/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -184,12 +184,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/ChatTile.md b/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/ChatTile.md index d57031896b7..c72a23784b0 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/ChatTile.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/ChatTile.md @@ -9,7 +9,7 @@ const -ChatTile({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [ChatListTileDataModel](../../models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md) chat, required [DirectChatViewModel](../../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md) model}) +ChatTile(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [ChatListTileDataModel](../../models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md) chat, required [DirectChatViewModel](../../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md) model\}) @@ -18,7 +18,7 @@ ChatTile({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, ## Implementation ```dart -const ChatTile({Key? key, required this.chat, required this.model}) +const ChatTile(\{Key? key, required this.chat, required this.model\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/build.md b/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/build.md index b568e64b030..50717cb3969 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/build.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,16 +58,16 @@ and ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ return ListTile( - onTap: () => navigationService + onTap: () =\> navigationService .pushScreen(Routes.chatMessageScreen, arguments: [chat.id, model]), leading: const CircleAvatar( radius: 20, ), title: Text(chat.users![0].firstName!), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/chat.md b/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/chat.md index f685bdc7679..f7f3dcaa2dc 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/chat.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/chat.md @@ -11,7 +11,7 @@ [ChatListTileDataModel](../../models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md) chat -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/model.md b/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/model.md index 45becc144aa..3bcd5a7830d 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/model.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/model.md @@ -11,7 +11,7 @@ [DirectChatViewModel](../../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md) model -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/DirectChats-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/DirectChats-class.md index 2db88e0c78f..7471b24f8d0 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/DirectChats-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/DirectChats-class.md @@ -11,17 +11,17 @@ -

DirectChats return a statelessWidget for rendering all the directs -chats of the current user in the Chat List Screen

+\DirectChats return a statelessWidget for rendering all the directs +chats of the current user in the Chat List Screen\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - DirectChats @@ -33,37 +33,37 @@ chats of the current user in the Chat List Screen

## Constructors -[DirectChats](../views_after_auth_screens_chat_direct_chats/DirectChats/DirectChats.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +[DirectChats](../views_after_auth_screens_chat_direct_chats/DirectChats/DirectChats.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -71,95 +71,95 @@ _read-onlyinherited_ ## Methods -##### [build](../views_after_auth_screens_chat_direct_chats/DirectChats/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../views_after_auth_screens_chat_direct_chats/DirectChats/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -167,12 +167,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/DirectChats/DirectChats.md b/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/DirectChats/DirectChats.md index bacac35bade..dc8cc3ad640 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/DirectChats/DirectChats.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/DirectChats/DirectChats.md @@ -9,7 +9,7 @@ const -DirectChats({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +DirectChats(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) @@ -18,7 +18,7 @@ DirectChats({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? k ## Implementation ```dart -const DirectChats({Key? key}) : super(key: key); +const DirectChats(\{Key? key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/DirectChats/build.md b/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/DirectChats/build.md index 13c976ecbd6..d419fe6f505 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/DirectChats/build.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/DirectChats/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,23 +58,23 @@ and ```dart @override -Widget build(BuildContext context) { - return BaseView( - onModelReady: (model) => model.initialise(), - builder: (context, model, child) { +Widget build(BuildContext context) \{ + return BaseView\( + onModelReady: (model) =\> model.initialise(), + builder: (context, model, child) \{ return ListView.builder( - // key: model.listKey, + key: model.listKey, itemCount: model.chats.length, - itemBuilder: (context, index) { + itemBuilder: (context, index) \{ return ChatTile( chat: model.chats[index], model: model, ); - }, + \}, ); - }, + \}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_chat_event_chats/EventChats-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_chat_event_chats/EventChats-class.md index afab3cf5883..b35bcf674c7 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_chat_event_chats/EventChats-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_chat_event_chats/EventChats-class.md @@ -11,17 +11,17 @@ -

EventChats return a statelessWidget for rendering all the events -chats of the current user in the Chat List Screen

+\EventChats return a statelessWidget for rendering all the events +chats of the current user in the Chat List Screen\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - EventChats @@ -33,37 +33,37 @@ chats of the current user in the Chat List Screen

## Constructors -[EventChats](../views_after_auth_screens_chat_event_chats/EventChats/EventChats.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +[EventChats](../views_after_auth_screens_chat_event_chats/EventChats/EventChats.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -71,95 +71,95 @@ _read-onlyinherited_ ## Methods -##### [build](../views_after_auth_screens_chat_event_chats/EventChats/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../views_after_auth_screens_chat_event_chats/EventChats/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -167,12 +167,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_chat_event_chats/EventChats/EventChats.md b/docs/talawa-mobile-docs/views_after_auth_screens_chat_event_chats/EventChats/EventChats.md index 5186b082270..de9150b32fa 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_chat_event_chats/EventChats/EventChats.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_chat_event_chats/EventChats/EventChats.md @@ -9,7 +9,7 @@ const -EventChats({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +EventChats(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) @@ -18,7 +18,7 @@ EventChats({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? ke ## Implementation ```dart -const EventChats({Key? key}) : super(key: key); +const EventChats(\{Key? key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_chat_event_chats/EventChats/build.md b/docs/talawa-mobile-docs/views_after_auth_screens_chat_event_chats/EventChats/build.md index 0552bb07a5f..9f1d9d22a3d 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_chat_event_chats/EventChats/build.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_chat_event_chats/EventChats/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,11 +58,11 @@ and ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ return Container( child: null, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_chat_select_contact/SelectContact-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_chat_select_contact/SelectContact-class.md index 790f504b5ac..150134db4b1 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_chat_select_contact/SelectContact-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_chat_select_contact/SelectContact-class.md @@ -11,16 +11,16 @@ -

SelectContact returns a widget that has mutable state _SelectContactState.

+\SelectContact returns a widget that has mutable state _SelectContactState.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html) - SelectContact @@ -32,37 +32,37 @@ ## Constructors -[SelectContact](../views_after_auth_screens_chat_select_contact/SelectContact/SelectContact.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +[SelectContact](../views_after_auth_screens_chat_select_contact/SelectContact/SelectContact.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -70,12 +70,12 @@ _read-onlyinherited_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a
StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ @@ -84,81 +84,81 @@ _inherited_ Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -166,12 +166,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_chat_select_contact/SelectContact/SelectContact.md b/docs/talawa-mobile-docs/views_after_auth_screens_chat_select_contact/SelectContact/SelectContact.md index d896d61fdaa..a4e9448a9b0 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_chat_select_contact/SelectContact/SelectContact.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_chat_select_contact/SelectContact/SelectContact.md @@ -9,7 +9,7 @@ const -SelectContact({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +SelectContact(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) @@ -18,7 +18,7 @@ SelectContact({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? ## Implementation ```dart -const SelectContact({Key? key}) : super(key: key); +const SelectContact(\{Key? key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_chat_select_contact/SelectContact/createState.md b/docs/talawa-mobile-docs/views_after_auth_screens_chat_select_contact/SelectContact/createState.md index 34529da24d1..9b7b4e731a6 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_chat_select_contact/SelectContact/createState.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_chat_select_contact/SelectContact/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) _SelectContactState createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ @@ -71,16 +71,16 @@ _finalinherited_ DirectChatViewModel instance. -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -88,95 +88,95 @@ _read-onlyinherited_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [createState](../views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/createState.md)() [State](https://api.flutter.dev/flutter/widgets/State-class.html)<[ChatInputField](../views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField-class.md)> +##### [createState](../views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/createState.md)() [State](https:api.flutter.dev/flutter/widgets/State-class.html)<[ChatInputField](../views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField-class.md)\> Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -184,12 +184,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/ChatInputField.md b/docs/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/ChatInputField.md index 9521860d9e9..db7ae34a2c5 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/ChatInputField.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/ChatInputField.md @@ -9,7 +9,7 @@ const -ChatInputField({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) chatId, required [DirectChatViewModel](../../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md) model, [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +ChatInputField(\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) chatId, required [DirectChatViewModel](../../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md) model, [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) @@ -18,11 +18,11 @@ ChatInputField({required [String](https://api.flutter.dev/flutter/dart-core/Stri ## Implementation ```dart -const ChatInputField({ +const ChatInputField(\{ required this.chatId, required this.model, Key? key, -}) : super(key: key); +\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/chatId.md b/docs/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/chatId.md index e2b3e1207c4..66b643c04d4 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/chatId.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/chatId.md @@ -9,13 +9,13 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) chatId +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) chatId -_final_ +_\final\_ -

ChatId.

+\ChatId.\ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/createState.md b/docs/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/createState.md index 1d7afc59b14..3e33bec6e23 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/createState.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[ChatInputField](../../views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField-class.md)> createState +[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[ChatInputField](../../views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField-class.md)\> createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh final_ +_\final\_ -

DirectChatViewModel instance.

+\DirectChatViewModel instance.\ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_message_bubble/Message-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_message_bubble/Message-class.md index 7bb1eb07652..469407f9608 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_message_bubble/Message-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_message_bubble/Message-class.md @@ -11,16 +11,16 @@ -

Message returns a widget for chat message in the bubble form.

+\Message returns a widget for chat message in the bubble form.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - Message @@ -32,37 +32,37 @@ ## Constructors -[Message](../views_after_auth_screens_chat_widgets_chat_message_bubble/Message/Message.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [ChatMessage](../models_chats_chat_message/ChatMessage-class.md) message}) +[Message](../views_after_auth_screens_chat_widgets_chat_message_bubble/Message/Message.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [ChatMessage](../models_chats_chat_message/ChatMessage-class.md) message\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -70,95 +70,95 @@ _read-onlyinherited_ ## Methods -##### [build](../views_after_auth_screens_chat_widgets_chat_message_bubble/Message/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../views_after_auth_screens_chat_widgets_chat_message_bubble/Message/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -166,12 +166,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_message_bubble/Message/Message.md b/docs/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_message_bubble/Message/Message.md index 6f392e74818..6f47b9aceed 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_message_bubble/Message/Message.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_message_bubble/Message/Message.md @@ -9,7 +9,7 @@ const -Message({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [ChatMessage](../../models_chats_chat_message/ChatMessage-class.md) message}) +Message(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [ChatMessage](../../models_chats_chat_message/ChatMessage-class.md) message\}) @@ -18,7 +18,7 @@ Message({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, ## Implementation ```dart -const Message({Key? key, required this.message}) : super(key: key); +const Message(\{Key? key, required this.message\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_message_bubble/Message/build.md b/docs/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_message_bubble/Message/build.md index 824759c161e..c31f906402d 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_message_bubble/Message/build.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_message_bubble/Message/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,8 +58,8 @@ and ```dart @override -Widget build(BuildContext context) { - // styling +Widget build(BuildContext context) \{ + styling return Padding( padding: EdgeInsets.only(top: SizeConfig.safeBlockVertical! * 2), child: Row( @@ -74,7 +74,7 @@ Widget build(BuildContext context) { vertical: SizeConfig.blockSizeVertical! * 1.2, ), decoration: BoxDecoration( - // if the message is sent by current user, then the background color will be white else green + if the message is sent by current user, then the background color will be white else green color: message.sender!.firstName == userConfig.currentUser.firstName ? Colors.white @@ -94,7 +94,7 @@ Widget build(BuildContext context) { ), child: Text( message.messageContent!, - // if the message is sent by current user, then the text color will be black else theme bodyText color + if the message is sent by current user, then the text color will be black else theme bodyText color style: TextStyle( color: message.sender!.firstName == userConfig.currentUser.firstName @@ -106,7 +106,7 @@ Widget build(BuildContext context) { ], ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm-class.md index 6899a021e14..cda7dfc67d2 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm-class.md @@ -11,17 +11,17 @@ -

CreateEventForm returns a widget of a Form for creating events in the organization. -This widget is used in CreateEventPage widget.

+\CreateEventForm returns a widget of a Form for creating events in the organization. +This widget is used in CreateEventPage widget.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - CreateEventForm @@ -33,28 +33,28 @@ This widget is used in CreateEventPage widget.

## Constructors -[CreateEventForm](../views_after_auth_screens_events_create_event_form/CreateEventForm/CreateEventForm.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [CreateEventViewModel](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md) model}) +[CreateEventForm](../views_after_auth_screens_events_create_event_form/CreateEventForm/CreateEventForm.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [CreateEventViewModel](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md) model\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ @@ -63,16 +63,16 @@ _finalinherited_ -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -80,95 +80,95 @@ _read-onlyinherited_ ## Methods -##### [build](../views_after_auth_screens_events_create_event_form/CreateEventForm/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../views_after_auth_screens_events_create_event_form/CreateEventForm/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -176,12 +176,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm/CreateEventForm.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm/CreateEventForm.md index bc499612ce6..d0621b60781 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm/CreateEventForm.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm/CreateEventForm.md @@ -9,7 +9,7 @@ const -CreateEventForm({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [CreateEventViewModel](../../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md) model}) +CreateEventForm(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [CreateEventViewModel](../../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md) model\}) @@ -18,7 +18,7 @@ CreateEventForm({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html ## Implementation ```dart -const CreateEventForm({Key? key, required this.model}) : super(key: key); +const CreateEventForm(\{Key? key, required this.model\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm/build.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm/build.md index 4f52a40ccdc..b227045e668 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm/build.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,14 +58,14 @@ and ```dart @override -Widget build(BuildContext context) { - // Form class is a container for grouping together multiple form field widgets. +Widget build(BuildContext context) \{ + Form class is a container for grouping together multiple form field widgets. return Form( key: model.formKey, child: Column( crossAxisAlignment: CrossAxisAlignment.start, children: [ - // Text field for event title. + Text field for event title. TextFormField( key: const Key('create_event_form_tff1'), textInputAction: TextInputAction.next, @@ -73,9 +73,9 @@ Widget build(BuildContext context) { keyboardType: TextInputType.name, maxLength: 20, focusNode: model.titleFocus, - validator: (value) => Validator.validateEventForm(value!, 'Title'), + validator: (value) =\> Validator.validateEventForm(value!, 'Title'), decoration: InputDecoration( - // placeholder of the text field + placeholder of the text field labelText: 'Add Event Title', isDense: true, labelStyle: Theme.of(context).textTheme.titleMedium, @@ -98,14 +98,14 @@ Widget build(BuildContext context) { SizedBox( height: SizeConfig.screenHeight! * 0.013, ), - // Text field for the location. + Text field for the location. TextFormField( key: const Key('create_event_form_tff2'), textInputAction: TextInputAction.next, keyboardType: TextInputType.streetAddress, controller: model.eventLocationTextController, focusNode: model.locationFocus, - validator: (value) => + validator: (value) =\> Validator.validateEventForm(value!, 'Location'), decoration: InputDecoration( hintText: 'Where is the event?', @@ -116,14 +116,14 @@ Widget build(BuildContext context) { enabledBorder: InputBorder.none, suffix: GestureDetector( key: const Key('gesture_cef_test'), - onTap: () => navigationService.pushScreen( + onTap: () =\> navigationService.pushScreen( Routes.mapScreen, - arguments: { + arguments: \{ 'model': model, - // initalize the map screen with a marker at this location + initalize the map screen with a marker at this location 'latitude': 37.42796133580664, 'longitude': -122.085749655962, - }, + \}, ), child: Text( AppLocalizations.of(context)! @@ -150,13 +150,13 @@ Widget build(BuildContext context) { SizedBox( height: SizeConfig.screenHeight! * 0.013, ), - // Text field for event description. + Text field for event description. TextFormField( key: const Key('create_event_form_tff3'), keyboardType: TextInputType.multiline, controller: model.eventDescriptionTextController, focusNode: model.descriptionFocus, - validator: (value) => + validator: (value) =\> Validator.validateEventForm(value!, 'Description'), maxLines: 10, minLines: 1, @@ -183,7 +183,7 @@ Widget build(BuildContext context) { ], ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm/model.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm/model.md index bbf439e8186..d1f853843b9 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm/model.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm/model.md @@ -11,7 +11,7 @@ [CreateEventViewModel](../../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md) model -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_page/CreateEventPage-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_page/CreateEventPage-class.md index eae27c46b76..8d5ae5eee69 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_page/CreateEventPage-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_page/CreateEventPage-class.md @@ -11,16 +11,16 @@ -

CreateEventPage returns a widget that has mutable state _CreateEventPageState.

+\CreateEventPage returns a widget that has mutable state _CreateEventPageState.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html) - CreateEventPage @@ -32,37 +32,37 @@ ## Constructors -[CreateEventPage](../views_after_auth_screens_events_create_event_page/CreateEventPage/CreateEventPage.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +[CreateEventPage](../views_after_auth_screens_events_create_event_page/CreateEventPage/CreateEventPage.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -70,12 +70,12 @@ _read-onlyinherited_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a
StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ @@ -84,81 +84,81 @@ _inherited_ Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -166,12 +166,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_page/CreateEventPage/CreateEventPage.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_page/CreateEventPage/CreateEventPage.md index 3692c4ee96f..a2f92e0ee32 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_page/CreateEventPage/CreateEventPage.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_page/CreateEventPage/CreateEventPage.md @@ -9,7 +9,7 @@ const -CreateEventPage({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +CreateEventPage(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) @@ -18,7 +18,7 @@ CreateEventPage({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html ## Implementation ```dart -const CreateEventPage({Key? key}) : super(key: key); +const CreateEventPage(\{Key? key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_page/CreateEventPage/createState.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_page/CreateEventPage/createState.md index 2b79419a36f..b7ef8598859 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_page/CreateEventPage/createState.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_create_event_page/CreateEventPage/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) _CreateEventPageState createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -79,12 +79,12 @@ _read-onlyinherited_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ @@ -93,81 +93,81 @@ _inherited_ Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -175,12 +175,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_edit_event_page/EditEventPage/EditEventPage.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_edit_event_page/EditEventPage/EditEventPage.md index 101f34c3d25..b55ff20b9cf 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_edit_event_page/EditEventPage/EditEventPage.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_edit_event_page/EditEventPage/EditEventPage.md @@ -9,7 +9,7 @@ const -EditEventPage({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Event](../../models_events_event_model/Event-class.md) event}) +EditEventPage(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Event](../../models_events_event_model/Event-class.md) event\}) @@ -18,7 +18,7 @@ EditEventPage({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? ## Implementation ```dart -const EditEventPage({Key? key, required this.event}) : super(key: key); +const EditEventPage(\{Key? key, required this.event\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_edit_event_page/EditEventPage/createState.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_edit_event_page/EditEventPage/createState.md index f095ce13c68..ed48e3751b5 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_edit_event_page/EditEventPage/createState.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_edit_event_page/EditEventPage/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) _EditEventPageState createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm-class.md index 4b944f02139..a3fba43fdeb 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm-class.md @@ -11,17 +11,17 @@ -

EditEventForm returns a widget of a Form for editing an event. -This widget is used in EditEventPage widget.

+\EditEventForm returns a widget of a Form for editing an event. +This widget is used in EditEventPage widget.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - EditEventForm @@ -33,28 +33,28 @@ This widget is used in EditEventPage widget.

## Constructors -[EditEventForm](../views_after_auth_screens_events_edit_events_form/EditEventForm/EditEventForm.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [EditEventViewModel](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md) model}) +[EditEventForm](../views_after_auth_screens_events_edit_events_form/EditEventForm/EditEventForm.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [EditEventViewModel](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md) model\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ @@ -63,16 +63,16 @@ _finalinherited_ -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -80,95 +80,95 @@ _read-onlyinherited_ ## Methods -##### [build](../views_after_auth_screens_events_edit_events_form/EditEventForm/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../views_after_auth_screens_events_edit_events_form/EditEventForm/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -176,12 +176,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm/EditEventForm.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm/EditEventForm.md index 355dbe36f74..1ed57933c75 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm/EditEventForm.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm/EditEventForm.md @@ -9,7 +9,7 @@ const -EditEventForm({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [EditEventViewModel](../../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md) model}) +EditEventForm(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [EditEventViewModel](../../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md) model\}) @@ -18,7 +18,7 @@ EditEventForm({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? ## Implementation ```dart -const EditEventForm({Key? key, required this.model}) : super(key: key); +const EditEventForm(\{Key? key, required this.model\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm/build.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm/build.md index 586d7aeeacb..db68ad9feea 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm/build.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,21 +58,21 @@ and ```dart @override -Widget build(BuildContext context) { - // Form class is a container for grouping together multiple form field widgets. +Widget build(BuildContext context) \{ + Form class is a container for grouping together multiple form field widgets. return Form( key: model.formKey, child: Column( crossAxisAlignment: CrossAxisAlignment.start, children: [ - // Text field for event title. + Text field for event title. TextFormField( textInputAction: TextInputAction.next, controller: model.eventTitleTextController, keyboardType: TextInputType.name, maxLength: 20, focusNode: model.titleFocus, - validator: (value) => Validator.validateEventForm(value!, 'Title'), + validator: (value) =\> Validator.validateEventForm(value!, 'Title'), decoration: InputDecoration( labelText: 'Add Event Title', isDense: true, @@ -92,9 +92,9 @@ Widget build(BuildContext context) { ), ), suffixIcon: IconButton( - onPressed: () { + onPressed: () \{ FocusScope.of(context).requestFocus(model.titleFocus); - }, + \}, icon: const Icon(Icons.edit), ), ), @@ -102,13 +102,13 @@ Widget build(BuildContext context) { SizedBox( height: SizeConfig.screenHeight! * 0.013, ), - // Text field for the location. + Text field for the location. TextFormField( textInputAction: TextInputAction.next, keyboardType: TextInputType.streetAddress, controller: model.eventLocationTextController, focusNode: model.locationFocus, - validator: (value) => + validator: (value) =\> Validator.validateEventForm(value!, 'Location'), decoration: InputDecoration( hintText: 'Where is the event?', @@ -129,9 +129,9 @@ Widget build(BuildContext context) { ), ), suffixIcon: IconButton( - onPressed: () { + onPressed: () \{ FocusScope.of(context).requestFocus(model.locationFocus); - }, + \}, icon: const Icon(Icons.edit), ), ), @@ -139,12 +139,12 @@ Widget build(BuildContext context) { SizedBox( height: SizeConfig.screenHeight! * 0.013, ), - // Text field for event description. + Text field for event description. TextFormField( keyboardType: TextInputType.multiline, controller: model.eventDescriptionTextController, focusNode: model.descriptionFocus, - validator: (value) => + validator: (value) =\> Validator.validateEventForm(value!, 'Description'), maxLines: 10, minLines: 1, @@ -167,9 +167,9 @@ Widget build(BuildContext context) { ), ), suffixIcon: IconButton( - onPressed: () { + onPressed: () \{ FocusScope.of(context).requestFocus(model.descriptionFocus); - }, + \}, icon: const Icon(Icons.edit), ), ), @@ -177,7 +177,7 @@ Widget build(BuildContext context) { ], ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm/model.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm/model.md index 9cf984beb42..ba530b0e822 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm/model.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm/model.md @@ -11,7 +11,7 @@ [EditEventViewModel](../../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md) model -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_event_calendar/EventCalendar-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_event_calendar/EventCalendar-class.md index 5d56cb4be3e..35236ceb95c 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_event_calendar/EventCalendar-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_event_calendar/EventCalendar-class.md @@ -11,16 +11,16 @@ -

EventCalendar returns a widget that has mutable state _EventCalendarState.

+\EventCalendar returns a widget that has mutable state _EventCalendarState.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html) - EventCalendar @@ -32,46 +32,46 @@ ## Constructors -[EventCalendar](../views_after_auth_screens_events_event_calendar/EventCalendar/EventCalendar.md) ([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Event](../models_events_event_model/Event-class.md)> eventList, {[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +[EventCalendar](../views_after_auth_screens_events_event_calendar/EventCalendar/EventCalendar.md) ([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Event](../models_events_event_model/Event-class.md)\> eventList, \{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) _const_ ## Properties -##### [eventList](../views_after_auth_screens_events_event_calendar/EventCalendar/eventList.md) → [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Event](../models_events_event_model/Event-class.md)> +##### [eventList](../views_after_auth_screens_events_event_calendar/EventCalendar/eventList.md) → [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Event](../models_events_event_model/Event-class.md)\> -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -79,95 +79,95 @@ _read-onlyinherited_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a
StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [createState](../views_after_auth_screens_events_event_calendar/EventCalendar/createState.md)() [State](https://api.flutter.dev/flutter/widgets/State-class.html)<[EventCalendar](../views_after_auth_screens_events_event_calendar/EventCalendar-class.md)> +##### [createState](../views_after_auth_screens_events_event_calendar/EventCalendar/createState.md)() [State](https:api.flutter.dev/flutter/widgets/State-class.html)<[EventCalendar](../views_after_auth_screens_events_event_calendar/EventCalendar-class.md)\> Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -175,12 +175,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_event_calendar/EventCalendar/EventCalendar.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_event_calendar/EventCalendar/EventCalendar.md index 65f8fdce03d..2d394d72573 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_event_calendar/EventCalendar/EventCalendar.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_event_calendar/EventCalendar/EventCalendar.md @@ -9,7 +9,7 @@ const -EventCalendar([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Event](../../models_events_event_model/Event-class.md)> eventList, {[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +EventCalendar([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Event](../../models_events_event_model/Event-class.md)\> eventList, \{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) @@ -18,7 +18,7 @@ EventCalendar([List](https://api.flutter.dev/flutter/dart-core/List-class.html)& ## Implementation ```dart -const EventCalendar(this.eventList, {Key? key}) : super(key: key); +const EventCalendar(this.eventList, \{Key? key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_event_calendar/EventCalendar/createState.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_event_calendar/EventCalendar/createState.md index f0a5f419f05..e141c913aca 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_event_calendar/EventCalendar/createState.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_event_calendar/EventCalendar/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[EventCalendar](../../views_after_auth_screens_events_event_calendar/EventCalendar-class.md)> createState +[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[EventCalendar](../../views_after_auth_screens_events_event_calendar/EventCalendar-class.md)\> createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh final_ +_\final\_ @@ -21,7 +21,7 @@ _final_ ## Implementation ```dart -final List eventList; +final List\ eventList; ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_body/EventInfoBody-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_body/EventInfoBody-class.md index 17d306b078c..7071ac91132 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_body/EventInfoBody-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_body/EventInfoBody-class.md @@ -11,16 +11,16 @@ -

EventInfoBody returns a stateless widget which describes the body of a particular event.

+\EventInfoBody returns a stateless widget which describes the body of a particular event.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - EventInfoBody @@ -32,37 +32,37 @@ ## Constructors -[EventInfoBody](../views_after_auth_screens_events_event_info_body/EventInfoBody/EventInfoBody.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +[EventInfoBody](../views_after_auth_screens_events_event_info_body/EventInfoBody/EventInfoBody.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -70,95 +70,95 @@ _read-onlyinherited_ ## Methods -##### [build](../views_after_auth_screens_events_event_info_body/EventInfoBody/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../views_after_auth_screens_events_event_info_body/EventInfoBody/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -166,12 +166,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_body/EventInfoBody/EventInfoBody.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_body/EventInfoBody/EventInfoBody.md index f2834782c16..87123de4236 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_body/EventInfoBody/EventInfoBody.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_body/EventInfoBody/EventInfoBody.md @@ -9,7 +9,7 @@ const -EventInfoBody({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +EventInfoBody(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) @@ -18,7 +18,7 @@ EventInfoBody({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? ## Implementation ```dart -const EventInfoBody({Key? key}) : super(key: key); +const EventInfoBody(\{Key? key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_body/EventInfoBody/build.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_body/EventInfoBody/build.md index 5800dc4232f..9edf4a7654d 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_body/EventInfoBody/build.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_body/EventInfoBody/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,13 +58,13 @@ and ```dart @override -Widget build(BuildContext context) { - // fetching the event data from model - final model = Provider.of(context); +Widget build(BuildContext context) \{ + fetching the event data from model + final model = Provider.of\(context); final event = model.event; - // Slivers are special-purpose widgets that can be combined using a - //CustomScrollView to create custom scroll effects. A SliverToBoxAdapter - //is a basic sliver that creates a bridge back to one of the usual box-based widgets. + Slivers are special-purpose widgets that can be combined using a + CustomScrollView to create custom scroll effects. A SliverToBoxAdapter + is a basic sliver that creates a bridge back to one of the usual box-based widgets. return SliverToBoxAdapter( child: Padding( padding: const EdgeInsets.all(10), @@ -81,7 +81,7 @@ Widget build(BuildContext context) { children: [ Flexible( child: Text( - // event title + event title event.title!, style: Theme.of(context) .textTheme @@ -99,7 +99,7 @@ Widget build(BuildContext context) { children: [ (model.event.creator!.id == userConfig.currentUser.id) ? IconButton( - onPressed: () => navigationService.pushScreen( + onPressed: () =\> navigationService.pushScreen( "/editEventPage", arguments: model.event, ), @@ -113,8 +113,8 @@ Widget build(BuildContext context) { ], ), Text( - // Display event creator full name. - "${AppLocalizations.of(context)!.strictTranslate("Created by")}: ${event.creator!.firstName} ${event.creator!.lastName}", + Display event creator full name. + "$\{AppLocalizations.of(context)!.strictTranslate("Created by")\}: $\{event.creator!.firstName\} $\{event.creator!.lastName\}", style: Theme.of(context) .textTheme .bodyMedium! @@ -134,12 +134,12 @@ Widget build(BuildContext context) { width: SizeConfig.screenWidth! * 0.027, ), Text( - // Display start and end date of the Event. - "${event.startDate!} - ${event.endDate!}", + Display start and end date of the Event. + "$\{event.startDate!\} - $\{event.endDate!\}", style: Theme.of(context).textTheme.bodySmall, ), const Spacer(), - // If event type is public then renders lock_open icon else renders lock icon. + If event type is public then renders lock_open icon else renders lock icon. event.isPublic! ? Icon( Icons.lock_open, @@ -154,8 +154,8 @@ Widget build(BuildContext context) { SizedBox( width: SizeConfig.screenWidth! * 0.027, ), - // If event type is public then renders 'public' - // else renders 'private' text translated into the app language. + If event type is public then renders 'public' + else renders 'private' text translated into the app language. event.isPublic! ? Text( AppLocalizations.of(context)!.strictTranslate('public'), @@ -174,7 +174,7 @@ Widget build(BuildContext context) { Row( crossAxisAlignment: CrossAxisAlignment.start, children: [ - // display schedule icon with the start and end date of the time. + display schedule icon with the start and end date of the time. const Icon( Icons.schedule, size: 12, @@ -183,7 +183,7 @@ Widget build(BuildContext context) { width: SizeConfig.screenWidth! * 0.025, ), Text( - "${event.startTime!} - ${event.endTime!}", + "$\{event.startTime!\} - $\{event.endTime!\}", style: Theme.of(context).textTheme.bodySmall, ), ], @@ -209,16 +209,16 @@ Widget build(BuildContext context) { maxLines: 3, ), const Spacer(), - // If the event location is not null then display the location - //on the map with the reference of latitude and longitude provided for the event. + If the event location is not null then display the location + on the map with the reference of latitude and longitude provided for the event. if (event.latitude != null && event.longitude != null) GestureDetector( - onTap: () => navigationService.pushScreen( + onTap: () =\> navigationService.pushScreen( Routes.mapScreen, - arguments: { + arguments: \{ "latitude": event.latitude, "longitude": event.longitude, - }, + \}, ), child: Text( 'View on map', @@ -245,7 +245,7 @@ Widget build(BuildContext context) { ), SizedBox(width: SizeConfig.screenWidth! * 0.013), Text( - // Display the Description of the event if not null. + Display the Description of the event if not null. event.description!, style: Theme.of(context).textTheme.bodySmall, ), @@ -266,17 +266,17 @@ Widget build(BuildContext context) { physics: const NeverScrollableScrollPhysics(), shrinkWrap: true, itemCount: event.admins!.length, - itemBuilder: (BuildContext context, int index) { + itemBuilder: (BuildContext context, int index) \{ return CustomListTile( key: Key( - '${AppLocalizations.of(context)!.strictTranslate("Admins")}$index', + '$\{AppLocalizations.of(context)!.strictTranslate("Admins")\}$index', ), index: index, type: TileType.user, userInfo: event.admins![index], - onTapUserInfo: () {}, + onTapUserInfo: () \{\}, ); - }, + \}, ), SizedBox( height: SizeConfig.screenHeight! * 0.013, @@ -293,35 +293,35 @@ Widget build(BuildContext context) { thickness: 2, ), if (model.isBusy) - // if the model is still fetching the attendees details then display Circular Progress Indicator Icon. + if the model is still fetching the attendees details then display Circular Progress Indicator Icon. const Padding( padding: EdgeInsets.only(top: 12.0), child: Center(child: CircularProgressIndicator()), ) else - // else if the model fetched the attendees details successfully - //then renders all the attendees in ListView. + else if the model fetched the attendees details successfully + then renders all the attendees in ListView. ListView.builder( padding: EdgeInsets.zero, shrinkWrap: true, itemCount: model.registrants.length, - itemBuilder: (BuildContext context, int index) { + itemBuilder: (BuildContext context, int index) \{ return CustomListTile( key: Key( - '${AppLocalizations.of(context)!.strictTranslate("Attendee")}$index', + '$\{AppLocalizations.of(context)!.strictTranslate("Attendee")\}$index', ), index: index, type: TileType.user, userInfo: model.registrants[index], - onTapUserInfo: () {}, + onTapUserInfo: () \{\}, ); - }, + \}, ) ], ), ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage-class.md index 10ec2c8e703..f1db35d59ac 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage-class.md @@ -11,16 +11,16 @@ -

EventInfoPage returns a widget that has mutable state _EventInfoPageState.

+\EventInfoPage returns a widget that has mutable state _EventInfoPageState.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html) - EventInfoPage @@ -32,46 +32,46 @@ ## Constructors -[EventInfoPage](../views_after_auth_screens_events_event_info_page/EventInfoPage/EventInfoPage.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> args}) +[EventInfoPage](../views_after_auth_screens_events_event_info_page/EventInfoPage/EventInfoPage.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> args\}) _const_ ## Properties -##### [args](../views_after_auth_screens_events_event_info_page/EventInfoPage/args.md) → [Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> +##### [args](../views_after_auth_screens_events_event_info_page/EventInfoPage/args.md) → [Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -79,12 +79,12 @@ _read-onlyinherited_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a
StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ @@ -93,81 +93,81 @@ _inherited_ Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -175,12 +175,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage/EventInfoPage.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage/EventInfoPage.md index f5629766689..533291e4f6a 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage/EventInfoPage.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage/EventInfoPage.md @@ -9,7 +9,7 @@ const -EventInfoPage({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> args}) +EventInfoPage(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> args\}) @@ -18,7 +18,7 @@ EventInfoPage({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? ## Implementation ```dart -const EventInfoPage({Key? key, required this.args}) : super(key: key); +const EventInfoPage(\{Key? key, required this.args\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage/args.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage/args.md index bc15ede0aaf..cd150d9c250 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage/args.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage/args.md @@ -9,9 +9,9 @@ -[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> args +[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> args -_final_ +_\final\_ @@ -21,7 +21,7 @@ _final_ ## Implementation ```dart -final Map args; +final Map\ args; ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage/createState.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage/createState.md index 40792cb7fe4..e2be189a0c9 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage/createState.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) _EventInfoPageState createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -70,12 +70,12 @@ _read-onlyinherited_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ @@ -84,81 +84,81 @@ _inherited_ Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -166,12 +166,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_explore_event_dialogue/ExploreEventDialog/ExploreEventDialog.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_explore_event_dialogue/ExploreEventDialog/ExploreEventDialog.md index a932b4294cf..cc863e81dbe 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_explore_event_dialogue/ExploreEventDialog/ExploreEventDialog.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_explore_event_dialogue/ExploreEventDialog/ExploreEventDialog.md @@ -9,7 +9,7 @@ const -ExploreEventDialog({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key}) +ExploreEventDialog(\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key\}) @@ -18,7 +18,7 @@ ExploreEventDialog({required [Key](https://api.flutter.dev/flutter/foundation/Ke ## Implementation ```dart -const ExploreEventDialog({required Key key}) : super(key: key); +const ExploreEventDialog(\{required Key key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_explore_event_dialogue/ExploreEventDialog/createState.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_explore_event_dialogue/ExploreEventDialog/createState.md index f864e77ec60..56151b2866e 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_explore_event_dialogue/ExploreEventDialog/createState.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_explore_event_dialogue/ExploreEventDialog/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) _ExploreEventDialogState createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh read-onlyinherited_ +_\read-only\\inherited\_ @@ -52,26 +52,26 @@ _read-onlyinherited_ -homeModal is a type of MainScreenViewModel which provides methods to handle the data for this component. -_final_ +\homeModal\ is a type of \MainScreenViewModel\ which provides methods to handle the data for this component. +_\final\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -79,104 +79,104 @@ _read-onlyinherited_ ## Methods -##### [build](../views_after_auth_screens_events_explore_events/ExploreEvents/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../views_after_auth_screens_events_explore_events/ExploreEvents/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [dropDownList](../views_after_auth_screens_events_explore_events/ExploreEvents/dropDownList.md)([ExploreEventsViewModel](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md) model, [BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [dropDownList](../views_after_auth_screens_events_explore_events/ExploreEvents/dropDownList.md)([ExploreEventsViewModel](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md) model, [BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) -Shows a list of dropdown taken from model and context. +Shows a list of dropdown taken from \model\ and \context\. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -184,12 +184,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/ExploreEvents.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/ExploreEvents.md index 8329f47a916..396ff2dd708 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/ExploreEvents.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/ExploreEvents.md @@ -9,7 +9,7 @@ const -ExploreEvents({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key, [MainScreenViewModel](../../view_model_main_screen_view_model/MainScreenViewModel-class.md)? homeModel}) +ExploreEvents(\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key, [MainScreenViewModel](../../view_model_main_screen_view_model/MainScreenViewModel-class.md)? homeModel\}) @@ -18,10 +18,10 @@ ExploreEvents({required [Key](https://api.flutter.dev/flutter/foundation/Key-cla ## Implementation ```dart -const ExploreEvents({ +const ExploreEvents(\{ required Key key, this.homeModel, -}) : super(key: key); +\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/build.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/build.md index fc8416b5171..87d4c04bbfb 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/build.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,13 +58,13 @@ and ```dart @override -Widget build(BuildContext context) { - return BaseView( - onModelReady: (model) => model.initialise(), - builder: (context, model, child) { +Widget build(BuildContext context) \{ + return BaseView\( + onModelReady: (model) =\> model.initialise(), + builder: (context, model, child) \{ return Scaffold( appBar: AppBar( - // AppBar returns widget for the header. + AppBar returns widget for the header. backgroundColor: Theme.of(context).primaryColor, key: const Key("ExploreEventsAppBar"), elevation: 0.0, @@ -78,10 +78,10 @@ Widget build(BuildContext context) { ), ), leading: IconButton( - // returns a button of menu icon to redirect to home. + returns a button of menu icon to redirect to home. color: Theme.of(context).iconTheme.color, icon: const Icon(Icons.menu), - onPressed: () => + onPressed: () =\> MainScreenViewModel.scaffoldKey.currentState!.openDrawer(), ), actions: [ @@ -89,10 +89,10 @@ Widget build(BuildContext context) { padding: EdgeInsets.only( right: SizeConfig.screenWidth! * 0.027, ), - // if the events is not empty then renders button for searching the events else renders just a box. + if the events is not empty then renders button for searching the events else renders just a box. child: model.events.isNotEmpty ? IconButton( - onPressed: () { + onPressed: () \{ showSearch( context: context, delegate: EventSearch( @@ -100,19 +100,19 @@ Widget build(BuildContext context) { exploreEventsViewModel: model, ), ); - }, + \}, icon: const Icon(Icons.search, size: 20), ) : const SizedBox(), ) ], ), - // if the model is still fetching the events list then renders the Circular Progress Indicator - // else render refresh icon along with the list of searched events for exploration. + if the model is still fetching the events list then renders the Circular Progress Indicator + else render refresh icon along with the list of searched events for exploration. body: model.isBusy ? const Center(child: CircularProgressIndicator()) : RefreshIndicator( - onRefresh: () async => model.refreshEvents(), + onRefresh: () async =\> model.refreshEvents(), child: Stack( children: [ SingleChildScrollView( @@ -138,7 +138,7 @@ Widget build(BuildContext context) { padding: const EdgeInsets.symmetric( horizontal: 20, ), - //width: SizeConfig.screenWidth! * 0.45, + width: SizeConfig.screenWidth! * 0.45, child: DropdownButtonHideUnderline( child: dropDownList(model, context), ), @@ -148,17 +148,17 @@ Widget build(BuildContext context) { Expanded( flex: 2, child: GestureDetector( - onTap: () { + onTap: () \{ showDialog( - // on tap open the Explore Event Dialog. + on tap open the Explore Event Dialog. context: context, - builder: (_) { + builder: (_) \{ return const ExploreEventDialog( key: Key('ExploreEvents'), ); - }, + \}, ); - }, + \}, child: Card( key: homeModel?.keySEDateFilter, color: Theme.of(context) @@ -168,7 +168,7 @@ Widget build(BuildContext context) { padding: const EdgeInsets.symmetric( vertical: 12, ), - // width: SizeConfig.screenWidth! * 0.30, + width: SizeConfig.screenWidth! * 0.30, child: Row( mainAxisAlignment: MainAxisAlignment.spaceEvenly, @@ -199,12 +199,12 @@ Widget build(BuildContext context) { .colorScheme .onPrimary, child: IconButton( - onPressed: () { + onPressed: () \{ navigationService.pushScreen( Routes.calendar, arguments: model.events, ); - }, + \}, icon: const Icon( Icons.calendar_month, ), @@ -216,8 +216,8 @@ Widget build(BuildContext context) { SizedBox( height: SizeConfig.screenHeight! * 0.027, ), - // if the events model is empty then renders a box with text as "Empty List" - // else renders lists of the all event tile. + if the events model is empty then renders a box with text as "Empty List" + else renders lists of the all event tile. model.events.isEmpty ? SizedBox( height: SizeConfig.screenHeight! * 0.5, @@ -231,23 +231,23 @@ Widget build(BuildContext context) { shrinkWrap: true, itemCount: model.events.length, itemBuilder: - (BuildContext context, int index) { + (BuildContext context, int index) \{ return GestureDetector( - onTap: () { + onTap: () \{ navigationService.pushScreen( "/eventInfo", - arguments: { + arguments: \{ "event": model.events[index], "exploreEventViewModel": model - }, + \}, ); - }, + \}, child: EventCard( event: model.events[index], isSearchItem: false, ), ); - }, + \}, ), ], ), @@ -260,11 +260,11 @@ Widget build(BuildContext context) { key: homeModel?.keySEAdd, heroTag: "AddEventFab", backgroundColor: Theme.of(context).colorScheme.background, - onPressed: () { + onPressed: () \{ navigationService.pushScreen( "/createEventPage", ); - }, + \}, icon: Icon( Icons.add, color: Theme.of(context).colorScheme.secondary, @@ -278,9 +278,9 @@ Widget build(BuildContext context) { ), ), ); - }, + \}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/dropDownList.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/dropDownList.md index ab1c95642e6..f010a02cee8 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/dropDownList.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/dropDownList.md @@ -10,42 +10,42 @@ -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) dropDownList -([ExploreEventsViewModel](../../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md) model, [BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) dropDownList +([ExploreEventsViewModel](../../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md) model, [BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -

Shows a list of dropdown taken from model and context.

-

params:

-
    -
  • model: contains the events data
  • -
  • context: the overall context of UI
  • -
-

returns:

-
    -
  • Widget: the dropdown
  • -
+\Shows a list of dropdown taken from \model\ and \context\.\ +\\params\:\ +\ +\\model\: contains the events data\ +\\context\: the overall context of UI\ +\ +\\returns\:\ +\ +\\Widget\: the dropdown\ +\ ## Implementation ```dart -Widget dropDownList(ExploreEventsViewModel model, BuildContext context) { - return DropdownButton( +Widget dropDownList(ExploreEventsViewModel model, BuildContext context) \{ + return DropdownButton\( key: homeModel?.keySECategoryMenu, value: model.chosenValue, isExpanded: true, - items: [ + items: \[ 'All Events', 'Created Events', 'Registered Events', 'Public Events', 'Private Events', - ].map>((String value) { - return DropdownMenuItem( + ].map\\>((String value) \{ + return DropdownMenuItem\( value: value, child: Text( AppLocalizations.of(context)!.strictTranslate(value), @@ -55,12 +55,12 @@ Widget dropDownList(ExploreEventsViewModel model, BuildContext context) { .copyWith(color: Theme.of(context).colorScheme.secondary), ), ); - }).toList(), - onChanged: (value) { + \}).toList(), + onChanged: (value) \{ model.choseValueFromDropdown(value!); - }, + \}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/homeModel.md b/docs/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/homeModel.md index 57574b7829d..490450e6156 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/homeModel.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/homeModel.md @@ -11,11 +11,11 @@ [MainScreenViewModel](../../view_model_main_screen_view_model/MainScreenViewModel-class.md)? homeModel -_final_ +_\final\_ -

homeModal is a type of MainScreenViewModel which provides methods to handle the data for this component.

+\\homeModal\ is a type of \MainScreenViewModel\ which provides methods to handle the data for this component.\ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate-class.md index fb53308d800..61eafd9fa40 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate-class.md @@ -11,16 +11,16 @@ -

CommentTemplate returns a widget of the individual user commented on the post.

+\CommentTemplate returns a widget of the individual user commented on the post.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - CommentTemplate @@ -32,7 +32,7 @@ ## Constructors -[CommentTemplate](../views_after_auth_screens_feed_individual_post/CommentTemplate/CommentTemplate.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Comment](../models_comment_comment_model/Comment-class.md) comment}) +[CommentTemplate](../views_after_auth_screens_feed_individual_post/CommentTemplate/CommentTemplate.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Comment](../models_comment_comment_model/Comment-class.md) comment\}) _const_ @@ -44,34 +44,34 @@ -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -79,95 +79,95 @@ _read-onlyinherited_ ## Methods -##### [build](../views_after_auth_screens_feed_individual_post/CommentTemplate/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../views_after_auth_screens_feed_individual_post/CommentTemplate/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -175,12 +175,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate/CommentTemplate.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate/CommentTemplate.md index 03d2489132a..2f9522c448d 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate/CommentTemplate.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate/CommentTemplate.md @@ -9,7 +9,7 @@ const -CommentTemplate({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Comment](../../models_comment_comment_model/Comment-class.md) comment}) +CommentTemplate(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Comment](../../models_comment_comment_model/Comment-class.md) comment\}) @@ -18,10 +18,10 @@ CommentTemplate({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html ## Implementation ```dart -const CommentTemplate({ +const CommentTemplate(\{ Key? key, required this.comment, -}) : super(key: key); +\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate/build.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate/build.md index 06c25c93490..b217d293e20 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate/build.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,7 +58,7 @@ and ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ return Row( crossAxisAlignment: CrossAxisAlignment.start, children: [ @@ -77,7 +77,7 @@ Widget build(BuildContext context) { Padding( padding: const EdgeInsets.only(bottom: 8.0), child: Text( - "${comment.creator!.firstName!} ${comment.creator!.lastName!}", + "$\{comment.creator!.firstName!\} $\{comment.creator!.lastName!\}", style: Theme.of(context).textTheme.bodyMedium, ), ), @@ -94,7 +94,7 @@ Widget build(BuildContext context) { ) ], ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate/comment.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate/comment.md index c6fe7ea8c0a..c46ca07dbfe 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate/comment.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate/comment.md @@ -11,7 +11,7 @@ [Comment](../../models_comment_comment_model/Comment-class.md) comment -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection-class.md index 9a1ff325d4c..c984bf39541 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection-class.md @@ -11,16 +11,16 @@ -

IndividualPageLikeSection returns a widget that show the list of all the users liked the post.

+\IndividualPageLikeSection returns a widget that show the list of all the users liked the post.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - IndividualPageLikeSection @@ -32,46 +32,46 @@ ## Constructors -[IndividualPageLikeSection](../views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/IndividualPageLikeSection.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[LikedBy](../models_post_post_model/LikedBy-class.md)> usersLiked}) +[IndividualPageLikeSection](../views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/IndividualPageLikeSection.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[LikedBy](../models_post_post_model/LikedBy-class.md)\> usersLiked\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [usersLiked](../views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/usersLiked.md) → [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[LikedBy](../models_post_post_model/LikedBy-class.md)> +##### [usersLiked](../views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/usersLiked.md) → [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[LikedBy](../models_post_post_model/LikedBy-class.md)\> -_final_ +_\final\_ @@ -79,95 +79,95 @@ _final_ ## Methods -##### [build](../views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -175,12 +175,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/IndividualPageLikeSection.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/IndividualPageLikeSection.md index 277f839a811..ac1161230d6 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/IndividualPageLikeSection.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/IndividualPageLikeSection.md @@ -9,7 +9,7 @@ const -IndividualPageLikeSection({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[LikedBy](../../models_post_post_model/LikedBy-class.md)> usersLiked}) +IndividualPageLikeSection(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[LikedBy](../../models_post_post_model/LikedBy-class.md)\> usersLiked\}) @@ -18,10 +18,10 @@ IndividualPageLikeSection({[Key](https://api.flutter.dev/flutter/foundation/Key- ## Implementation ```dart -const IndividualPageLikeSection({ +const IndividualPageLikeSection(\{ Key? key, required this.usersLiked, -}) : super(key: key); +\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/build.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/build.md index 3f7bb9e2c80..a23600a41de 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/build.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,22 +58,22 @@ and ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ return Column( crossAxisAlignment: CrossAxisAlignment.start, children: [ buildPadding(context, "Liked by"), Row( children: [ - // Looping through the usersLiked list, - for (int i = 0; i < usersLiked.length; i++) - // renders the custom widget for invidual user. + Looping through the usersLiked list, + for (int i = 0; i \< usersLiked.length; i++) + renders the custom widget for invidual user. likedUserCircleAvatar(usersLiked[i]) ], ), ], ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/usersLiked.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/usersLiked.md index 6a93bef9041..a23cab1f6fd 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/usersLiked.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/usersLiked.md @@ -9,9 +9,9 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[LikedBy](../../models_post_post_model/LikedBy-class.md)> usersLiked +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[LikedBy](../../models_post_post_model/LikedBy-class.md)\> usersLiked -_final_ +_\final\_ @@ -21,7 +21,7 @@ _final_ ## Implementation ```dart -final List usersLiked; +final List\ usersLiked; ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection-class.md index ee38a46c9e7..92254ed8a6f 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection-class.md @@ -11,16 +11,16 @@ -

IndividualPostCommentSection returns a widget that show the list of all the users commented on the post.

+\IndividualPostCommentSection returns a widget that show the list of all the users commented on the post.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - IndividualPostCommentSection @@ -32,55 +32,55 @@ ## Constructors -[IndividualPostCommentSection](../views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/IndividualPostCommentSection.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Comments](../models_post_post_model/Comments-class.md)> comments, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) postID}) +[IndividualPostCommentSection](../views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/IndividualPostCommentSection.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Comments](../models_post_post_model/Comments-class.md)\> comments, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) postID\}) _const_ ## Properties -##### [comments](../views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/comments.md) → [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Comments](../models_post_post_model/Comments-class.md)> +##### [comments](../views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/comments.md) → [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Comments](../models_post_post_model/Comments-class.md)\> -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [postID](../views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/postID.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [postID](../views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/postID.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -88,95 +88,95 @@ _read-onlyinherited_ ## Methods -##### [build](../views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -184,12 +184,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/IndividualPostCommentSection.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/IndividualPostCommentSection.md index 211002b58ce..28450208409 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/IndividualPostCommentSection.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/IndividualPostCommentSection.md @@ -9,7 +9,7 @@ const -IndividualPostCommentSection({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Comments](../../models_post_post_model/Comments-class.md)> comments, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) postID}) +IndividualPostCommentSection(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Comments](../../models_post_post_model/Comments-class.md)\> comments, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) postID\}) @@ -18,11 +18,11 @@ IndividualPostCommentSection({[Key](https://api.flutter.dev/flutter/foundation/K ## Implementation ```dart -const IndividualPostCommentSection({ +const IndividualPostCommentSection(\{ Key? key, required this.comments, required this.postID, -}) : super(key: key); +\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/build.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/build.md index 09d6c82d3d4..575e3334a55 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/build.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,25 +58,25 @@ and ```dart @override -Widget build(BuildContext context) { - return BaseView( - onModelReady: (model) async { +Widget build(BuildContext context) \{ + return BaseView\( + onModelReady: (model) async \{ await model.initialise(postID); - // print(model.commentList.first.creator); + print(model.commentList.first.creator); _commentViewModel = model; - }, - builder: (context, model, child) => Column( + \}, + builder: (context, model, child) =\> Column( crossAxisAlignment: CrossAxisAlignment.start, children: [ buildPadding(context, "Comments"), - // Looping through the commentList list, - for (int i = 0; i < model.commentList.length; i++) - // renders the custom widget for invidual user. + Looping through the commentList list, + for (int i = 0; i \< model.commentList.length; i++) + renders the custom widget for invidual user. CommentTemplate(comment: model.commentList[i]) ], ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/comments.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/comments.md index 0276c53d66a..5b17f4a4ec0 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/comments.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/comments.md @@ -9,9 +9,9 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Comments](../../models_post_post_model/Comments-class.md)> comments +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Comments](../../models_post_post_model/Comments-class.md)\> comments -_final_ +_\final\_ @@ -21,7 +21,7 @@ _final_ ## Implementation ```dart -final List comments; +final List\ comments; ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/postID.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/postID.md index 9e5c5243b3e..1aeaa7c55ba 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/postID.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/postID.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) postID +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) postID -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostView-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostView-class.md index 453fc8cf29e..ef23e3bd004 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostView-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostView-class.md @@ -11,16 +11,16 @@ -

IndividualPostView returns a widget that has mutable state _IndividualPostViewState.

+\IndividualPostView returns a widget that has mutable state _IndividualPostViewState.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html) - IndividualPostView @@ -32,28 +32,28 @@ ## Constructors -[IndividualPostView](../views_after_auth_screens_feed_individual_post/IndividualPostView/IndividualPostView.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Post](../models_post_post_model/Post-class.md) post}) +[IndividualPostView](../views_after_auth_screens_feed_individual_post/IndividualPostView/IndividualPostView.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Post](../models_post_post_model/Post-class.md) post\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ @@ -62,16 +62,16 @@ _finalinherited_ -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -79,12 +79,12 @@ _read-onlyinherited_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a
StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ @@ -93,81 +93,81 @@ _inherited_ Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -175,12 +175,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostView/IndividualPostView.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostView/IndividualPostView.md index 46d96357295..9ab183d358e 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostView/IndividualPostView.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostView/IndividualPostView.md @@ -9,7 +9,7 @@ const -IndividualPostView({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Post](../../models_post_post_model/Post-class.md) post}) +IndividualPostView(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Post](../../models_post_post_model/Post-class.md) post\}) @@ -18,7 +18,7 @@ IndividualPostView({[Key](https://api.flutter.dev/flutter/foundation/Key-class.h ## Implementation ```dart -const IndividualPostView({Key? key, required this.post}) : super(key: key); +const IndividualPostView(\{Key? key, required this.post\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostView/createState.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostView/createState.md index dfbb3d183ab..331e7d1ac4d 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostView/createState.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostView/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) _IndividualPostViewState createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/buildPadding.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/buildPadding.md index a98749bed0c..efb91d6cbe5 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/buildPadding.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/buildPadding.md @@ -12,8 +12,8 @@ -[Padding](https://api.flutter.dev/flutter/widgets/Padding-class.html) buildPadding -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) text) +[Padding](https:api.flutter.dev/flutter/widgets/Padding-class.html) buildPadding +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) text) @@ -25,7 +25,7 @@ ## Implementation ```dart -Padding buildPadding(BuildContext context, String text) { +Padding buildPadding(BuildContext context, String text) \{ return Padding( padding: const EdgeInsets.symmetric(vertical: 8.0), child: Text( @@ -33,7 +33,7 @@ Padding buildPadding(BuildContext context, String text) { style: Theme.of(context).textTheme.titleLarge, ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/likedUserCircleAvatar.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/likedUserCircleAvatar.md index fb2e6b9a927..3e333bfd030 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/likedUserCircleAvatar.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/likedUserCircleAvatar.md @@ -12,21 +12,21 @@ -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) likedUserCircleAvatar +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) likedUserCircleAvatar ([LikedBy](../models_post_post_model/LikedBy-class.md) user) -

likedUserCircleAvatar returns a widget of the individual user liked the post.

+\likedUserCircleAvatar returns a widget of the individual user liked the post.\ ## Implementation ```dart -Widget likedUserCircleAvatar(LikedBy user) { +Widget likedUserCircleAvatar(LikedBy user) \{ return Padding( padding: const EdgeInsets.only(right: 10.0, bottom: 16.0), child: Stack( @@ -51,7 +51,7 @@ Widget likedUserCircleAvatar(LikedBy user) { ], ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/views_after_auth_screens_feed_individual_post-library.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/views_after_auth_screens_feed_individual_post-library.md index 1f2f4b6155a..7e793a6d6f6 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/views_after_auth_screens_feed_individual_post-library.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/views_after_auth_screens_feed_individual_post-library.md @@ -51,7 +51,7 @@ IndividualPostView returns a widget that has mutable state _IndividualPostViewSt ## Functions -##### [buildPadding](../views_after_auth_screens_feed_individual_post/buildPadding.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) text) [Padding](https://api.flutter.dev/flutter/widgets/Padding-class.html) +##### [buildPadding](../views_after_auth_screens_feed_individual_post/buildPadding.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) text) [Padding](https:api.flutter.dev/flutter/widgets/Padding-class.html) @@ -60,7 +60,7 @@ IndividualPostView returns a widget that has mutable state _IndividualPostViewSt -##### [likedUserCircleAvatar](../views_after_auth_screens_feed_individual_post/likedUserCircleAvatar.md)([LikedBy](../models_post_post_model/LikedBy-class.md) user) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [likedUserCircleAvatar](../views_after_auth_screens_feed_individual_post/likedUserCircleAvatar.md)([LikedBy](../models_post_post_model/LikedBy-class.md) user) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed-class.md index 8c5de718cfa..b66de496bc4 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed-class.md @@ -11,16 +11,16 @@ -

OrganizationFeed returns a widget that shows the feed of the organization.

+\OrganizationFeed returns a widget that shows the feed of the organization.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - OrganizationFeed @@ -32,28 +32,28 @@ ## Constructors -[OrganizationFeed](../views_after_auth_screens_feed_organization_feed/OrganizationFeed/OrganizationFeed.md) ({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key, [MainScreenViewModel](../view_model_main_screen_view_model/MainScreenViewModel-class.md)? homeModel, [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) forTest = false}) +[OrganizationFeed](../views_after_auth_screens_feed_organization_feed/OrganizationFeed/OrganizationFeed.md) (\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key, [MainScreenViewModel](../view_model_main_screen_view_model/MainScreenViewModel-class.md)? homeModel, [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) forTest = false\}) _const_ ## Properties -##### [forTest](../views_after_auth_screens_feed_organization_feed/OrganizationFeed/forTest.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [forTest](../views_after_auth_screens_feed_organization_feed/OrganizationFeed/forTest.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -62,25 +62,25 @@ _read-onlyinherited_ -_final_ +_\final\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -88,95 +88,95 @@ _read-onlyinherited_ ## Methods -##### [build](../views_after_auth_screens_feed_organization_feed/OrganizationFeed/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../views_after_auth_screens_feed_organization_feed/OrganizationFeed/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -184,12 +184,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/OrganizationFeed.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/OrganizationFeed.md index 553285ef8d7..9f608b29a7f 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/OrganizationFeed.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/OrganizationFeed.md @@ -9,7 +9,7 @@ const -OrganizationFeed({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key, [MainScreenViewModel](../../view_model_main_screen_view_model/MainScreenViewModel-class.md)? homeModel, [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) forTest = false}) +OrganizationFeed(\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key, [MainScreenViewModel](../../view_model_main_screen_view_model/MainScreenViewModel-class.md)? homeModel, [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) forTest = false\}) @@ -18,11 +18,11 @@ OrganizationFeed({required [Key](https://api.flutter.dev/flutter/foundation/Key- ## Implementation ```dart -const OrganizationFeed({ +const OrganizationFeed(\{ required Key key, this.homeModel, this.forTest = false, -}) : super(key: key); +\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/build.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/build.md index 271b6e9d50a..9c52b9d81e6 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/build.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,13 +58,13 @@ and ```dart @override -Widget build(BuildContext context) { - return BaseView( - onModelReady: (model) => model.initialise(isTest: forTest), - builder: (context, model, child) { +Widget build(BuildContext context) \{ + return BaseView\( + onModelReady: (model) =\> model.initialise(isTest: forTest), + builder: (context, model, child) \{ return Scaffold( appBar: AppBar( - // AppBar returns a widget for the header of the page. + AppBar returns a widget for the header of the page. backgroundColor: Theme.of(context).primaryColor, elevation: 0.0, centerTitle: true, @@ -82,19 +82,19 @@ Widget build(BuildContext context) { Icons.menu, color: Theme.of(context).iconTheme.color, ), - onPressed: () => + onPressed: () =\> MainScreenViewModel.scaffoldKey.currentState!.openDrawer(), ), ), - // if the model is fetching the data then renders Circular Progress Indicator else renders the result. + if the model is fetching the data then renders Circular Progress Indicator else renders the result. body: model.isBusy ? const CircularProgressIndicator() : RefreshIndicator( - onRefresh: () async => model.fetchNewPosts(), + onRefresh: () async =\> model.fetchNewPosts(), child: ListView( shrinkWrap: true, children: [ - // If the organization has pinned posts then renders PinnedPostCarousel widget else Container. + If the organization has pinned posts then renders PinnedPostCarousel widget else Container. model.pinnedPosts.isNotEmpty ? PinnedPostCarousel( key: homeModel?.keySHPinnedPost, @@ -105,7 +105,7 @@ Widget build(BuildContext context) { model.navigateToIndividualPage, ) : Container(), - // If the organization has posts then renders PostListWidget widget else Container. + If the organization has posts then renders PostListWidget widget else Container. model.posts.isNotEmpty ? PostListWidget( key: homeModel?.keySHPost, @@ -117,9 +117,9 @@ Widget build(BuildContext context) { ), ), ); - }, + \}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/forTest.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/forTest.md index 6505e3f01ee..6432f197e0f 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/forTest.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/forTest.md @@ -9,9 +9,9 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) forTest +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) forTest -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/homeModel.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/homeModel.md index d7359e06122..d9fd6914012 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/homeModel.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/homeModel.md @@ -11,7 +11,7 @@ [MainScreenViewModel](../../view_model_main_screen_view_model/MainScreenViewModel-class.md)? homeModel -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage-class.md index 03e0b0a904d..72a3021f3c4 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage-class.md @@ -11,16 +11,16 @@ -

PinnedPostPage returns a widget that shows the list of all the pinned post.

+\PinnedPostPage returns a widget that shows the list of all the pinned post.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - PinnedPostPage @@ -32,46 +32,46 @@ ## Constructors -[PinnedPostPage](../views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/PinnedPostPage.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../models_post_post_model/Post-class.md)> pinnedPosts}) +[PinnedPostPage](../views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/PinnedPostPage.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../models_post_post_model/Post-class.md)\> pinnedPosts\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [pinnedPosts](../views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/pinnedPosts.md) → [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../models_post_post_model/Post-class.md)> +##### [pinnedPosts](../views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/pinnedPosts.md) → [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../models_post_post_model/Post-class.md)\> -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -79,95 +79,95 @@ _read-onlyinherited_ ## Methods -##### [build](../views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -175,12 +175,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/PinnedPostPage.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/PinnedPostPage.md index e0f59c0c650..0d003983642 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/PinnedPostPage.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/PinnedPostPage.md @@ -9,7 +9,7 @@ const -PinnedPostPage({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)> pinnedPosts}) +PinnedPostPage(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)\> pinnedPosts\}) @@ -18,7 +18,7 @@ PinnedPostPage({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html) ## Implementation ```dart -const PinnedPostPage({Key? key, required this.pinnedPosts}) : super(key: key); +const PinnedPostPage(\{Key? key, required this.pinnedPosts\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/build.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/build.md index 17efc176839..8bdc06eed99 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/build.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,7 +58,7 @@ and ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ return Scaffold( appBar: AppBar( iconTheme: Theme.of(context).iconTheme, @@ -76,7 +76,7 @@ Widget build(BuildContext context) { children: [PostListWidget(posts: pinnedPosts)], ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/pinnedPosts.md b/docs/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/pinnedPosts.md index 4071846ea2c..c30dd276075 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/pinnedPosts.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/pinnedPosts.md @@ -9,9 +9,9 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)> pinnedPosts +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)\> pinnedPosts -_final_ +_\final\_ @@ -21,7 +21,7 @@ _final_ ## Implementation ```dart -final List pinnedPosts; +final List\ pinnedPosts; ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest-class.md index c490c40bc3a..a97ec53525e 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest-class.md @@ -11,16 +11,16 @@ -

requestAccess

+\requestAccess\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - SendAccessRequest @@ -32,28 +32,28 @@ ## Constructors -[SendAccessRequest](../views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/SendAccessRequest.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [OrgInfo](../models_organization_org_info/OrgInfo-class.md) org}) +[SendAccessRequest](../views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/SendAccessRequest.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [OrgInfo](../models_organization_org_info/OrgInfo-class.md) org\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ @@ -62,16 +62,16 @@ _finalinherited_ -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -79,95 +79,95 @@ _read-onlyinherited_ ## Methods -##### [build](../views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -175,12 +175,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/SendAccessRequest.md b/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/SendAccessRequest.md index 40408e8de76..7255396cb47 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/SendAccessRequest.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/SendAccessRequest.md @@ -9,7 +9,7 @@ const -SendAccessRequest({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [OrgInfo](../../models_organization_org_info/OrgInfo-class.md) org}) +SendAccessRequest(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [OrgInfo](../../models_organization_org_info/OrgInfo-class.md) org\}) @@ -18,11 +18,11 @@ SendAccessRequest({[Key](https://api.flutter.dev/flutter/foundation/Key-class.ht ## Implementation ```dart -const SendAccessRequest({ +const SendAccessRequest(\{ Key? key, required this.org, - // required this.model -}) : super(key: key); + required this.model +\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/build.md b/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/build.md index 64d8efddebc..8cfe1a5b009 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/build.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,10 +58,10 @@ and ```dart @override -Widget build(BuildContext context) { - return BaseView( - onModelReady: (model) => model.initialise(org), - builder: (context, model, child) { +Widget build(BuildContext context) \{ + return BaseView\( + onModelReady: (model) =\> model.initialise(org), + builder: (context, model, child) \{ return SafeArea( child: Scaffold( appBar: AppBar( @@ -122,9 +122,9 @@ Widget build(BuildContext context) { ), Center( child: TextButton( - onPressed: () { + onPressed: () \{ model.sendMembershipRequest(); - }, + \}, style: TextButton.styleFrom(backgroundColor: AppTheme.green), child: const Text( @@ -139,9 +139,9 @@ Widget build(BuildContext context) { ), ), ); - }, + \}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/org.md b/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/org.md index 5aa35421b67..3c96ec19146 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/org.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/org.md @@ -11,7 +11,7 @@ [OrgInfo](../../models_organization_org_info/OrgInfo-class.md) org -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth-class.md index dfd63ddc79b..a6607d612f5 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth-class.md @@ -11,16 +11,16 @@ -

JoinOrganisationAfterAuth returns a widget for page to join the organization just after user authentication.

+\JoinOrganisationAfterAuth returns a widget for page to join the organization just after user authentication.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - JoinOrganisationAfterAuth @@ -32,46 +32,46 @@ ## Constructors -[JoinOrganisationAfterAuth](../views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/JoinOrganisationAfterAuth.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId}) +[JoinOrganisationAfterAuth](../views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/JoinOrganisationAfterAuth.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) orgId\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [orgId](../views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/orgId.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [orgId](../views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/orgId.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -79,53 +79,53 @@ _read-onlyinherited_ ## Methods -##### [build](../views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [scanQR](../views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/scanQR.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context, [SelectOrganizationViewModel](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md) model) void +##### [scanQR](../views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/scanQR.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context, [SelectOrganizationViewModel](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md) model) void @@ -134,49 +134,49 @@ scanQR returns a widget that is use in joining the organization via the QR code. -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -184,12 +184,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/JoinOrganisationAfterAuth.md b/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/JoinOrganisationAfterAuth.md index 1b9db464b5d..19fb7cbcf4f 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/JoinOrganisationAfterAuth.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/JoinOrganisationAfterAuth.md @@ -9,7 +9,7 @@ const -JoinOrganisationAfterAuth({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId}) +JoinOrganisationAfterAuth(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) orgId\}) @@ -18,7 +18,7 @@ JoinOrganisationAfterAuth({[Key](https://api.flutter.dev/flutter/foundation/Key- ## Implementation ```dart -const JoinOrganisationAfterAuth({Key? key, required this.orgId}) +const JoinOrganisationAfterAuth(\{Key? key, required this.orgId\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/build.md b/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/build.md index b5cbaa0c5b8..8f2690ae06d 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/build.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,16 +58,16 @@ and ```dart @override -Widget build(BuildContext context) { - return BaseView( - onModelReady: (model) => model.initialise(orgId), - builder: (context, model, child) { +Widget build(BuildContext context) \{ + return BaseView\( + onModelReady: (model) =\> model.initialise(orgId), + builder: (context, model, child) \{ return Scaffold( key: const Key('JoinOrgScreen'), - // header for the widget + header for the widget appBar: AppBar( centerTitle: true, - // title of the header. + title of the header. title: Text( AppLocalizations.of(context)! .strictTranslate('Join Organisation'), @@ -76,7 +76,7 @@ Widget build(BuildContext context) { fontSize: 20, ), ), - // action button for the option to join the organization using QR code. + action button for the option to join the organization using QR code. actions: [ IconButton( icon: const Icon( @@ -84,7 +84,7 @@ Widget build(BuildContext context) { size: 30, semanticLabel: 'Join Organisation with QR', ), - onPressed: () => scanQR(context, model), + onPressed: () =\> scanQR(context, model), ), ], ), @@ -98,8 +98,8 @@ Widget build(BuildContext context) { ), ), Expanded( - // if model searching is under process then renders OrganizationSearchList widget - // else renders OrganizationList widget. + if model searching is under process then renders OrganizationSearchList widget + else renders OrganizationList widget. child: model.searching ? OrganizationSearchList(model: model) : OrganizationList(model: model), @@ -110,9 +110,9 @@ Widget build(BuildContext context) { ], ), ); - }, + \}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/orgId.md b/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/orgId.md index 31711766846..ac79c3a77cc 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/orgId.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/orgId.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) orgId -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/scanQR.md b/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/scanQR.md index f660938f287..20c547aafff 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/scanQR.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/scanQR.md @@ -11,20 +11,20 @@ void scanQR -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context, [SelectOrganizationViewModel](../../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md) model) +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context, [SelectOrganizationViewModel](../../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md) model) -

scanQR returns a widget that is use in joining the organization via the QR code.

+\scanQR returns a widget that is use in joining the organization via the QR code.\ ## Implementation ```dart -void scanQR(BuildContext context, SelectOrganizationViewModel model) { +void scanQR(BuildContext context, SelectOrganizationViewModel model) \{ showModalBottomSheet( context: context, barrierColor: Colors.transparent, @@ -34,7 +34,7 @@ void scanQR(BuildContext context, SelectOrganizationViewModel model) { topRight: Radius.circular(30), ), ), - builder: (BuildContext context) { + builder: (BuildContext context) \{ return ClipRRect( borderRadius: const BorderRadius.only( topLeft: Radius.circular(30), @@ -53,7 +53,7 @@ void scanQR(BuildContext context, SelectOrganizationViewModel model) { width: 250, child: QRView( key: model.qrKey, - onQRViewCreated: (controller) => + onQRViewCreated: (controller) =\> _onQRViewCreated(controller, model), overlay: QrScannerOverlayShape( overlayColor: Theme.of(context).colorScheme.secondary, @@ -76,9 +76,9 @@ void scanQR(BuildContext context, SelectOrganizationViewModel model) { ), ), ); - }, + \}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_profile_edit_profile_page/EditProfilePage-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_profile_edit_profile_page/EditProfilePage-class.md index 62aad176932..e81c8978afe 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_profile_edit_profile_page/EditProfilePage-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_profile_edit_profile_page/EditProfilePage-class.md @@ -11,16 +11,16 @@ -

EditProfilePage returns a widget that has mutable state _EditProfilePageState.

+\EditProfilePage returns a widget that has mutable state _EditProfilePageState.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html) - EditProfilePage @@ -32,37 +32,37 @@ ## Constructors -[EditProfilePage](../views_after_auth_screens_profile_edit_profile_page/EditProfilePage/EditProfilePage.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +[EditProfilePage](../views_after_auth_screens_profile_edit_profile_page/EditProfilePage/EditProfilePage.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -70,12 +70,12 @@ _read-onlyinherited_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a
StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ @@ -84,81 +84,81 @@ _inherited_ Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -166,12 +166,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_profile_edit_profile_page/EditProfilePage/EditProfilePage.md b/docs/talawa-mobile-docs/views_after_auth_screens_profile_edit_profile_page/EditProfilePage/EditProfilePage.md index 54f963a39f8..5d2373db106 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_profile_edit_profile_page/EditProfilePage/EditProfilePage.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_profile_edit_profile_page/EditProfilePage/EditProfilePage.md @@ -9,7 +9,7 @@ const -EditProfilePage({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +EditProfilePage(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) @@ -18,7 +18,7 @@ EditProfilePage({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html ## Implementation ```dart -const EditProfilePage({Key? key}) : super(key: key); +const EditProfilePage(\{Key? key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_profile_edit_profile_page/EditProfilePage/createState.md b/docs/talawa-mobile-docs/views_after_auth_screens_profile_edit_profile_page/EditProfilePage/createState.md index cb46e96d331..017f839fa8d 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_profile_edit_profile_page/EditProfilePage/createState.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_profile_edit_profile_page/EditProfilePage/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) _EditProfilePageState createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh read-onlyinherited_ +_\read-only\\inherited\_ @@ -53,25 +53,25 @@ _read-onlyinherited_ -_final_ +_\final\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -79,44 +79,44 @@ _read-onlyinherited_ ## Methods -##### [build](../views_after_auth_screens_profile_profile_page/ProfilePage/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../views_after_auth_screens_profile_profile_page/ProfilePage/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [donate](../views_after_auth_screens_profile_profile_page/ProfilePage/donate.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context, [ProfilePageViewModel](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md) model) void +##### [donate](../views_after_auth_screens_profile_profile_page/ProfilePage/donate.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context, [ProfilePageViewModel](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md) model) void @@ -125,58 +125,58 @@ _inherited_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -184,12 +184,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/ProfilePage.md b/docs/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/ProfilePage.md index 2007523608e..56a5a7dd0f4 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/ProfilePage.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/ProfilePage.md @@ -9,7 +9,7 @@ const -ProfilePage({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key, [MainScreenViewModel](../../view_model_main_screen_view_model/MainScreenViewModel-class.md)? homeModel}) +ProfilePage(\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key, [MainScreenViewModel](../../view_model_main_screen_view_model/MainScreenViewModel-class.md)? homeModel\}) @@ -18,10 +18,10 @@ ProfilePage({required [Key](https://api.flutter.dev/flutter/foundation/Key-class ## Implementation ```dart -const ProfilePage({ +const ProfilePage(\{ required Key key, this.homeModel, -}) : super(key: key); +\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/build.md b/docs/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/build.md index b4a084ed519..ac78cc7e708 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/build.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,10 +58,10 @@ and ```dart @override -Widget build(BuildContext context) { - return BaseView( - onModelReady: (model) => model.initialize(), - builder: (context, model, child) { +Widget build(BuildContext context) \{ + return BaseView\( + onModelReady: (model) =\> model.initialize(), + builder: (context, model, child) \{ return Scaffold( key: model.scaffoldKey, appBar: AppBar( @@ -71,7 +71,7 @@ Widget build(BuildContext context) { leading: IconButton( color: Theme.of(context).iconTheme.color, icon: const Icon(Icons.menu), - onPressed: () => + onPressed: () =\> MainScreenViewModel.scaffoldKey.currentState!.openDrawer(), ), key: const Key("ProfilePageAppBar"), @@ -83,8 +83,8 @@ Widget build(BuildContext context) { ), ), ), - // if data fetching is under process then renders Circular Progress Icon - // else renders the widget. + if data fetching is under process then renders Circular Progress Icon + else renders the widget. body: model.isBusy ? const CircularProgressIndicator() : SingleChildScrollView( @@ -98,7 +98,7 @@ Widget build(BuildContext context) { index: 0, type: TileType.option, option: Options( - // Avatar + Avatar icon: CustomAvatar( isImageNull: model.currentUser.image == null, firstAlphabet: @@ -109,34 +109,33 @@ Widget build(BuildContext context) { .titleLarge! .fontSize, ), - // display first and last name. + display first and last name. title: - '${model.currentUser.firstName!} ${model.currentUser.lastName!}', - // display email address + '$\{model.currentUser.firstName!\} $\{model.currentUser.lastName!\}', + display email address subtitle: model.currentUser.email!, - // button to edit the profile which redirects to edit profile page. + button to edit the profile which redirects to edit profile page. trailingIconButton: IconButton( icon: Icon( Icons.drive_file_rename_outline, color: Theme.of(context).colorScheme.secondary, ), - onPressed: () { + onPressed: () \{ navigationService.pushScreen("/editProfilePage"); - }, + \}, ), ), - onTapOption: () {}, + onTapOption: () \{\}, ), const Divider( - thickness: 1, // thickness of the line + thickness: 1, thickness of the line indent: - 20, // empty space to the leading edge of divider. + 20, empty space to the leading edge of divider. endIndent: - 20, // empty space to the trailing edge of the divider. + 20, empty space to the trailing edge of the divider. color: Colors - .black26, // The color to use when painting the line. - height: 20, // - ), + .black26, The color to use when painting the line. + height: 20, ), SizedBox( height: SizeConfig.screenHeight! * 0.67, child: Column( @@ -156,18 +155,18 @@ Widget build(BuildContext context) { Theme.of(context).colorScheme.secondary, size: 30, ), - // title for App Settings. + title for App Settings. title: AppLocalizations.of(context)! .strictTranslate('App Settings'), - // display language of the app. + display language of the app. subtitle: - '${AppLocalizations.of(context)!.strictTranslate("Language")}, ${AppLocalizations.of(context)!.strictTranslate("dark mode")}, ${AppLocalizations.of(context)!.strictTranslate("font size")}', + '$\{AppLocalizations.of(context)!.strictTranslate("Language")\}, $\{AppLocalizations.of(context)!.strictTranslate("dark mode")\}, $\{AppLocalizations.of(context)!.strictTranslate("font size")\}', ), - // button for the app setting which redirects to app setting page. - onTapOption: () { + button for the app setting which redirects to app setting page. + onTapOption: () \{ navigationService .pushScreen("/appSettingsPage"); - }, + \}, ), SizedBox( height: SizeConfig.screenHeight! * 0.05, @@ -183,44 +182,44 @@ Widget build(BuildContext context) { Theme.of(context).colorScheme.secondary, size: 30, ), - // title for My Tasks tile + title for My Tasks tile title: AppLocalizations.of(context)! .strictTranslate('My Tasks'), - // display subtitle + display subtitle subtitle: AppLocalizations.of(context)! .strictTranslate( "View and edit all tasks created by you", ), ), - // on tag redirects to the user Tasks page. - onTapOption: () { + on tag redirects to the user Tasks page. + onTapOption: () \{ navigationService.pushScreen(Routes.userTasks); - }, + \}, ), SizedBox( height: SizeConfig.screenHeight! * 0.05, ), - // // Will be added later when we add the Help Section in Documentation. - // CustomListTile( - // key: homeModel!.keySPHelp, - // index: 1, - // type: TileType.option, - // option: Options( - // icon: const Icon( - // Icons.help_outline, - // size: 30, - // ), - // title: AppLocalizations.of(context)! - // .strictTranslate('Help'), - // subtitle: AppLocalizations.of(context)! - // .strictTranslate( - // 'Reach out to us for help', - // ), - // ), - // onTapOption: () {}, - // ), - /// `Donation` acts as plugin. If visible is true the it will be always visible. - /// even if it's uninstalled by the admin (for development purposes) + Will be added later when we add the Help Section in Documentation. + CustomListTile( + key: homeModel!.keySPHelp, + index: 1, + type: TileType.option, + option: Options( + icon: const Icon( + Icons.help_outline, + size: 30, + ), + title: AppLocalizations.of(context)! + .strictTranslate('Help'), + subtitle: AppLocalizations.of(context)! + .strictTranslate( + 'Reach out to us for help', + ), + ), + onTapOption: () \{\}, + ), + `Donation` acts as plugin. If visible is true the it will be always visible. + even if it's uninstalled by the admin (for development purposes) TalawaPluginProvider( pluginName: "Donation", visible: true, @@ -245,7 +244,7 @@ Widget build(BuildContext context) { 'Help us to develop for you', ), ), - onTapOption: () => donate(context, model), + onTapOption: () =\> donate(context, model), ), SizedBox( height: SizeConfig.screenHeight! * 0.05, @@ -253,7 +252,7 @@ Widget build(BuildContext context) { ], ), ), - // custom tile for Invitation. + custom tile for Invitation. CustomListTile( key: homeModel!.keySPInvite, index: 3, @@ -265,20 +264,20 @@ Widget build(BuildContext context) { Theme.of(context).colorScheme.secondary, size: 30, ), - // title + title title: AppLocalizations.of(context)! .strictTranslate('Invite'), - // subtitle + subtitle subtitle: AppLocalizations.of(context)! .strictTranslate('Invite to org'), ), - // on tap call the invite function - onTapOption: () => model.invite(context), + on tap call the invite function + onTapOption: () =\> model.invite(context), ), SizedBox( height: SizeConfig.screenHeight! * 0.05, ), - // Custom tile for Logout option. + Custom tile for Logout option. CustomListTile( key: homeModel!.keySPLogout, index: 3, @@ -295,8 +294,8 @@ Widget build(BuildContext context) { subtitle: AppLocalizations.of(context)! .strictTranslate('Log out from Talawa'), ), - // on tap calls the logout function - onTapOption: () => model.logout(context), + on tap calls the logout function + onTapOption: () =\> model.logout(context), ), SizedBox( height: SizeConfig.screenHeight! * 0.05, @@ -309,9 +308,9 @@ Widget build(BuildContext context) { ), ), ); - }, + \}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/donate.md b/docs/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/donate.md index 32bb9a58eae..76ca6ec073a 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/donate.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/donate.md @@ -11,7 +11,7 @@ void donate -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context, [ProfilePageViewModel](../../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md) model) +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context, [ProfilePageViewModel](../../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md) model) @@ -23,7 +23,7 @@ void donate ## Implementation ```dart -void donate(BuildContext context, ProfilePageViewModel model) { +void donate(BuildContext context, ProfilePageViewModel model) \{ showModalBottomSheet( context: context, isScrollControlled: true, @@ -33,9 +33,9 @@ void donate(BuildContext context, ProfilePageViewModel model) { topRight: Radius.circular(30), ), ), - builder: (BuildContext context) { + builder: (BuildContext context) \{ return StatefulBuilder( - builder: (context, setState) { + builder: (context, setState) \{ model.attachListener(setState); return ClipRRect( borderRadius: const BorderRadius.only( @@ -45,10 +45,10 @@ void donate(BuildContext context, ProfilePageViewModel model) { child: SizedBox( height: model.bottomSheetHeight, child: Scaffold( - // background color set to Primary + background color set to Primary backgroundColor: Theme.of(context).colorScheme.primaryContainer, - // header + header appBar: AppBar( centerTitle: true, automaticallyImplyLeading: false, @@ -57,9 +57,9 @@ void donate(BuildContext context, ProfilePageViewModel model) { toolbarHeight: SizeConfig.screenHeight! * 0.15, title: Padding( padding: const EdgeInsets.only(top: 8.0), - // display title + display title child: Text( - 'Donating to \n${model.currentOrg.name}', + 'Donating to \n$\{model.currentOrg.name\}', style: Theme.of(context) .textTheme .headlineMedium! @@ -86,7 +86,7 @@ void donate(BuildContext context, ProfilePageViewModel model) { ], ), body: SingleChildScrollView( - // SingleChildScrollView is a box in which a single widget can be scrolled. + SingleChildScrollView is a box in which a single widget can be scrolled. child: Column( crossAxisAlignment: CrossAxisAlignment.center, mainAxisSize: MainAxisSize.min, @@ -104,10 +104,10 @@ void donate(BuildContext context, ProfilePageViewModel model) { Container( child: Row( mainAxisAlignment: MainAxisAlignment.spaceEvenly, - // looping through and renders button for donation amounts. + looping through and renders button for donation amounts. children: List.generate( 3, - (index) => model.dominationButton( + (index) =\> model.dominationButton( model.denomination[index], context, setState, @@ -129,7 +129,7 @@ void donate(BuildContext context, ProfilePageViewModel model) { SizedBox( height: SizeConfig.screenWidth! * 0.05, ), - // containers for custom amount + containers for custom amount Container( padding: EdgeInsets.symmetric( horizontal: SizeConfig.screenWidth! * 0.05, @@ -139,12 +139,12 @@ void donate(BuildContext context, ProfilePageViewModel model) { focusNode: model.donationField, textInputAction: TextInputAction.next, keyboardType: TextInputType.number, - autofillHints: const [AutofillHints.email], + autofillHints: const \[AutofillHints.email], enableSuggestions: true, style: Theme.of(context).textTheme.titleLarge, - onChanged: (text) { - setState(() {}); - }, + onChanged: (text) \{ + setState(() \{\}); + \}, decoration: InputDecoration( hintText: AppLocalizations.of(context)! .translate("Enter donation amount"), @@ -153,9 +153,9 @@ void donate(BuildContext context, ProfilePageViewModel model) { labelStyle: Theme.of(context).textTheme.titleMedium, prefixIcon: GestureDetector( - onTap: () { + onTap: () \{ model.changeCurrency(context, setState); - }, + \}, child: Padding( padding: const EdgeInsets.symmetric( horizontal: 15.0, @@ -203,8 +203,8 @@ void donate(BuildContext context, ProfilePageViewModel model) { height: SizeConfig.screenWidth! * 0.05, ), ElevatedButton( - onPressed: () async { - ///required fields for donation transaction + onPressed: () async \{ + required fields for donation transaction late final String userId; late final String orgId; late final String nameOfOrg; @@ -214,13 +214,13 @@ void donate(BuildContext context, ProfilePageViewModel model) { orgId = model.currentOrg.id!; userId = model.currentUser.id!; nameOfUser = - "${model.currentUser.firstName!} ${model.currentUser.lastName!}"; + "$\{model.currentUser.firstName!\} $\{model.currentUser.lastName!\}"; nameOfOrg = model.currentOrg.name!; amount = double.parse(model.donationAmount.text); final request = BraintreeDropInRequest( tokenizationKey: - '', + '\', collectDeviceData: true, paypalRequest: BraintreePayPalRequest( amount: model.donationAmount.text, @@ -231,12 +231,12 @@ void donate(BuildContext context, ProfilePageViewModel model) { final BraintreeDropInResult? result = await BraintreeDropIn.start(request); - if (result != null) { - ///saving the donation in server + if (result != null) \{ + saving the donation in server late final GraphQLClient client = graphqlConfig.clientToQuery(); - ///getting transaction id from `brainTree` API + getting transaction id from `brainTree` API payPalId = result.paymentMethodNonce.nonce; final QueryResult donationResult = @@ -254,23 +254,23 @@ void donate(BuildContext context, ProfilePageViewModel model) { ), ), ); - if (donationResult.hasException) { + if (donationResult.hasException) \{ model.showSnackBar( "Error occurred while making a donation", ); - } + \} - /// hiding the donation UI once it is successful + hiding the donation UI once it is successful model.popBottomSheet(); model.showSnackBar( 'Donation Successful,Thanks for the support !', ); - } - }, + \} + \}, style: ButtonStyle( backgroundColor: MaterialStateProperty.all( - // if the donation amount entered or selected is empty then renders grey color - // else render primary color + if the donation amount entered or selected is empty then renders grey color + else render primary color model.donationAmount.text.isEmpty ? Colors.grey : Theme.of(context).colorScheme.primary, @@ -287,11 +287,11 @@ void donate(BuildContext context, ProfilePageViewModel model) { ), ), ); - }, + \}, ); - }, - ).then((value) => model.updateSheetHeight()); -} + \}, + ).then((value) =\> model.updateSheetHeight()); +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/homeModel.md b/docs/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/homeModel.md index d7359e06122..d9fd6914012 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/homeModel.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/homeModel.md @@ -11,7 +11,7 @@ [MainScreenViewModel](../../view_model_main_screen_view_model/MainScreenViewModel-class.md)? homeModel -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage-class.md index c1403229560..695500a6b2d 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage-class.md @@ -11,16 +11,16 @@ -

CreateTaskPage returns a widget for page to create task for the user.

+\CreateTaskPage returns a widget for page to create task for the user.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - CreateTaskPage @@ -32,46 +32,46 @@ ## Constructors -[CreateTaskPage](../views_after_auth_screens_tasks_create_task_page/CreateTaskPage/CreateTaskPage.md) ({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId, [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +[CreateTaskPage](../views_after_auth_screens_tasks_create_task_page/CreateTaskPage/CreateTaskPage.md) (\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId, [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) _const_ ## Properties -##### [eventId](../views_after_auth_screens_tasks_create_task_page/CreateTaskPage/eventId.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [eventId](../views_after_auth_screens_tasks_create_task_page/CreateTaskPage/eventId.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -79,95 +79,95 @@ _read-onlyinherited_ ## Methods -##### [build](../views_after_auth_screens_tasks_create_task_page/CreateTaskPage/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../views_after_auth_screens_tasks_create_task_page/CreateTaskPage/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -175,12 +175,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage/CreateTaskPage.md b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage/CreateTaskPage.md index 67c1b703b0e..b997c548efc 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage/CreateTaskPage.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage/CreateTaskPage.md @@ -9,7 +9,7 @@ const -CreateTaskPage({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId, [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +CreateTaskPage(\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId, [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) @@ -18,7 +18,7 @@ CreateTaskPage({required [String](https://api.flutter.dev/flutter/dart-core/Stri ## Implementation ```dart -const CreateTaskPage({required this.eventId, Key? key}) : super(key: key); +const CreateTaskPage(\{required this.eventId, Key? key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage/build.md b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage/build.md index b173c4741f2..8833090d38f 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage/build.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,18 +58,18 @@ and ```dart @override -Widget build(BuildContext context) { - return BaseView( - builder: (context, model, _) { - // renders custom widget TaskForm, you can explore TaskForm widget [here](/widgets/task_form.dart). +Widget build(BuildContext context) \{ + return BaseView\( + builder: (context, model, _) \{ + renders custom widget TaskForm, you can explore TaskForm widget [here](/widgets/task_form.dart). return TaskForm( - onSave: () => model.createTask(eventId), + onSave: () =\> model.createTask(eventId), title: 'Create Task', actionText: 'Add', ); - }, + \}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage/eventId.md b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage/eventId.md index 4ca1b389065..84bff4fedf7 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage/eventId.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage/eventId.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage-class.md index 8a8ff4c7f25..b3c599d94e0 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage-class.md @@ -11,16 +11,16 @@ -

EditTaskPage returns a widget for page to edit the task for the user.

+\EditTaskPage returns a widget for page to edit the task for the user.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - EditTaskPage @@ -32,37 +32,37 @@ ## Constructors -[EditTaskPage](../views_after_auth_screens_tasks_edit_task_page/EditTaskPage/EditTaskPage.md) ({required [Task](../models_task_task_model/Task-class.md) task, [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +[EditTaskPage](../views_after_auth_screens_tasks_edit_task_page/EditTaskPage/EditTaskPage.md) (\{required [Task](../models_task_task_model/Task-class.md) task, [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -71,7 +71,7 @@ _read-onlyinherited_ -_final_ +_\final\_ @@ -79,95 +79,95 @@ _final_ ## Methods -##### [build](../views_after_auth_screens_tasks_edit_task_page/EditTaskPage/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../views_after_auth_screens_tasks_edit_task_page/EditTaskPage/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -175,12 +175,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage/EditTaskPage.md b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage/EditTaskPage.md index 204de2133ff..ce130f5c8e9 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage/EditTaskPage.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage/EditTaskPage.md @@ -9,7 +9,7 @@ const -EditTaskPage({required [Task](../../models_task_task_model/Task-class.md) task, [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +EditTaskPage(\{required [Task](../../models_task_task_model/Task-class.md) task, [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) @@ -18,7 +18,7 @@ EditTaskPage({required [Task](../../models_task_task_model/Task-class.md) task, ## Implementation ```dart -const EditTaskPage({required this.task, Key? key}) : super(key: key); +const EditTaskPage(\{required this.task, Key? key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage/build.md b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage/build.md index 35493bb5b0b..971b158f728 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage/build.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,19 +58,19 @@ and ```dart @override -Widget build(BuildContext context) { - return BaseView( - onModelReady: (model) => model.fillTask(task), - builder: (context, model, _) { - // renders custom widget TaskForm, you can explore TaskForm widget [here](/widgets/task_form.dart). +Widget build(BuildContext context) \{ + return BaseView\( + onModelReady: (model) =\> model.fillTask(task), + builder: (context, model, _) \{ + renders custom widget TaskForm, you can explore TaskForm widget [here](/widgets/task_form.dart). return TaskForm( - onSave: () => model.editTask(task.id), + onSave: () =\> model.editTask(task.id), title: 'Edit Task', actionText: 'Update', ); - }, + \}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage/task.md b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage/task.md index 3cf99076fd6..e2fb263172d 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage/task.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage/task.md @@ -11,7 +11,7 @@ [Task](../../models_task_task_model/Task-class.md) task -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage-class.md index 25f2d41a0d7..a54e8e0b0e8 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage-class.md @@ -11,16 +11,16 @@ -

EventTasksPage return a widget for Event Task Page that is created by event creator.

+\EventTasksPage return a widget for Event Task Page that is created by event creator.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - EventTasksPage @@ -32,46 +32,46 @@ ## Constructors -[EventTasksPage](../views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/EventTasksPage.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId}) +[EventTasksPage](../views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/EventTasksPage.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId\}) _const_ ## Properties -##### [eventId](../views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/eventId.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [eventId](../views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/eventId.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -79,95 +79,95 @@ _read-onlyinherited_ ## Methods -##### [build](../views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -175,12 +175,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/EventTasksPage.md b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/EventTasksPage.md index fcfe45d50f6..740a034e371 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/EventTasksPage.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/EventTasksPage.md @@ -9,7 +9,7 @@ const -EventTasksPage({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId}) +EventTasksPage(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId\}) @@ -18,7 +18,7 @@ EventTasksPage({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html) ## Implementation ```dart -const EventTasksPage({Key? key, required this.eventId}) : super(key: key); +const EventTasksPage(\{Key? key, required this.eventId\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/build.md b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/build.md index a5fc7f83975..211cb3174f7 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/build.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,33 +58,33 @@ and ```dart @override -Widget build(BuildContext context) { - return BaseView( - onModelReady: (model) => model.fetchTasks(eventId), - builder: (_, model, __) { +Widget build(BuildContext context) \{ + return BaseView\( + onModelReady: (model) =\> model.fetchTasks(eventId), + builder: (_, model, __) \{ final tasks = model.tasks; return RefreshIndicator( - onRefresh: () => model.fetchTasks(eventId), + onRefresh: () =\> model.fetchTasks(eventId), child: Scaffold( appBar: AppBar( title: const Text('Event Tasks'), ), - // TaskSchedule is custom widget. + TaskSchedule is custom widget. body: TaskSchedule(tasks: tasks), floatingActionButton: FloatingActionButton( - onPressed: () async { + onPressed: () async \{ await navigationService.pushScreen( Routes.addTask, arguments: eventId, ); - }, + \}, child: const Icon(Icons.add), ), ), ); - }, + \}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/eventId.md b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/eventId.md index 4ca1b389065..84bff4fedf7 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/eventId.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/eventId.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) eventId -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_user_tasks_page/UserTasksPage-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_user_tasks_page/UserTasksPage-class.md index ca207fe6d5d..c4604ae2a1f 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_user_tasks_page/UserTasksPage-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_user_tasks_page/UserTasksPage-class.md @@ -11,16 +11,16 @@ -

UserTasksPage returns a widget for page of User Tasks.

+\UserTasksPage returns a widget for page of User Tasks.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - UserTasksPage @@ -32,37 +32,37 @@ ## Constructors -[UserTasksPage](../views_after_auth_screens_tasks_user_tasks_page/UserTasksPage/UserTasksPage.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +[UserTasksPage](../views_after_auth_screens_tasks_user_tasks_page/UserTasksPage/UserTasksPage.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -70,95 +70,95 @@ _read-onlyinherited_ ## Methods -##### [build](../views_after_auth_screens_tasks_user_tasks_page/UserTasksPage/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../views_after_auth_screens_tasks_user_tasks_page/UserTasksPage/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -166,12 +166,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_user_tasks_page/UserTasksPage/UserTasksPage.md b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_user_tasks_page/UserTasksPage/UserTasksPage.md index 2263a899cfe..ec8e960459d 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_user_tasks_page/UserTasksPage/UserTasksPage.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_user_tasks_page/UserTasksPage/UserTasksPage.md @@ -9,7 +9,7 @@ const -UserTasksPage({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +UserTasksPage(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) @@ -18,7 +18,7 @@ UserTasksPage({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? ## Implementation ```dart -const UserTasksPage({Key? key}) : super(key: key); +const UserTasksPage(\{Key? key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_user_tasks_page/UserTasksPage/build.md b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_user_tasks_page/UserTasksPage/build.md index 2a4d3e2ccc8..7d7c92ae0a9 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_tasks_user_tasks_page/UserTasksPage/build.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_tasks_user_tasks_page/UserTasksPage/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,24 +58,24 @@ and ```dart @override -Widget build(BuildContext context) { - return BaseView( - onModelReady: (model) => model.fetchTasksByUser(), - builder: (_, model, __) { +Widget build(BuildContext context) \{ + return BaseView\( + onModelReady: (model) =\> model.fetchTasksByUser(), + builder: (_, model, __) \{ final tasks = model.tasks; return RefreshIndicator( - onRefresh: () => model.fetchTasksByUser(), + onRefresh: () =\> model.fetchTasksByUser(), child: Scaffold( appBar: AppBar( title: const Text('User Tasks'), ), - // TaskSchedule is custom widget. + TaskSchedule is custom widget. body: TaskSchedule(tasks: tasks, showMoreOptions: true), ), ); - }, + \}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen-class.md b/docs/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen-class.md index c5eaefb15ae..becc323ddbc 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen-class.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen-class.md @@ -11,16 +11,16 @@ -

MapScreen returns a widget that has mutable state _MapScreenState.

+\MapScreen returns a widget that has mutable state _MapScreenState.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html) - MapScreen @@ -32,46 +32,46 @@ ## Constructors -[MapScreen](../views_after_auth_screens_venue_map_screen/MapScreen/MapScreen.md) ([CreateEventViewModel](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md)? model, [double](https://api.flutter.dev/flutter/dart-core/double-class.html) latitude, [double](https://api.flutter.dev/flutter/dart-core/double-class.html) longitude, {[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +[MapScreen](../views_after_auth_screens_venue_map_screen/MapScreen/MapScreen.md) ([CreateEventViewModel](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md)? model, [double](https:api.flutter.dev/flutter/dart-core/double-class.html) latitude, [double](https:api.flutter.dev/flutter/dart-core/double-class.html) longitude, \{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [latitude](../views_after_auth_screens_venue_map_screen/MapScreen/latitude.md) → [double](https://api.flutter.dev/flutter/dart-core/double-class.html) +##### [latitude](../views_after_auth_screens_venue_map_screen/MapScreen/latitude.md) → [double](https:api.flutter.dev/flutter/dart-core/double-class.html) -_final_ +_\final\_ -##### [longitude](../views_after_auth_screens_venue_map_screen/MapScreen/longitude.md) → [double](https://api.flutter.dev/flutter/dart-core/double-class.html) +##### [longitude](../views_after_auth_screens_venue_map_screen/MapScreen/longitude.md) → [double](https:api.flutter.dev/flutter/dart-core/double-class.html) -_final_ +_\final\_ @@ -80,16 +80,16 @@ _final_ -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -97,12 +97,12 @@ _read-onlyinherited_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a
StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ @@ -111,81 +111,81 @@ _inherited_ Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -193,12 +193,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/MapScreen.md b/docs/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/MapScreen.md index c16e8d0beb0..53c841ee436 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/MapScreen.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/MapScreen.md @@ -9,7 +9,7 @@ const -MapScreen([CreateEventViewModel](../../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md)? model, [double](https://api.flutter.dev/flutter/dart-core/double-class.html) latitude, [double](https://api.flutter.dev/flutter/dart-core/double-class.html) longitude, {[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +MapScreen([CreateEventViewModel](../../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md)? model, [double](https:api.flutter.dev/flutter/dart-core/double-class.html) latitude, [double](https:api.flutter.dev/flutter/dart-core/double-class.html) longitude, \{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) @@ -18,7 +18,7 @@ MapScreen([CreateEventViewModel](../../view_model_after_auth_view_models_event_v ## Implementation ```dart -const MapScreen(this.model, this.latitude, this.longitude, {Key? key}) +const MapScreen(this.model, this.latitude, this.longitude, \{Key? key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/createState.md b/docs/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/createState.md index 713d88f2aad..58eebbd3468 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/createState.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) _MapScreenState createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/longitude.md b/docs/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/longitude.md index 7879ff5703b..2f02bf3e7e7 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/longitude.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/longitude.md @@ -9,9 +9,9 @@ -[double](https://api.flutter.dev/flutter/dart-core/double-class.html) longitude +[double](https:api.flutter.dev/flutter/dart-core/double-class.html) longitude -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/model.md b/docs/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/model.md index 697bf3c0cee..b2fd19fbbb9 100644 --- a/docs/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/model.md +++ b/docs/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/model.md @@ -11,7 +11,7 @@ [CreateEventViewModel](../../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md)? model -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/views_base_view/BaseView-class.md b/docs/talawa-mobile-docs/views_base_view/BaseView-class.md index 8946f6bb48c..fd9f1ce7630 100644 --- a/docs/talawa-mobile-docs/views_base_view/BaseView-class.md +++ b/docs/talawa-mobile-docs/views_base_view/BaseView-class.md @@ -1,7 +1,7 @@ -# BaseView<T extends ChangeNotifier> class +# BaseView<T extends ChangeNotifier\> class @@ -16,10 +16,10 @@ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html) - BaseView @@ -31,37 +31,37 @@ ## Constructors -[BaseView](../views_base_view/BaseView/BaseView.md) ({required [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) builder([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html), T, [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html)?), dynamic onModelReady(T)?}) +[BaseView](../views_base_view/BaseView/BaseView.md) (\{required [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) builder([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html), T, [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html)?), dynamic onModelReady(T)?\}) _const_ ## Properties -##### [builder](../views_base_view/BaseView/builder.md) → [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) Function([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html), T, [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html)?) +##### [builder](../views_base_view/BaseView/builder.md) → [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Function([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html), T, [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html)?) -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ @@ -70,16 +70,16 @@ _finalinherited_ -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -87,95 +87,95 @@ _read-onlyinherited_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [createState](../views_base_view/BaseView/createState.md)() _BaseViewState<T> +##### [createState](../views_base_view/BaseView/createState.md)() _BaseViewState<T\> Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -183,12 +183,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_base_view/BaseView/BaseView.md b/docs/talawa-mobile-docs/views_base_view/BaseView/BaseView.md index b2b14d9c9ee..c9eef00176a 100644 --- a/docs/talawa-mobile-docs/views_base_view/BaseView/BaseView.md +++ b/docs/talawa-mobile-docs/views_base_view/BaseView/BaseView.md @@ -1,7 +1,7 @@ -# BaseView<T extends ChangeNotifier> constructor +# BaseView<T extends ChangeNotifier\> constructor @@ -9,7 +9,7 @@ const -BaseView<T extends ChangeNotifier>({required [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) builder([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html), T, [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html)?), dynamic onModelReady(T)?}) +BaseView<T extends ChangeNotifier\>(\{required [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) builder([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html), T, [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html)?), dynamic onModelReady(T)?\}) @@ -18,10 +18,10 @@ BaseView<T extends ChangeNotifier>({required [Widget](https://api.flutter.dev ## Implementation ```dart -const BaseView({ +const BaseView(\{ required this.builder, this.onModelReady, -}); +\}); ``` diff --git a/docs/talawa-mobile-docs/views_base_view/BaseView/builder.md b/docs/talawa-mobile-docs/views_base_view/BaseView/builder.md index e30644f097d..947a74776e3 100644 --- a/docs/talawa-mobile-docs/views_base_view/BaseView/builder.md +++ b/docs/talawa-mobile-docs/views_base_view/BaseView/builder.md @@ -9,9 +9,9 @@ -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) Function([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html), T, [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html)?) builder +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Function([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html), T, [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html)?) builder -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/views_base_view/BaseView/createState.md b/docs/talawa-mobile-docs/views_base_view/BaseView/createState.md index e14ec4540fa..74a38c04a22 100644 --- a/docs/talawa-mobile-docs/views_base_view/BaseView/createState.md +++ b/docs/talawa-mobile-docs/views_base_view/BaseView/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -_BaseViewState<T> createState +_BaseViewState<T\> createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/views_base_view/views_base_view-library.md b/docs/talawa-mobile-docs/views_base_view/views_base_view-library.md index c235dde85af..b68bc14e6cf 100644 --- a/docs/talawa-mobile-docs/views_base_view/views_base_view-library.md +++ b/docs/talawa-mobile-docs/views_base_view/views_base_view-library.md @@ -16,7 +16,7 @@ ## Classes -##### [BaseView](../views_base_view/BaseView-class.md)<T extends [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html)> +##### [BaseView](../views_base_view/BaseView-class.md)<T extends [ChangeNotifier](https:api.flutter.dev/flutter/foundation/ChangeNotifier-class.html)\> diff --git a/docs/talawa-mobile-docs/views_main_screen/MainScreen-class.md b/docs/talawa-mobile-docs/views_main_screen/MainScreen-class.md index 27015e1078f..c1b9f998fb1 100644 --- a/docs/talawa-mobile-docs/views_main_screen/MainScreen-class.md +++ b/docs/talawa-mobile-docs/views_main_screen/MainScreen-class.md @@ -16,10 +16,10 @@ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html) - MainScreen @@ -31,28 +31,28 @@ ## Constructors -[MainScreen](../views_main_screen/MainScreen/MainScreen.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [MainScreenArgs](../models_mainscreen_navigation_args/MainScreenArgs-class.md) mainScreenArgs}) +[MainScreen](../views_main_screen/MainScreen/MainScreen.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [MainScreenArgs](../models_mainscreen_navigation_args/MainScreenArgs-class.md) mainScreenArgs\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ @@ -61,16 +61,16 @@ _finalinherited_ -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -78,95 +78,95 @@ _read-onlyinherited_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [createState](../views_main_screen/MainScreen/createState.md)() [State](https://api.flutter.dev/flutter/widgets/State-class.html)<[MainScreen](../views_main_screen/MainScreen-class.md)> +##### [createState](../views_main_screen/MainScreen/createState.md)() [State](https:api.flutter.dev/flutter/widgets/State-class.html)<[MainScreen](../views_main_screen/MainScreen-class.md)\> Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -174,12 +174,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_main_screen/MainScreen/MainScreen.md b/docs/talawa-mobile-docs/views_main_screen/MainScreen/MainScreen.md index bdcd9e82ea8..316b2817950 100644 --- a/docs/talawa-mobile-docs/views_main_screen/MainScreen/MainScreen.md +++ b/docs/talawa-mobile-docs/views_main_screen/MainScreen/MainScreen.md @@ -9,7 +9,7 @@ const -MainScreen({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [MainScreenArgs](../../models_mainscreen_navigation_args/MainScreenArgs-class.md) mainScreenArgs}) +MainScreen(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [MainScreenArgs](../../models_mainscreen_navigation_args/MainScreenArgs-class.md) mainScreenArgs\}) @@ -18,7 +18,7 @@ MainScreen({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? ke ## Implementation ```dart -const MainScreen({Key? key, required this.mainScreenArgs}) : super(key: key); +const MainScreen(\{Key? key, required this.mainScreenArgs\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_main_screen/MainScreen/createState.md b/docs/talawa-mobile-docs/views_main_screen/MainScreen/createState.md index 6553b209034..fa7421f9748 100644 --- a/docs/talawa-mobile-docs/views_main_screen/MainScreen/createState.md +++ b/docs/talawa-mobile-docs/views_main_screen/MainScreen/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[MainScreen](../../views_main_screen/MainScreen-class.md)> createState +[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[MainScreen](../../views_main_screen/MainScreen-class.md)\> createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/views_pre_auth_screens_change_password/ChangePass-class.md b/docs/talawa-mobile-docs/views_pre_auth_screens_change_password/ChangePass-class.md index 731c511f031..d929717439c 100644 --- a/docs/talawa-mobile-docs/views_pre_auth_screens_change_password/ChangePass-class.md +++ b/docs/talawa-mobile-docs/views_pre_auth_screens_change_password/ChangePass-class.md @@ -11,19 +11,19 @@ -

This widget lets the user change his/her password. +\This widget lets the user change his/her password. There are two input fields. The first one is for entering the new password, and the second one is for re-entering the password for verification. -There is a raised button which finally updates the password when pressed.

+There is a raised button which finally updates the password when pressed.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html) - ChangePass @@ -35,37 +35,37 @@ There is a raised button which finally updates the password when pressed.

## Constructors -[ChangePass](../views_pre_auth_screens_change_password/ChangePass/ChangePass.md) ({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key}) +[ChangePass](../views_pre_auth_screens_change_password/ChangePass/ChangePass.md) (\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -73,12 +73,12 @@ _read-onlyinherited_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a
StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ @@ -87,81 +87,81 @@ _inherited_ Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -169,12 +169,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_pre_auth_screens_change_password/ChangePass/ChangePass.md b/docs/talawa-mobile-docs/views_pre_auth_screens_change_password/ChangePass/ChangePass.md index 1cd9383e761..daf35e030e5 100644 --- a/docs/talawa-mobile-docs/views_pre_auth_screens_change_password/ChangePass/ChangePass.md +++ b/docs/talawa-mobile-docs/views_pre_auth_screens_change_password/ChangePass/ChangePass.md @@ -9,7 +9,7 @@ const -ChangePass({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key}) +ChangePass(\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key\}) @@ -18,7 +18,7 @@ ChangePass({required [Key](https://api.flutter.dev/flutter/foundation/Key-class. ## Implementation ```dart -const ChangePass({required Key key}) : super(key: key); +const ChangePass(\{required Key key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_pre_auth_screens_change_password/ChangePass/createState.md b/docs/talawa-mobile-docs/views_pre_auth_screens_change_password/ChangePass/createState.md index 895a6ff7fdf..414b0c9fefa 100644 --- a/docs/talawa-mobile-docs/views_pre_auth_screens_change_password/ChangePass/createState.md +++ b/docs/talawa-mobile-docs/views_pre_auth_screens_change_password/ChangePass/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) _ChangePassState createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh +At the bottom, there is a login button to initiate the login.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html) - Login @@ -37,37 +37,37 @@ At the bottom, there is a login button to initiate the login.

## Constructors -[Login](../views_pre_auth_screens_login/Login/Login.md) ({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key}) +[Login](../views_pre_auth_screens_login/Login/Login.md) (\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -75,12 +75,12 @@ _read-onlyinherited_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a
StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ @@ -89,81 +89,81 @@ _inherited_ Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -171,12 +171,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_pre_auth_screens_login/Login/Login.md b/docs/talawa-mobile-docs/views_pre_auth_screens_login/Login/Login.md index 286bc4a1e49..444234065af 100644 --- a/docs/talawa-mobile-docs/views_pre_auth_screens_login/Login/Login.md +++ b/docs/talawa-mobile-docs/views_pre_auth_screens_login/Login/Login.md @@ -9,7 +9,7 @@ const -Login({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key}) +Login(\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key\}) @@ -18,7 +18,7 @@ Login({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) ## Implementation ```dart -const Login({required Key key}) : super(key: key); +const Login(\{required Key key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_pre_auth_screens_login/Login/createState.md b/docs/talawa-mobile-docs/views_pre_auth_screens_login/Login/createState.md index 15962de2eec..bb39ad7e944 100644 --- a/docs/talawa-mobile-docs/views_pre_auth_screens_login/Login/createState.md +++ b/docs/talawa-mobile-docs/views_pre_auth_screens_login/Login/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) _LoginState createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -71,12 +71,12 @@ _read-onlyinherited_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ @@ -85,81 +85,81 @@ _inherited_ Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -167,12 +167,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_pre_auth_screens_recover/Recover/Recover.md b/docs/talawa-mobile-docs/views_pre_auth_screens_recover/Recover/Recover.md index 62e8bdcc422..729512b975a 100644 --- a/docs/talawa-mobile-docs/views_pre_auth_screens_recover/Recover/Recover.md +++ b/docs/talawa-mobile-docs/views_pre_auth_screens_recover/Recover/Recover.md @@ -9,7 +9,7 @@ const -Recover({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key}) +Recover(\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key\}) @@ -18,7 +18,7 @@ Recover({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.htm ## Implementation ```dart -const Recover({required Key key}) : super(key: key); +const Recover(\{required Key key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_pre_auth_screens_recover/Recover/createState.md b/docs/talawa-mobile-docs/views_pre_auth_screens_recover/Recover/createState.md index 2ba2ecaf894..6322d52a1d2 100644 --- a/docs/talawa-mobile-docs/views_pre_auth_screens_recover/Recover/createState.md +++ b/docs/talawa-mobile-docs/views_pre_auth_screens_recover/Recover/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) _RecoverState createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -73,12 +73,12 @@ _read-onlyinherited_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ @@ -87,81 +87,81 @@ _inherited_ Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -169,12 +169,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_pre_auth_screens_select_language/SelectLanguage/SelectLanguage.md b/docs/talawa-mobile-docs/views_pre_auth_screens_select_language/SelectLanguage/SelectLanguage.md index e410527619a..25f8fe896f1 100644 --- a/docs/talawa-mobile-docs/views_pre_auth_screens_select_language/SelectLanguage/SelectLanguage.md +++ b/docs/talawa-mobile-docs/views_pre_auth_screens_select_language/SelectLanguage/SelectLanguage.md @@ -9,7 +9,7 @@ const -SelectLanguage({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key}) +SelectLanguage(\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key\}) @@ -18,7 +18,7 @@ SelectLanguage({required [Key](https://api.flutter.dev/flutter/foundation/Key-cl ## Implementation ```dart -const SelectLanguage({required Key key}) : super(key: key); +const SelectLanguage(\{required Key key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_pre_auth_screens_select_language/SelectLanguage/createState.md b/docs/talawa-mobile-docs/views_pre_auth_screens_select_language/SelectLanguage/createState.md index 2428e069e06..f3700967be6 100644 --- a/docs/talawa-mobile-docs/views_pre_auth_screens_select_language/SelectLanguage/createState.md +++ b/docs/talawa-mobile-docs/views_pre_auth_screens_select_language/SelectLanguage/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) _SelectLanguageState createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh +\This widget lets the user select new organizations.\ +\There is a list tile which displays the organization selected by the user. +He/she needs to press the "continue" button to proceed.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html) - SelectOrganization @@ -34,46 +34,46 @@ He/she needs to press the "continue" button to proceed.

## Constructors -[SelectOrganization](../views_pre_auth_screens_select_organization/SelectOrganization/SelectOrganization.md) ({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) selectedOrgId}) +[SelectOrganization](../views_pre_auth_screens_select_organization/SelectOrganization/SelectOrganization.md) (\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) selectedOrgId\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [selectedOrgId](../views_pre_auth_screens_select_organization/SelectOrganization/selectedOrgId.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [selectedOrgId](../views_pre_auth_screens_select_organization/SelectOrganization/selectedOrgId.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Contains Integer value for selected org id. -_final_ +_\final\_ @@ -81,12 +81,12 @@ _final_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a
StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ @@ -95,81 +95,81 @@ _inherited_ Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -177,12 +177,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_pre_auth_screens_select_organization/SelectOrganization/SelectOrganization.md b/docs/talawa-mobile-docs/views_pre_auth_screens_select_organization/SelectOrganization/SelectOrganization.md index e50889bab2c..fa3d17c611a 100644 --- a/docs/talawa-mobile-docs/views_pre_auth_screens_select_organization/SelectOrganization/SelectOrganization.md +++ b/docs/talawa-mobile-docs/views_pre_auth_screens_select_organization/SelectOrganization/SelectOrganization.md @@ -9,7 +9,7 @@ const -SelectOrganization({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) selectedOrgId}) +SelectOrganization(\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) selectedOrgId\}) @@ -18,7 +18,7 @@ SelectOrganization({required [Key](https://api.flutter.dev/flutter/foundation/Ke ## Implementation ```dart -const SelectOrganization({required Key key, required this.selectedOrgId}) +const SelectOrganization(\{required Key key, required this.selectedOrgId\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_pre_auth_screens_select_organization/SelectOrganization/createState.md b/docs/talawa-mobile-docs/views_pre_auth_screens_select_organization/SelectOrganization/createState.md index f79eaff9e39..5ecbea1131e 100644 --- a/docs/talawa-mobile-docs/views_pre_auth_screens_select_organization/SelectOrganization/createState.md +++ b/docs/talawa-mobile-docs/views_pre_auth_screens_select_organization/SelectOrganization/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) _SelectOrganizationState createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh final_ +_\final\_ -

Contains Integer value for selected org id.

+\Contains Integer value for selected org id.\ diff --git a/docs/talawa-mobile-docs/views_pre_auth_screens_set_url/SetUrl-class.md b/docs/talawa-mobile-docs/views_pre_auth_screens_set_url/SetUrl-class.md index a79b2add3f7..302aeb3a48f 100644 --- a/docs/talawa-mobile-docs/views_pre_auth_screens_set_url/SetUrl-class.md +++ b/docs/talawa-mobile-docs/views_pre_auth_screens_set_url/SetUrl-class.md @@ -11,21 +11,21 @@ -

This widget lets a user sign in/up with the organization url.

-

The user can enter an organization through the QR code scanner, +\This widget lets a user sign in/up with the organization url.\ +\The user can enter an organization through the QR code scanner, or enter the organization URL and then login. There is also a signup option which navigates to a screen for the user to select an organization. -At the bottom, there is also a gesture detector for changing the language.

+At the bottom, there is also a gesture detector for changing the language.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html) - SetUrl @@ -37,46 +37,46 @@ At the bottom, there is also a gesture detector for changing the language.

## Constructors -[SetUrl](../views_pre_auth_screens_set_url/SetUrl/SetUrl.md) ({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) uri}) +[SetUrl](../views_pre_auth_screens_set_url/SetUrl/SetUrl.md) (\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) uri\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [uri](../views_pre_auth_screens_set_url/SetUrl/uri.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [uri](../views_pre_auth_screens_set_url/SetUrl/uri.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Variable. -_final_ +_\final\_ @@ -84,12 +84,12 @@ _final_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a
StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ @@ -98,81 +98,81 @@ _inherited_ Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -180,12 +180,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_pre_auth_screens_set_url/SetUrl/SetUrl.md b/docs/talawa-mobile-docs/views_pre_auth_screens_set_url/SetUrl/SetUrl.md index aac3a1fadbc..59646ff998f 100644 --- a/docs/talawa-mobile-docs/views_pre_auth_screens_set_url/SetUrl/SetUrl.md +++ b/docs/talawa-mobile-docs/views_pre_auth_screens_set_url/SetUrl/SetUrl.md @@ -9,7 +9,7 @@ const -SetUrl({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) uri}) +SetUrl(\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) uri\}) @@ -18,7 +18,7 @@ SetUrl({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html ## Implementation ```dart -const SetUrl({required Key key, required this.uri}) : super(key: key); +const SetUrl(\{required Key key, required this.uri\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_pre_auth_screens_set_url/SetUrl/createState.md b/docs/talawa-mobile-docs/views_pre_auth_screens_set_url/SetUrl/createState.md index 90d6901db78..2064d61a41c 100644 --- a/docs/talawa-mobile-docs/views_pre_auth_screens_set_url/SetUrl/createState.md +++ b/docs/talawa-mobile-docs/views_pre_auth_screens_set_url/SetUrl/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) _SetUrlState createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh final_ +_\final\_ -

Variable.

+\Variable.\ diff --git a/docs/talawa-mobile-docs/views_pre_auth_screens_signup_details/SignUpDetails-class.md b/docs/talawa-mobile-docs/views_pre_auth_screens_signup_details/SignUpDetails-class.md index dc5cf6e2af2..6f0a5dfd1e4 100644 --- a/docs/talawa-mobile-docs/views_pre_auth_screens_signup_details/SignUpDetails-class.md +++ b/docs/talawa-mobile-docs/views_pre_auth_screens_signup_details/SignUpDetails-class.md @@ -11,16 +11,16 @@ -

This widget takes the user details for signup. The form includes first name, last name, email, password, and password confirmation inputs.

+\This widget takes the user details for signup. The form includes first name, last name, email, password, and password confirmation inputs.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html) - SignUpDetails @@ -32,37 +32,37 @@ ## Constructors -[SignUpDetails](../views_pre_auth_screens_signup_details/SignUpDetails/SignUpDetails.md) ({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key, required [OrgInfo](../models_organization_org_info/OrgInfo-class.md) selectedOrg}) +[SignUpDetails](../views_pre_auth_screens_signup_details/SignUpDetails/SignUpDetails.md) (\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key, required [OrgInfo](../models_organization_org_info/OrgInfo-class.md) selectedOrg\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -71,7 +71,7 @@ _read-onlyinherited_ -_final_ +_\final\_ @@ -79,12 +79,12 @@ _final_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a
StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ @@ -93,81 +93,81 @@ _inherited_ Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -175,12 +175,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_pre_auth_screens_signup_details/SignUpDetails/SignUpDetails.md b/docs/talawa-mobile-docs/views_pre_auth_screens_signup_details/SignUpDetails/SignUpDetails.md index 730d0de6325..7e7f63181e7 100644 --- a/docs/talawa-mobile-docs/views_pre_auth_screens_signup_details/SignUpDetails/SignUpDetails.md +++ b/docs/talawa-mobile-docs/views_pre_auth_screens_signup_details/SignUpDetails/SignUpDetails.md @@ -9,7 +9,7 @@ const -SignUpDetails({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key, required [OrgInfo](../../models_organization_org_info/OrgInfo-class.md) selectedOrg}) +SignUpDetails(\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key, required [OrgInfo](../../models_organization_org_info/OrgInfo-class.md) selectedOrg\}) @@ -18,7 +18,7 @@ SignUpDetails({required [Key](https://api.flutter.dev/flutter/foundation/Key-cla ## Implementation ```dart -const SignUpDetails({required Key key, required this.selectedOrg}) +const SignUpDetails(\{required Key key, required this.selectedOrg\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_pre_auth_screens_signup_details/SignUpDetails/createState.md b/docs/talawa-mobile-docs/views_pre_auth_screens_signup_details/SignUpDetails/createState.md index d63614dd69a..00bbb44c953 100644 --- a/docs/talawa-mobile-docs/views_pre_auth_screens_signup_details/SignUpDetails/createState.md +++ b/docs/talawa-mobile-docs/views_pre_auth_screens_signup_details/SignUpDetails/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) _SignUpDetailsState createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/views_pre_auth_screens_waiting_to_join_private_org/WaitingPage-class.md b/docs/talawa-mobile-docs/views_pre_auth_screens_waiting_to_join_private_org/WaitingPage-class.md index bb3e35ccf13..4d445697801 100644 --- a/docs/talawa-mobile-docs/views_pre_auth_screens_waiting_to_join_private_org/WaitingPage-class.md +++ b/docs/talawa-mobile-docs/views_pre_auth_screens_waiting_to_join_private_org/WaitingPage-class.md @@ -11,16 +11,16 @@ -

This class returns a widget which shows the request sent by the user to join a private organization.

+\This class returns a widget which shows the request sent by the user to join a private organization.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - WaitingPage @@ -32,37 +32,37 @@ ## Constructors -[WaitingPage](../views_pre_auth_screens_waiting_to_join_private_org/WaitingPage/WaitingPage.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +[WaitingPage](../views_pre_auth_screens_waiting_to_join_private_org/WaitingPage/WaitingPage.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -70,95 +70,95 @@ _read-onlyinherited_ ## Methods -##### [build](../views_pre_auth_screens_waiting_to_join_private_org/WaitingPage/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../views_pre_auth_screens_waiting_to_join_private_org/WaitingPage/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -166,12 +166,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/views_pre_auth_screens_waiting_to_join_private_org/WaitingPage/WaitingPage.md b/docs/talawa-mobile-docs/views_pre_auth_screens_waiting_to_join_private_org/WaitingPage/WaitingPage.md index e02f6520985..3068530d7b0 100644 --- a/docs/talawa-mobile-docs/views_pre_auth_screens_waiting_to_join_private_org/WaitingPage/WaitingPage.md +++ b/docs/talawa-mobile-docs/views_pre_auth_screens_waiting_to_join_private_org/WaitingPage/WaitingPage.md @@ -9,7 +9,7 @@ const -WaitingPage({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +WaitingPage(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) @@ -18,7 +18,7 @@ WaitingPage({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? k ## Implementation ```dart -const WaitingPage({Key? key}) : super(key: key); +const WaitingPage(\{Key? key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/views_pre_auth_screens_waiting_to_join_private_org/WaitingPage/build.md b/docs/talawa-mobile-docs/views_pre_auth_screens_waiting_to_join_private_org/WaitingPage/build.md index 853022b40fd..a61bc3c513f 100644 --- a/docs/talawa-mobile-docs/views_pre_auth_screens_waiting_to_join_private_org/WaitingPage/build.md +++ b/docs/talawa-mobile-docs/views_pre_auth_screens_waiting_to_join_private_org/WaitingPage/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,10 +58,10 @@ and ```dart @override -Widget build(BuildContext context) { - return BaseView( - onModelReady: (model) => model.initialise(context), - builder: (context, model, child) { +Widget build(BuildContext context) \{ + return BaseView\( + onModelReady: (model) =\> model.initialise(context), + builder: (context, model, child) \{ return Scaffold( key: const Key('WaitingPageScaffold'), extendBodyBehindAppBar: true, @@ -91,7 +91,7 @@ Widget build(BuildContext context) { child: Column( crossAxisAlignment: CrossAxisAlignment.start, children: [ - //Greeting text + Greeting text CustomRichText( key: const Key('WaitingPageText'), words: model.greeting, @@ -107,28 +107,28 @@ Widget build(BuildContext context) { ], ), ), - //Information of the organization to which the request is sent. + Information of the organization to which the request is sent. Expanded( child: ListView.builder( key: const Key('PendingRequestList'), shrinkWrap: true, padding: EdgeInsets.zero, itemCount: model.pendingRequestOrg.length, - itemBuilder: (BuildContext context, int index) { + itemBuilder: (BuildContext context, int index) \{ return CustomListTile( key: const Key('WaitingJoin'), index: index, type: TileType.org, orgInfo: model.pendingRequestOrg[index], - onTapOrgInfo: (item) {}, + onTapOrgInfo: (item) \{\}, ); - }, + \}, ), ), SizedBox( height: SizeConfig.screenHeight! * 0.0215, ), - //Join organization button + Join organization button RaisedRoundedButton( key: const Key('JoinOrg'), buttonLabel: AppLocalizations.of(context)! @@ -145,7 +145,7 @@ Widget build(BuildContext context) { SizedBox( height: SizeConfig.screenHeight! * 0.0215, ), - //Logout button + Logout button RaisedRoundedButton( key: const Key('Logout'), buttonLabel: @@ -166,9 +166,9 @@ Widget build(BuildContext context) { ), ), ); - }, + \}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_add_members_bottom_sheet/EventBottomSheet-class.md b/docs/talawa-mobile-docs/widgets_add_members_bottom_sheet/EventBottomSheet-class.md index fd1368ae644..2244d949c14 100644 --- a/docs/talawa-mobile-docs/widgets_add_members_bottom_sheet/EventBottomSheet-class.md +++ b/docs/talawa-mobile-docs/widgets_add_members_bottom_sheet/EventBottomSheet-class.md @@ -11,7 +11,7 @@ -

Adds members to an event.

+\Adds members to an event.\ @@ -25,21 +25,21 @@ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -47,7 +47,7 @@ _read-onlyinherited_ ## Methods -##### [addUserBottomSheet](../widgets_add_members_bottom_sheet/EventBottomSheet/addUserBottomSheet.md)({required [BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context, required [CreateEventViewModel](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md) model}) void +##### [addUserBottomSheet](../widgets_add_members_bottom_sheet/EventBottomSheet/addUserBottomSheet.md)(\{required [BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context, required [CreateEventViewModel](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md) model\}) void @@ -56,21 +56,21 @@ This function creates a modal material design bottom sheet. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -78,12 +78,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_add_members_bottom_sheet/EventBottomSheet/addUserBottomSheet.md b/docs/talawa-mobile-docs/widgets_add_members_bottom_sheet/EventBottomSheet/addUserBottomSheet.md index c3727ed088f..9904624b5c3 100644 --- a/docs/talawa-mobile-docs/widgets_add_members_bottom_sheet/EventBottomSheet/addUserBottomSheet.md +++ b/docs/talawa-mobile-docs/widgets_add_members_bottom_sheet/EventBottomSheet/addUserBottomSheet.md @@ -11,33 +11,33 @@ void addUserBottomSheet -({required [BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context, required [CreateEventViewModel](../../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md) model}) +(\{required [BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context, required [CreateEventViewModel](../../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md) model\}) -

This function creates a modal material design bottom sheet.

-

to let the user add admin or members to an organization. -params:

-
    -
  • context: BuildContext
  • -
  • model: CreateEventViewModel
  • -
-

returns: - None

+\This function creates a modal material design bottom sheet.\ +\to let the user add admin or members to an organization. +\params\:\ +\ +\\context\: BuildContext\ +\\model\: CreateEventViewModel\ +\ +\\returns\: + None\ ## Implementation ```dart -void addUserBottomSheet({ +void addUserBottomSheet(\{ required BuildContext context, required CreateEventViewModel model, -}) { - // Returns a Future that resolves to the value ("context") passed - // to Navigator.pop +\}) \{ + Returns a Future that resolves to the value ("context") passed + to Navigator.pop showModalBottomSheet( context: context, shape: const RoundedRectangleBorder( @@ -47,9 +47,9 @@ void addUserBottomSheet({ ), ), isScrollControlled: true, - builder: (BuildContext context) { + builder: (BuildContext context) \{ return StatefulBuilder( - builder: (BuildContext context, StateSetter setState) { + builder: (BuildContext context, StateSetter setState) \{ return ClipRRect( borderRadius: const BorderRadius.only( topLeft: Radius.circular(30), @@ -70,37 +70,37 @@ void addUserBottomSheet({ ), TextButton( key: const Key('text_btn_ambs1'), - onPressed: () { + onPressed: () \{ model.buildUserList(); Navigator.pop(context); - }, + \}, child: const Text("Done"), ), const Divider(), FutureBuilder( - // an admin can access the list of the members in an organization + an admin can access the list of the members in an organization future: model.getCurrentOrgUsersList(), builder: ( BuildContext context, - AsyncSnapshot> snapshot, - ) { - if (snapshot.data == null) { + AsyncSnapshot\\> snapshot, + ) \{ + if (snapshot.data == null) \{ return const Center( child: CircularProgressIndicator(), ); - } else { + \} else \{ return snapshot.data!.isEmpty ? const Center( child: Text( "There aren't any members in this organization.", ), ) - // Displaying the list of the members + Displaying the list of the members : Flexible( child: ListView.builder( shrinkWrap: true, itemCount: snapshot.data!.length, - itemBuilder: (context, index) { + itemBuilder: (context, index) \{ return CheckboxListTile( checkColor: Theme.of(context) .colorScheme @@ -109,35 +109,35 @@ void addUserBottomSheet({ .colorScheme .primary, title: Text( - "${snapshot.data![index].firstName!} ${snapshot.data![index].lastName!}", + "$\{snapshot.data![index].firstName!\} $\{snapshot.data![index].lastName!\}", ), value: model.memberCheckedMap[ snapshot.data![index].id], - onChanged: (val) { + onChanged: (val) \{ setState( - () { + () \{ model.memberCheckedMap[snapshot .data![index].id!] = val!; - }, + \}, ); - }, + \}, ); - }, + \}, ), ); - } - }, + \} + \}, ) ], ), ), ), ); - }, + \}, ); - }, + \}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog-class.md b/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog-class.md index 7cdcf62e30d..0141d7a68d6 100644 --- a/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog-class.md +++ b/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog-class.md @@ -11,19 +11,19 @@ -

This Class returns CustomAlertDialog widget. Custom Alert Dialog is a popup +\This Class returns CustomAlertDialog widget. Custom Alert Dialog is a popup that appeared in the screen showing Alert message along with the event buttons. This extends stateless widget that means it cannot change its state during the -runtime of a application.

+runtime of a application.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - CustomAlertDialog @@ -35,100 +35,100 @@ runtime of a application.

## Constructors -[CustomAlertDialog](../widgets_custom_alert_dialog/CustomAlertDialog/CustomAlertDialog.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? successText, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? dialogTitle, [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) reverse = false, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) secondaryButtonText = 'Close', [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html)? secondaryButtonTap, required [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) success, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) dialogSubTitle}) +[CustomAlertDialog](../widgets_custom_alert_dialog/CustomAlertDialog/CustomAlertDialog.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? successText, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? dialogTitle, [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) reverse = false, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) secondaryButtonText = 'Close', [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html)? secondaryButtonTap, required [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) success, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) dialogSubTitle\}) _const_ ## Properties -##### [dialogSubTitle](../widgets_custom_alert_dialog/CustomAlertDialog/dialogSubTitle.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [dialogSubTitle](../widgets_custom_alert_dialog/CustomAlertDialog/dialogSubTitle.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_final_ +_\final\_ -##### [dialogTitle](../widgets_custom_alert_dialog/CustomAlertDialog/dialogTitle.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [dialogTitle](../widgets_custom_alert_dialog/CustomAlertDialog/dialogTitle.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [reverse](../widgets_custom_alert_dialog/CustomAlertDialog/reverse.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [reverse](../widgets_custom_alert_dialog/CustomAlertDialog/reverse.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [secondaryButtonTap](../widgets_custom_alert_dialog/CustomAlertDialog/secondaryButtonTap.md) → [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html)? +##### [secondaryButtonTap](../widgets_custom_alert_dialog/CustomAlertDialog/secondaryButtonTap.md) → [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html)? -_final_ +_\final\_ -##### [secondaryButtonText](../widgets_custom_alert_dialog/CustomAlertDialog/secondaryButtonText.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [secondaryButtonText](../widgets_custom_alert_dialog/CustomAlertDialog/secondaryButtonText.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_final_ +_\final\_ -##### [success](../widgets_custom_alert_dialog/CustomAlertDialog/success.md) → [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) +##### [success](../widgets_custom_alert_dialog/CustomAlertDialog/success.md) → [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) -_final_ +_\final\_ -##### [successText](../widgets_custom_alert_dialog/CustomAlertDialog/successText.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [successText](../widgets_custom_alert_dialog/CustomAlertDialog/successText.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_final_ +_\final\_ @@ -136,95 +136,95 @@ _final_ ## Methods -##### [build](../widgets_custom_alert_dialog/CustomAlertDialog/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../widgets_custom_alert_dialog/CustomAlertDialog/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -232,12 +232,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/CustomAlertDialog.md b/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/CustomAlertDialog.md index 8eaaa8ad140..3cfeca5854d 100644 --- a/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/CustomAlertDialog.md +++ b/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/CustomAlertDialog.md @@ -9,7 +9,7 @@ const -CustomAlertDialog({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? successText, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? dialogTitle, [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) reverse = false, [String](https://api.flutter.dev/flutter/dart-core/String-class.html) secondaryButtonText = 'Close', [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html)? secondaryButtonTap, required [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) success, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) dialogSubTitle}) +CustomAlertDialog(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? successText, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? dialogTitle, [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) reverse = false, [String](https:api.flutter.dev/flutter/dart-core/String-class.html) secondaryButtonText = 'Close', [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html)? secondaryButtonTap, required [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) success, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) dialogSubTitle\}) @@ -18,7 +18,7 @@ CustomAlertDialog({[Key](https://api.flutter.dev/flutter/foundation/Key-class.ht ## Implementation ```dart -const CustomAlertDialog({ +const CustomAlertDialog(\{ Key? key, this.successText, this.dialogTitle, @@ -27,7 +27,7 @@ const CustomAlertDialog({ this.secondaryButtonTap, required this.success, required this.dialogSubTitle, -}) : super(key: key); +\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/build.md b/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/build.md index 1e95480070e..fa34a821887 100644 --- a/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/build.md +++ b/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,11 +58,11 @@ and ```dart @override -Widget build(BuildContext context) { - final List actions = [ +Widget build(BuildContext context) \{ + final List\ actions = [ RaisedRoundedButton( key: const Key('Close'), - onTap: () => secondaryButtonTap ?? navigationService.pop(), + onTap: () =\> secondaryButtonTap ?? navigationService.pop(), buttonLabel: AppLocalizations.of(context)!.strictTranslate(secondaryButtonText), textColor: Colors.white, @@ -72,7 +72,7 @@ Widget build(BuildContext context) { ), RaisedRoundedButton( key: Key(successText ?? 'Confirm'), - onTap: () => success(), + onTap: () =\> success(), buttonLabel: successText ?? AppLocalizations.of(context)!.strictTranslate('Confirm'), textColor: const Color(0xFF008A37), @@ -97,7 +97,7 @@ Widget build(BuildContext context) { ), actions: reverse ? actions.reversed.toList() : actions, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/dialogSubTitle.md b/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/dialogSubTitle.md index 289f53404a9..0cf26a87daf 100644 --- a/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/dialogSubTitle.md +++ b/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/dialogSubTitle.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) dialogSubTitle +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) dialogSubTitle -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/dialogTitle.md b/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/dialogTitle.md index e9b1201be3b..093f208fb9c 100644 --- a/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/dialogTitle.md +++ b/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/dialogTitle.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? dialogTitle +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? dialogTitle -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/reverse.md b/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/reverse.md index 1a6ef66a478..045c6566cfe 100644 --- a/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/reverse.md +++ b/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/reverse.md @@ -9,9 +9,9 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) reverse +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) reverse -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/secondaryButtonTap.md b/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/secondaryButtonTap.md index 69581557bc4..d3e00c0993b 100644 --- a/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/secondaryButtonTap.md +++ b/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/secondaryButtonTap.md @@ -9,9 +9,9 @@ -[Function](https://api.flutter.dev/flutter/dart-core/Function-class.html)? secondaryButtonTap +[Function](https:api.flutter.dev/flutter/dart-core/Function-class.html)? secondaryButtonTap -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/secondaryButtonText.md b/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/secondaryButtonText.md index d56250bfc89..6f89188c3d3 100644 --- a/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/secondaryButtonText.md +++ b/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/secondaryButtonText.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) secondaryButtonText +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) secondaryButtonText -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/success.md b/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/success.md index 5a38d963306..aac03a27a78 100644 --- a/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/success.md +++ b/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/success.md @@ -9,9 +9,9 @@ -[Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) success +[Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) success -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/successText.md b/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/successText.md index bae6cfb7b9a..b4fcf28cd70 100644 --- a/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/successText.md +++ b/docs/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/successText.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? successText +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? successText -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar-class.md b/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar-class.md index b17358fbab9..8d585663054 100644 --- a/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar-class.md +++ b/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar-class.md @@ -11,18 +11,18 @@ -

Creates a custom avatar. +\Creates a custom avatar. The avatar is created using the image provided, -or the first alphabet with a standard background color.

+or the first alphabet with a standard background color.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - CustomAvatar @@ -34,82 +34,82 @@ or the first alphabet with a standard background color.

## Constructors -[CustomAvatar](../widgets_custom_avatar/CustomAvatar/CustomAvatar.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isImageNull, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? firstAlphabet, [BaseCacheManager](https://pub.dev/documentation/flutter_cache_manager/3.3.1/flutter_cache_manager/BaseCacheManager-class.html)? cacheManager, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? imageUrl, [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? fontSize = 40}) +[CustomAvatar](../widgets_custom_avatar/CustomAvatar/CustomAvatar.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isImageNull, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? firstAlphabet, [BaseCacheManager](https:pub.dev/documentation/flutter_cache_manager/3.3.1/flutter_cache_manager/BaseCacheManager-class.html)? cacheManager, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? imageUrl, [double](https:api.flutter.dev/flutter/dart-core/double-class.html)? fontSize = 40\}) _const_ ## Properties -##### [cacheManager](../widgets_custom_avatar/CustomAvatar/cacheManager.md) → [BaseCacheManager](https://pub.dev/documentation/flutter_cache_manager/3.3.1/flutter_cache_manager/BaseCacheManager-class.html)? +##### [cacheManager](../widgets_custom_avatar/CustomAvatar/cacheManager.md) → [BaseCacheManager](https:pub.dev/documentation/flutter_cache_manager/3.3.1/flutter_cache_manager/BaseCacheManager-class.html)? -_final_ +_\final\_ -##### [firstAlphabet](../widgets_custom_avatar/CustomAvatar/firstAlphabet.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [firstAlphabet](../widgets_custom_avatar/CustomAvatar/firstAlphabet.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_final_ +_\final\_ -##### [fontSize](../widgets_custom_avatar/CustomAvatar/fontSize.md) → [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? +##### [fontSize](../widgets_custom_avatar/CustomAvatar/fontSize.md) → [double](https:api.flutter.dev/flutter/dart-core/double-class.html)? -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [imageUrl](../widgets_custom_avatar/CustomAvatar/imageUrl.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [imageUrl](../widgets_custom_avatar/CustomAvatar/imageUrl.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_final_ +_\final\_ -##### [isImageNull](../widgets_custom_avatar/CustomAvatar/isImageNull.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isImageNull](../widgets_custom_avatar/CustomAvatar/isImageNull.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_final_ +_\final\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -117,95 +117,95 @@ _read-onlyinherited_ ## Methods -##### [build](../widgets_custom_avatar/CustomAvatar/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../widgets_custom_avatar/CustomAvatar/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -213,12 +213,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/CustomAvatar.md b/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/CustomAvatar.md index 6889bbd2ef4..b88c3541ee0 100644 --- a/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/CustomAvatar.md +++ b/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/CustomAvatar.md @@ -9,7 +9,7 @@ const -CustomAvatar({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isImageNull, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? firstAlphabet, [BaseCacheManager](https://pub.dev/documentation/flutter_cache_manager/3.3.1/flutter_cache_manager/BaseCacheManager-class.html)? cacheManager, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? imageUrl, [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? fontSize = 40}) +CustomAvatar(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isImageNull, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? firstAlphabet, [BaseCacheManager](https:pub.dev/documentation/flutter_cache_manager/3.3.1/flutter_cache_manager/BaseCacheManager-class.html)? cacheManager, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? imageUrl, [double](https:api.flutter.dev/flutter/dart-core/double-class.html)? fontSize = 40\}) @@ -18,14 +18,14 @@ CustomAvatar({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? ## Implementation ```dart -const CustomAvatar({ +const CustomAvatar(\{ Key? key, required this.isImageNull, this.firstAlphabet, this.cacheManager, this.imageUrl, this.fontSize = 40, -}) : super(key: key); +\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/build.md b/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/build.md index 94273da49a4..709bac54f8e 100644 --- a/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/build.md +++ b/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,9 +58,9 @@ and ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ return isImageNull - //creating the avatar with the icon-theme color when the image is null + creating the avatar with the icon-theme color when the image is null ? CircleAvatar( backgroundColor: Theme.of(context).iconTheme.color!.withOpacity(0.2), @@ -74,28 +74,28 @@ Widget build(BuildContext context) { ), ), ) - //creating the avatar with the provided image + creating the avatar with the provided image : CachedNetworkImage( cacheManager: cacheManager, - imageBuilder: (context, imageProvider) { + imageBuilder: (context, imageProvider) \{ return CircleAvatar( backgroundColor: Theme.of(context).iconTheme.color!.withOpacity(0.2), backgroundImage: imageProvider, ); - }, + \}, imageUrl: imageUrl!, - placeholder: (context, url) => CircleAvatar( + placeholder: (context, url) =\> CircleAvatar( child: Shimmer.fromColors( baseColor: Colors.transparent, highlightColor: Colors.white30, child: const CircleAvatar(), ), ), - errorWidget: (context, url, error) => + errorWidget: (context, url, error) =\> const CircleAvatar(child: Icon(Icons.error)), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/cacheManager.md b/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/cacheManager.md index 64667e80018..16f4f647cc9 100644 --- a/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/cacheManager.md +++ b/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/cacheManager.md @@ -9,9 +9,9 @@ -[BaseCacheManager](https://pub.dev/documentation/flutter_cache_manager/3.3.1/flutter_cache_manager/BaseCacheManager-class.html)? cacheManager +[BaseCacheManager](https:pub.dev/documentation/flutter_cache_manager/3.3.1/flutter_cache_manager/BaseCacheManager-class.html)? cacheManager -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/firstAlphabet.md b/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/firstAlphabet.md index ae1ab0c5f83..9cd407b14a1 100644 --- a/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/firstAlphabet.md +++ b/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/firstAlphabet.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? firstAlphabet +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? firstAlphabet -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/fontSize.md b/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/fontSize.md index 67ce198505c..09d4389b641 100644 --- a/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/fontSize.md +++ b/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/fontSize.md @@ -9,9 +9,9 @@ -[double](https://api.flutter.dev/flutter/dart-core/double-class.html)? fontSize +[double](https:api.flutter.dev/flutter/dart-core/double-class.html)? fontSize -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/imageUrl.md b/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/imageUrl.md index c1aab3120cc..3de7107fefd 100644 --- a/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/imageUrl.md +++ b/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/imageUrl.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? imageUrl +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? imageUrl -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/isImageNull.md b/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/isImageNull.md index 2485f03e95a..fa89b41017e 100644 --- a/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/isImageNull.md +++ b/docs/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/isImageNull.md @@ -9,9 +9,9 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isImageNull +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isImageNull -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer-class.md b/docs/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer-class.md index d50b757b4dc..387b1e0251b 100644 --- a/docs/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer-class.md +++ b/docs/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer-class.md @@ -11,17 +11,17 @@ -

Creates a custom drawer for switching organizations.

-

joining new organizations, or leaving an organization.

+\Creates a custom drawer for switching organizations.\ +\joining new organizations, or leaving an organization.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - CustomDrawer @@ -33,19 +33,19 @@ ## Constructors -[CustomDrawer](../widgets_custom_drawer/CustomDrawer/CustomDrawer.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [MainScreenViewModel](../view_model_main_screen_view_model/MainScreenViewModel-class.md) homeModel}) +[CustomDrawer](../widgets_custom_drawer/CustomDrawer/CustomDrawer.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [MainScreenViewModel](../view_model_main_screen_view_model/MainScreenViewModel-class.md) homeModel\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -54,25 +54,25 @@ _read-onlyinherited_ home model. -_final_ +_\final\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -80,40 +80,40 @@ _read-onlyinherited_ ## Methods -##### [build](../widgets_custom_drawer/CustomDrawer/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../widgets_custom_drawer/CustomDrawer/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ @@ -126,58 +126,58 @@ Button to exit the organization. -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -185,12 +185,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/CustomDrawer.md b/docs/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/CustomDrawer.md index 1a91c48a281..c6c50c71c4a 100644 --- a/docs/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/CustomDrawer.md +++ b/docs/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/CustomDrawer.md @@ -9,7 +9,7 @@ const -CustomDrawer({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [MainScreenViewModel](../../view_model_main_screen_view_model/MainScreenViewModel-class.md) homeModel}) +CustomDrawer(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [MainScreenViewModel](../../view_model_main_screen_view_model/MainScreenViewModel-class.md) homeModel\}) @@ -18,10 +18,10 @@ CustomDrawer({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? ## Implementation ```dart -const CustomDrawer({ +const CustomDrawer(\{ Key? key, required this.homeModel, -}) : super(key: key); +\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/build.md b/docs/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/build.md index 179b7931f0f..27b5dcf8e2e 100644 --- a/docs/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/build.md +++ b/docs/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,10 +58,10 @@ and ```dart @override -Widget build(BuildContext context) { - return BaseView( - onModelReady: (model) => model.initialize(homeModel, context), - builder: (context, model, child) { +Widget build(BuildContext context) \{ + return BaseView\( + onModelReady: (model) =\> model.initialize(homeModel, context), + builder: (context, model, child) \{ return Container( width: SizeConfig.screenWidth! * 0.6, alignment: Alignment.centerLeft, @@ -72,7 +72,7 @@ Widget build(BuildContext context) { Column( crossAxisAlignment: CrossAxisAlignment.start, children: [ - //A material design Drawer header that identifies the app's user. + A material design Drawer header that identifies the app's user. UserAccountsDrawerHeader( currentAccountPicture: CustomAvatar( isImageNull: model.selectedOrg?.image == null, @@ -95,7 +95,7 @@ Widget build(BuildContext context) { ), accountEmail: const SizedBox(), ), - //Tile to Switch organizations + Tile to Switch organizations Column( key: MainScreenViewModel.keyDrawerSwitchableOrg, children: [ @@ -120,11 +120,11 @@ Widget build(BuildContext context) { controller: model.controller, padding: EdgeInsets.zero, itemCount: model.switchAbleOrg.length, - // itemCount: 3, - itemBuilder: (BuildContext context, int index) { + itemCount: 3, + itemBuilder: (BuildContext context, int index) \{ return ListTile( key: const Key("Org"), - onTap: () => model + onTap: () =\> model .switchOrg(model.switchAbleOrg[index]), leading: CustomAvatar( isImageNull: @@ -140,17 +140,17 @@ Widget build(BuildContext context) { model.switchAbleOrg[index].name!, ), ); - }, + \}, ), ), ), ], ), const Divider(), - // A Tile to join a new organization + A Tile to join a new organization ListTile( key: MainScreenViewModel.keyDrawerJoinOrg, - onTap: () => navigationService + onTap: () =\> navigationService .popAndPushScreen(Routes.joinOrg, arguments: '-1'), leading: const Icon( Icons.add, @@ -163,7 +163,7 @@ Widget build(BuildContext context) { ), ListTile( key: MainScreenViewModel.keyDrawerLeaveCurrentOrg, - onTap: () => exitButton(), + onTap: () =\> exitButton(), leading: const Icon(Icons.logout, size: 30), title: Text( AppLocalizations.of(context)! @@ -185,9 +185,9 @@ Widget build(BuildContext context) { ), ), ); - }, + \}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/exitButton.md b/docs/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/exitButton.md index 2d4c0b640c2..23743383253 100644 --- a/docs/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/exitButton.md +++ b/docs/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/exitButton.md @@ -17,30 +17,30 @@ void exitButton -

Button to exit the organization.

-

params: - None

-

returns: - None

+\Button to exit the organization.\ +\\params\: + None\ +\\returns\: + None\ ## Implementation ```dart -void exitButton() { +void exitButton() \{ return navigationService.pushDialog( CustomAlertDialog( key: const Key("Exit?"), reverse: true, dialogSubTitle: 'Are you sure you want to exit this organization?', successText: 'Exit', - success: () { - //Exit org - }, + success: () \{ + Exit org + \}, ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/homeModel.md b/docs/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/homeModel.md index 310768eb98d..2667ce773e7 100644 --- a/docs/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/homeModel.md +++ b/docs/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/homeModel.md @@ -11,11 +11,11 @@ [MainScreenViewModel](../../view_model_main_screen_view_model/MainScreenViewModel-class.md) homeModel -_final_ +_\final\_ -

home model.

+\home model.\ diff --git a/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile-class.md b/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile-class.md index 1bffb888ce2..0b5cd25353d 100644 --- a/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile-class.md +++ b/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile-class.md @@ -11,17 +11,17 @@ -

Returns a widget for rendering Customized tiles. -A Tile shows the org info, user info, options that on tap user & org info.

+\Returns a widget for rendering Customized tiles. +A Tile shows the org info, user info, options that on tap user & org info.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - CustomListTile @@ -33,46 +33,46 @@ A Tile shows the org info, user info, options that on tap user & org info.read-only
inherited_ +_\read-only\\inherited\_ -##### [index](../widgets_custom_list_tile/CustomListTile/index.md) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [index](../widgets_custom_list_tile/CustomListTile/index.md) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) -_final_ +_\final\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [onTapOption](../widgets_custom_list_tile/CustomListTile/onTapOption.md) → [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html)? +##### [onTapOption](../widgets_custom_list_tile/CustomListTile/onTapOption.md) → [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html)? -_final_ +_\final\_ @@ -81,7 +81,7 @@ _final_ -_final_ +_\final\_ @@ -90,7 +90,7 @@ _final_ -_final_ +_\final\_ @@ -99,7 +99,7 @@ _final_ -_final_ +_\final\_ @@ -108,25 +108,25 @@ _final_ -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [showIcon](../widgets_custom_list_tile/CustomListTile/showIcon.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [showIcon](../widgets_custom_list_tile/CustomListTile/showIcon.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_final_ +_\final\_ @@ -135,7 +135,7 @@ _final_ -_final_ +_\final\_ @@ -144,7 +144,7 @@ _final_ -_final_ +_\final\_ @@ -152,95 +152,95 @@ _final_ ## Methods -##### [build](../widgets_custom_list_tile/CustomListTile/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../widgets_custom_list_tile/CustomListTile/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -248,12 +248,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/CustomListTile.md b/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/CustomListTile.md index 3eeda234df5..801d9a6e577 100644 --- a/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/CustomListTile.md +++ b/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/CustomListTile.md @@ -9,7 +9,7 @@ const -CustomListTile({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key, required [int](https://api.flutter.dev/flutter/dart-core/int-class.html) index, required [TileType](../../enums_enums/TileType.md) type, [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) showIcon = false, [OrgInfo](../../models_organization_org_info/OrgInfo-class.md)? orgInfo, dynamic onTapOrgInfo([OrgInfo](../../models_organization_org_info/OrgInfo-class.md))?, [User](../../models_user_user_info/User-class.md)? userInfo, dynamic onTapUserInfo()?, [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html)? onTapOption, [Options](../../models_options_options/Options-class.md)? option}) +CustomListTile(\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key, required [int](https:api.flutter.dev/flutter/dart-core/int-class.html) index, required [TileType](../../enums_enums/TileType.md) type, [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) showIcon = false, [OrgInfo](../../models_organization_org_info/OrgInfo-class.md)? orgInfo, dynamic onTapOrgInfo([OrgInfo](../../models_organization_org_info/OrgInfo-class.md))?, [User](../../models_user_user_info/User-class.md)? userInfo, dynamic onTapUserInfo()?, [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html)? onTapOption, [Options](../../models_options_options/Options-class.md)? option\}) @@ -18,7 +18,7 @@ CustomListTile({required [Key](https://api.flutter.dev/flutter/foundation/Key-cl ## Implementation ```dart -const CustomListTile({ +const CustomListTile(\{ required Key key, required this.index, required this.type, @@ -29,7 +29,7 @@ const CustomListTile({ this.onTapUserInfo, this.onTapOption, this.option, -}) : super(key: key); +\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/build.md b/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/build.md index 7f8f54cc080..01c90dbded0 100644 --- a/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/build.md +++ b/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,14 +58,14 @@ and ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ return InkWell( - // checking wheather the tapped tile is of user or org. - onTap: () => type == TileType.org + checking wheather the tapped tile is of user or org. + onTap: () =\> type == TileType.org ? onTapOrgInfo!(orgInfo!) : type == TileType.user ? onTapUserInfo!() - // ignore: avoid_dynamic_calls + ignore: avoid_dynamic_calls : onTapOption!(), child: Padding( padding: const EdgeInsets.all(18.0), @@ -87,7 +87,7 @@ Widget build(BuildContext context) { type == TileType.org ? orgInfo!.name! : type == TileType.user - ? '${userInfo!.firstName!} ${userInfo!.lastName!}' + ? '$\{userInfo!.firstName!\} $\{userInfo!.lastName!\}' : option!.title, style: type == TileType.org ? Theme.of(context) @@ -132,7 +132,7 @@ Widget build(BuildContext context) { ), ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/index.md b/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/index.md index 8d38fdfe8cf..1d5aa4a515e 100644 --- a/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/index.md +++ b/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/index.md @@ -9,9 +9,9 @@ -[int](https://api.flutter.dev/flutter/dart-core/int-class.html) index +[int](https:api.flutter.dev/flutter/dart-core/int-class.html) index -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/onTapOption.md b/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/onTapOption.md index 1a38e052283..b8d9e66fb67 100644 --- a/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/onTapOption.md +++ b/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/onTapOption.md @@ -9,9 +9,9 @@ -[Function](https://api.flutter.dev/flutter/dart-core/Function-class.html)? onTapOption +[Function](https:api.flutter.dev/flutter/dart-core/Function-class.html)? onTapOption -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/onTapOrgInfo.md b/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/onTapOrgInfo.md index c835fb4c1dd..9a56b309dd5 100644 --- a/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/onTapOrgInfo.md +++ b/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/onTapOrgInfo.md @@ -11,7 +11,7 @@ (dynamic Function([OrgInfo](../../models_organization_org_info/OrgInfo-class.md))?) onTapOrgInfo -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/onTapUserInfo.md b/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/onTapUserInfo.md index 7aed949acfc..a8a8bedf8e4 100644 --- a/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/onTapUserInfo.md +++ b/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/onTapUserInfo.md @@ -11,7 +11,7 @@ (dynamic Function()?) onTapUserInfo -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/option.md b/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/option.md index 5ea41194404..cc190bc27f1 100644 --- a/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/option.md +++ b/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/option.md @@ -11,7 +11,7 @@ [Options](../../models_options_options/Options-class.md)? option -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/orgInfo.md b/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/orgInfo.md index 22dfb8f00fe..cd1cf53db09 100644 --- a/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/orgInfo.md +++ b/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/orgInfo.md @@ -11,7 +11,7 @@ [OrgInfo](../../models_organization_org_info/OrgInfo-class.md)? orgInfo -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/showIcon.md b/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/showIcon.md index fff3c932a16..28ecdca77d4 100644 --- a/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/showIcon.md +++ b/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/showIcon.md @@ -9,9 +9,9 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) showIcon +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) showIcon -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/type.md b/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/type.md index 1b487d77122..49e22b9f0f4 100644 --- a/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/type.md +++ b/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/type.md @@ -11,7 +11,7 @@ [TileType](../../enums_enums/TileType.md) type -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/userInfo.md b/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/userInfo.md index 04e9dd9747c..e5e40ac07bd 100644 --- a/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/userInfo.md +++ b/docs/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/userInfo.md @@ -11,7 +11,7 @@ [User](../../models_user_user_info/User-class.md)? userInfo -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_custom_progress_dialog/CustomProgressDialog-class.md b/docs/talawa-mobile-docs/widgets_custom_progress_dialog/CustomProgressDialog-class.md index 6f3003ddc0f..280d186d675 100644 --- a/docs/talawa-mobile-docs/widgets_custom_progress_dialog/CustomProgressDialog-class.md +++ b/docs/talawa-mobile-docs/widgets_custom_progress_dialog/CustomProgressDialog-class.md @@ -11,18 +11,18 @@ -

A progress dialogue which shows an activity indicator +\A progress dialogue which shows an activity indicator spinning clockwise if there is internet connectivity. -Otherwise, it shows no-internet image and text.

+Otherwise, it shows no-internet image and text.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - CustomProgressDialog @@ -34,37 +34,37 @@ Otherwise, it shows no-internet image and text.

## Constructors -[CustomProgressDialog](../widgets_custom_progress_dialog/CustomProgressDialog/CustomProgressDialog.md) ({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key}) +[CustomProgressDialog](../widgets_custom_progress_dialog/CustomProgressDialog/CustomProgressDialog.md) (\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -72,95 +72,95 @@ _read-onlyinherited_ ## Methods -##### [build](../widgets_custom_progress_dialog/CustomProgressDialog/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../widgets_custom_progress_dialog/CustomProgressDialog/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -168,12 +168,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_custom_progress_dialog/CustomProgressDialog/CustomProgressDialog.md b/docs/talawa-mobile-docs/widgets_custom_progress_dialog/CustomProgressDialog/CustomProgressDialog.md index 3dbcc9b6f5a..070ecd2f6bb 100644 --- a/docs/talawa-mobile-docs/widgets_custom_progress_dialog/CustomProgressDialog/CustomProgressDialog.md +++ b/docs/talawa-mobile-docs/widgets_custom_progress_dialog/CustomProgressDialog/CustomProgressDialog.md @@ -9,7 +9,7 @@ const -CustomProgressDialog({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key}) +CustomProgressDialog(\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key\}) @@ -18,7 +18,7 @@ CustomProgressDialog({required [Key](https://api.flutter.dev/flutter/foundation/ ## Implementation ```dart -const CustomProgressDialog({required Key key}) : super(key: key); +const CustomProgressDialog(\{required Key key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_custom_progress_dialog/CustomProgressDialog/build.md b/docs/talawa-mobile-docs/widgets_custom_progress_dialog/CustomProgressDialog/build.md index 543386b0932..1a5b8950326 100644 --- a/docs/talawa-mobile-docs/widgets_custom_progress_dialog/CustomProgressDialog/build.md +++ b/docs/talawa-mobile-docs/widgets_custom_progress_dialog/CustomProgressDialog/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,10 +58,10 @@ and ```dart @override -Widget build(BuildContext context) { - return BaseView( - onModelReady: (model) => model.initialise(), - builder: (context, model, child) { +Widget build(BuildContext context) \{ + return BaseView\( + onModelReady: (model) =\> model.initialise(), + builder: (context, model, child) \{ return Container( margin: EdgeInsets.symmetric( horizontal: SizeConfig.screenWidth! * 0.25, @@ -73,13 +73,13 @@ Widget build(BuildContext context) { ), child: model.connectivityPresent ? Center( - //An iOS-style activity indicator that spins clockwise. + An iOS-style activity indicator that spins clockwise. child: CupertinoActivityIndicator( radius: SizeConfig.screenWidth! * 0.065, ), ) - // Shows no-internet image and text on no connectivity + Shows no-internet image and text on no connectivity : Column( children: [ Container( @@ -95,15 +95,15 @@ Widget build(BuildContext context) { ), ), Text( - '${AppLocalizations.of(context)!.strictTranslate("No Internet")}!', + '$\{AppLocalizations.of(context)!.strictTranslate("No Internet")\}!', style: Theme.of(context).textTheme.headlineSmall, ), ], ), ); - }, + \}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_date_time_picker/customDatePicker.md b/docs/talawa-mobile-docs/widgets_date_time_picker/customDatePicker.md index be6e41a57be..5e015d0be75 100644 --- a/docs/talawa-mobile-docs/widgets_date_time_picker/customDatePicker.md +++ b/docs/talawa-mobile-docs/widgets_date_time_picker/customDatePicker.md @@ -12,35 +12,35 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[DateTime](https://api.flutter.dev/flutter/dart-core/DateTime-class.html)> customDatePicker -({required [DateTime](https://api.flutter.dev/flutter/dart-core/DateTime-class.html) initialDate}) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[DateTime](https:api.flutter.dev/flutter/dart-core/DateTime-class.html)\> customDatePicker +(\{required [DateTime](https:api.flutter.dev/flutter/dart-core/DateTime-class.html) initialDate\}) -

Shows a dialog containing a Material Design date picker.

-

The returned Future resolves to the date selected by the user when the user confirms the dialog. -If the user cancels the dialog, null is returned.

+\Shows a dialog containing a Material Design date picker.\ +\The returned Future resolves to the date selected by the user when the user confirms the dialog. +If the user cancels the dialog, null is returned.\ ## Implementation ```dart -Future customDatePicker({required DateTime initialDate}) async { - // showDatePicker which shows a material design date range picker used to select a range of dates. +Future\ customDatePicker(\{required DateTime initialDate\}) async \{ + showDatePicker which shows a material design date range picker used to select a range of dates. final DateTime? picked = await showDatePicker( context: navigationService.navigatorKey.currentContext!, initialDate: initialDate, firstDate: DateTime(2015, 8), lastDate: DateTime(2101), ); - if (picked != null && picked != initialDate) { + if (picked != null && picked != initialDate) \{ return picked; - } + \} return initialDate; -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_date_time_picker/customTimePicker.md b/docs/talawa-mobile-docs/widgets_date_time_picker/customTimePicker.md index dbef8ac94ec..7a298ff49a7 100644 --- a/docs/talawa-mobile-docs/widgets_date_time_picker/customTimePicker.md +++ b/docs/talawa-mobile-docs/widgets_date_time_picker/customTimePicker.md @@ -12,35 +12,35 @@ -[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[TimeOfDay](https://api.flutter.dev/flutter/material/TimeOfDay-class.html)> customTimePicker -({required [TimeOfDay](https://api.flutter.dev/flutter/material/TimeOfDay-class.html) initialTime}) +[Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[TimeOfDay](https:api.flutter.dev/flutter/material/TimeOfDay-class.html)\> customTimePicker +(\{required [TimeOfDay](https:api.flutter.dev/flutter/material/TimeOfDay-class.html) initialTime\}) -

Shows a dialog containing a material design time picker.

-

The returned Future resolves to the time selected by the user when the user closes the dialog. -If the user cancels the dialog, null is returned.

+\Shows a dialog containing a material design time picker.\ +\The returned Future resolves to the time selected by the user when the user closes the dialog. +If the user cancels the dialog, null is returned.\ ## Implementation ```dart -Future customTimePicker({required TimeOfDay initialTime}) async { - // showTimePicker which shows a material design time range picker used to select a range of times. - // Click ![here](https://api.flutter.dev/flutter/material/showTimePicker.html) to know more. +Future\ customTimePicker(\{required TimeOfDay initialTime\}) async \{ + showTimePicker which shows a material design time range picker used to select a range of times. + Click ![here](https:api.flutter.dev/flutter/material/showTimePicker.html) to know more. final TimeOfDay? pickedTime = await showTimePicker( context: navigationService.navigatorKey.currentContext!, initialTime: initialTime, ); - if (pickedTime != null && pickedTime != initialTime) { + if (pickedTime != null && pickedTime != initialTime) \{ return pickedTime; - } + \} return initialTime; -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_date_time_picker/widgets_date_time_picker-library.md b/docs/talawa-mobile-docs/widgets_date_time_picker/widgets_date_time_picker-library.md index 2a02458bf7a..c1c7dae385b 100644 --- a/docs/talawa-mobile-docs/widgets_date_time_picker/widgets_date_time_picker-library.md +++ b/docs/talawa-mobile-docs/widgets_date_time_picker/widgets_date_time_picker-library.md @@ -21,7 +21,7 @@ ## Functions -##### [customDatePicker](../widgets_date_time_picker/customDatePicker.md)({required [DateTime](https://api.flutter.dev/flutter/dart-core/DateTime-class.html) initialDate}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[DateTime](https://api.flutter.dev/flutter/dart-core/DateTime-class.html)> +##### [customDatePicker](../widgets_date_time_picker/customDatePicker.md)(\{required [DateTime](https:api.flutter.dev/flutter/dart-core/DateTime-class.html) initialDate\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[DateTime](https:api.flutter.dev/flutter/dart-core/DateTime-class.html)\> @@ -30,7 +30,7 @@ Shows a dialog containing a Material Design date picker. -##### [customTimePicker](../widgets_date_time_picker/customTimePicker.md)({required [TimeOfDay](https://api.flutter.dev/flutter/material/TimeOfDay-class.html) initialTime}) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[TimeOfDay](https://api.flutter.dev/flutter/material/TimeOfDay-class.html)> +##### [customTimePicker](../widgets_date_time_picker/customTimePicker.md)(\{required [TimeOfDay](https:api.flutter.dev/flutter/material/TimeOfDay-class.html) initialTime\}) [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[TimeOfDay](https:api.flutter.dev/flutter/material/TimeOfDay-class.html)\> diff --git a/docs/talawa-mobile-docs/widgets_event_card/EventCard-class.md b/docs/talawa-mobile-docs/widgets_event_card/EventCard-class.md index a823fc9c5f7..1cd08af4125 100644 --- a/docs/talawa-mobile-docs/widgets_event_card/EventCard-class.md +++ b/docs/talawa-mobile-docs/widgets_event_card/EventCard-class.md @@ -11,16 +11,16 @@ -

This class returns the EventCard widget.

+\This class returns the EventCard widget.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - EventCard @@ -32,7 +32,7 @@ ## Constructors -[EventCard](../widgets_event_card/EventCard/EventCard.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Event](../models_events_event_model/Event-class.md) event, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? eventTitleHighlightedText, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? eventTitleNormalText, required [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isSearchItem}) +[EventCard](../widgets_event_card/EventCard/EventCard.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Event](../models_events_event_model/Event-class.md) event, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? eventTitleHighlightedText, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? eventTitleNormalText, required [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isSearchItem\}) _const_ @@ -44,61 +44,61 @@ -_final_ +_\final\_ -##### [eventTitleHighlightedText](../widgets_event_card/EventCard/eventTitleHighlightedText.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [eventTitleHighlightedText](../widgets_event_card/EventCard/eventTitleHighlightedText.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_final_ +_\final\_ -##### [eventTitleNormalText](../widgets_event_card/EventCard/eventTitleNormalText.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [eventTitleNormalText](../widgets_event_card/EventCard/eventTitleNormalText.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [isSearchItem](../widgets_event_card/EventCard/isSearchItem.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [isSearchItem](../widgets_event_card/EventCard/isSearchItem.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_final_ +_\final\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -106,95 +106,95 @@ _read-onlyinherited_ ## Methods -##### [build](../widgets_event_card/EventCard/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../widgets_event_card/EventCard/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -202,12 +202,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_event_card/EventCard/EventCard.md b/docs/talawa-mobile-docs/widgets_event_card/EventCard/EventCard.md index f6421729ad5..139c4c6ff49 100644 --- a/docs/talawa-mobile-docs/widgets_event_card/EventCard/EventCard.md +++ b/docs/talawa-mobile-docs/widgets_event_card/EventCard/EventCard.md @@ -9,7 +9,7 @@ const -EventCard({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Event](../../models_events_event_model/Event-class.md) event, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? eventTitleHighlightedText, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? eventTitleNormalText, required [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isSearchItem}) +EventCard(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Event](../../models_events_event_model/Event-class.md) event, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? eventTitleHighlightedText, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? eventTitleNormalText, required [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isSearchItem\}) @@ -18,13 +18,13 @@ EventCard({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key ## Implementation ```dart -const EventCard({ +const EventCard(\{ Key? key, required this.event, this.eventTitleHighlightedText, this.eventTitleNormalText, required this.isSearchItem, -}) : super(key: key); +\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_event_card/EventCard/build.md b/docs/talawa-mobile-docs/widgets_event_card/EventCard/build.md index feddc8335c0..6d0623e6c21 100644 --- a/docs/talawa-mobile-docs/widgets_event_card/EventCard/build.md +++ b/docs/talawa-mobile-docs/widgets_event_card/EventCard/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,7 +58,7 @@ and ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ final bool isRegistered = event.isRegistered ?? false; return Padding( padding: const EdgeInsets.only(bottom: 10), @@ -89,7 +89,7 @@ Widget build(BuildContext context) { fit: BoxFit.fitWidth, alignment: FractionalOffset.topCenter, image: NetworkImage( - 'https://picsum.photos/id/1022/200/300', + 'https:picsum.photos/id/1022/200/300', ), ), ), @@ -152,7 +152,7 @@ Widget build(BuildContext context) { ), const Spacer(), Text( - "${event.startDate!} - ${event.endDate!}", + "$\{event.startDate!\} - $\{event.endDate!\}", style: Theme.of(context).textTheme.bodySmall, ) ], @@ -170,7 +170,7 @@ Widget build(BuildContext context) { width: SizeConfig.screenWidth! * 0.015, ), Text( - "${event.startTime!} - ${event.endTime!}", + "$\{event.startTime!\} - $\{event.endTime!\}", style: Theme.of(context).textTheme.bodySmall, ), const Spacer(), @@ -325,7 +325,7 @@ Widget build(BuildContext context) { ], ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_event_card/EventCard/event.md b/docs/talawa-mobile-docs/widgets_event_card/EventCard/event.md index 9714bc41af6..37484898515 100644 --- a/docs/talawa-mobile-docs/widgets_event_card/EventCard/event.md +++ b/docs/talawa-mobile-docs/widgets_event_card/EventCard/event.md @@ -11,7 +11,7 @@ [Event](../../models_events_event_model/Event-class.md) event -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_event_card/EventCard/eventTitleHighlightedText.md b/docs/talawa-mobile-docs/widgets_event_card/EventCard/eventTitleHighlightedText.md index 237bbbb8156..e5f634b29b8 100644 --- a/docs/talawa-mobile-docs/widgets_event_card/EventCard/eventTitleHighlightedText.md +++ b/docs/talawa-mobile-docs/widgets_event_card/EventCard/eventTitleHighlightedText.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? eventTitleHighlightedText +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? eventTitleHighlightedText -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_event_card/EventCard/eventTitleNormalText.md b/docs/talawa-mobile-docs/widgets_event_card/EventCard/eventTitleNormalText.md index bbc1edc6c4c..7e79c6720e4 100644 --- a/docs/talawa-mobile-docs/widgets_event_card/EventCard/eventTitleNormalText.md +++ b/docs/talawa-mobile-docs/widgets_event_card/EventCard/eventTitleNormalText.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? eventTitleNormalText +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? eventTitleNormalText -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_event_card/EventCard/isSearchItem.md b/docs/talawa-mobile-docs/widgets_event_card/EventCard/isSearchItem.md index 463d3fb1e66..888066b19aa 100644 --- a/docs/talawa-mobile-docs/widgets_event_card/EventCard/isSearchItem.md +++ b/docs/talawa-mobile-docs/widgets_event_card/EventCard/isSearchItem.md @@ -9,9 +9,9 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isSearchItem +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) isSearchItem -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile-class.md b/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile-class.md index 4e7838b6ebe..7b267392867 100644 --- a/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile-class.md +++ b/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile-class.md @@ -11,16 +11,16 @@ -

Returns a widget tile(item) for displaying date and time.

+\Returns a widget tile(item) for displaying date and time.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - DateTimeTile @@ -32,73 +32,73 @@ ## Constructors -[DateTimeTile](../widgets_event_date_time_tile/DateTimeTile/DateTimeTile.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) date, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) time, required [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) setDate, required [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) setTime}) +[DateTimeTile](../widgets_event_date_time_tile/DateTimeTile/DateTimeTile.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) date, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) time, required [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) setDate, required [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) setTime\}) _const_ ## Properties -##### [date](../widgets_event_date_time_tile/DateTimeTile/date.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [date](../widgets_event_date_time_tile/DateTimeTile/date.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [setDate](../widgets_event_date_time_tile/DateTimeTile/setDate.md) → [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) +##### [setDate](../widgets_event_date_time_tile/DateTimeTile/setDate.md) → [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) -_final_ +_\final\_ -##### [setTime](../widgets_event_date_time_tile/DateTimeTile/setTime.md) → [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) +##### [setTime](../widgets_event_date_time_tile/DateTimeTile/setTime.md) → [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) -_final_ +_\final\_ -##### [time](../widgets_event_date_time_tile/DateTimeTile/time.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [time](../widgets_event_date_time_tile/DateTimeTile/time.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_final_ +_\final\_ @@ -106,95 +106,95 @@ _final_ ## Methods -##### [build](../widgets_event_date_time_tile/DateTimeTile/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../widgets_event_date_time_tile/DateTimeTile/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -202,12 +202,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/DateTimeTile.md b/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/DateTimeTile.md index 9a125531749..05ef52f5099 100644 --- a/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/DateTimeTile.md +++ b/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/DateTimeTile.md @@ -9,7 +9,7 @@ const -DateTimeTile({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) date, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) time, required [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) setDate, required [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) setTime}) +DateTimeTile(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) date, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) time, required [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) setDate, required [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) setTime\}) @@ -18,13 +18,13 @@ DateTimeTile({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? ## Implementation ```dart -const DateTimeTile({ +const DateTimeTile(\{ Key? key, required this.date, required this.time, required this.setDate, required this.setTime, -}) : super(key: key); +\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/build.md b/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/build.md index ab4c1078f8b..80099dcddf9 100644 --- a/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/build.md +++ b/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,7 +58,7 @@ and ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ return Container( color: Theme.of(context).colorScheme.primaryContainer, height: SizeConfig.screenHeight! * 0.068, @@ -78,9 +78,9 @@ Widget build(BuildContext context) { ), InkWell( key: const Key('EventDateTimeTileDate'), - onTap: () async { + onTap: () async \{ setDate(); - }, + \}, child: Text( date, style: const TextStyle(fontSize: 16), @@ -97,9 +97,9 @@ Widget build(BuildContext context) { ), InkWell( key: const Key('EventDateTimeTileTime'), - onTap: () async { + onTap: () async \{ setTime(); - }, + \}, child: Text( time, style: const TextStyle(fontSize: 16), @@ -109,7 +109,7 @@ Widget build(BuildContext context) { ), ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/date.md b/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/date.md index 5c32ea33f76..7d591132595 100644 --- a/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/date.md +++ b/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/date.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) date +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) date -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/setDate.md b/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/setDate.md index b07f5810df2..79d444f374d 100644 --- a/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/setDate.md +++ b/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/setDate.md @@ -9,9 +9,9 @@ -[Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) setDate +[Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) setDate -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/setTime.md b/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/setTime.md index 8ede21b1286..23f4d257a56 100644 --- a/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/setTime.md +++ b/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/setTime.md @@ -9,9 +9,9 @@ -[Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) setTime +[Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) setTime -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/time.md b/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/time.md index ebc301185c9..58ec1568404 100644 --- a/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/time.md +++ b/docs/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/time.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) time +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) time -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch-class.md b/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch-class.md index 1b25b05d5a0..810214d5c1f 100644 --- a/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch-class.md +++ b/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch-class.md @@ -11,14 +11,14 @@ -

This class returns a list of the events which match the search query.

+\This class returns a list of the events which match the search query.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [SearchDelegate](https://api.flutter.dev/flutter/material/SearchDelegate-class.html)<[Event](../models_events_event_model/Event-class.md)> +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [SearchDelegate](https:api.flutter.dev/flutter/material/SearchDelegate-class.html)<[Event](../models_events_event_model/Event-class.md)\> - EventSearch @@ -30,19 +30,19 @@ ## Constructors -[EventSearch](../widgets_event_search_delegate/EventSearch/EventSearch.md) ({required [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Event](../models_events_event_model/Event-class.md)> eventList, required [ExploreEventsViewModel](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md) exploreEventsViewModel}) +[EventSearch](../widgets_event_search_delegate/EventSearch/EventSearch.md) (\{required [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Event](../models_events_event_model/Event-class.md)\> eventList, required [ExploreEventsViewModel](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md) exploreEventsViewModel\}) ## Properties -##### [eventList](../widgets_event_search_delegate/EventSearch/eventList.md) → [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Event](../models_events_event_model/Event-class.md)> +##### [eventList](../widgets_event_search_delegate/EventSearch/eventList.md) → [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Event](../models_events_event_model/Event-class.md)\> -_final_ +_\final\_ @@ -51,89 +51,89 @@ _final_ -_read / write_ +_\read / write\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [keyboardType](https://api.flutter.dev/flutter/material/SearchDelegate/keyboardType.html) → [TextInputType](https://api.flutter.dev/flutter/services/TextInputType-class.html)? +##### [keyboardType](https:api.flutter.dev/flutter/material/SearchDelegate/keyboardType.html) → [TextInputType](https:api.flutter.dev/flutter/services/TextInputType-class.html)? The type of action button to use for the keyboard. -_finalinherited_ +_\final\\inherited\_ -##### [query](https://api.flutter.dev/flutter/material/SearchDelegate/query.html) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [query](https:api.flutter.dev/flutter/material/SearchDelegate/query.html) ↔ [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -The current query string shown in the
AppBar. -_read / writeinherited_ +The current query string shown in the \AppBar\. +_\read / write\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [searchFieldDecorationTheme](https://api.flutter.dev/flutter/material/SearchDelegate/searchFieldDecorationTheme.html) → [InputDecorationTheme](https://api.flutter.dev/flutter/material/InputDecorationTheme-class.html)? +##### [searchFieldDecorationTheme](https:api.flutter.dev/flutter/material/SearchDelegate/searchFieldDecorationTheme.html) → [InputDecorationTheme](https:api.flutter.dev/flutter/material/InputDecorationTheme-class.html)? -The InputDecorationTheme used to configure the search field's visuals. -_finalinherited_ +The \InputDecorationTheme\ used to configure the search field's visuals. +_\final\\inherited\_ -##### [searchFieldLabel](https://api.flutter.dev/flutter/material/SearchDelegate/searchFieldLabel.html) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [searchFieldLabel](https:api.flutter.dev/flutter/material/SearchDelegate/searchFieldLabel.html) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? The hint text that is shown in the search field when it is empty. -_finalinherited_ +_\final\\inherited\_ -##### [searchFieldStyle](https://api.flutter.dev/flutter/material/SearchDelegate/searchFieldStyle.html) → [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html)? +##### [searchFieldStyle](https:api.flutter.dev/flutter/material/SearchDelegate/searchFieldStyle.html) → [TextStyle](https:api.flutter.dev/flutter/painting/TextStyle-class.html)? -The style of the searchFieldLabel. -_finalinherited_ +The style of the \searchFieldLabel\. +_\final\\inherited\_ -##### [textInputAction](https://api.flutter.dev/flutter/material/SearchDelegate/textInputAction.html) → [TextInputAction](https://api.flutter.dev/flutter/services/TextInputAction.html) +##### [textInputAction](https:api.flutter.dev/flutter/material/SearchDelegate/textInputAction.html) → [TextInputAction](https:api.flutter.dev/flutter/services/TextInputAction.html) The text input action configuring the soft keyboard to a particular action button. -_finalinherited_ +_\final\\inherited\_ -##### [transitionAnimation](https://api.flutter.dev/flutter/material/SearchDelegate/transitionAnimation.html) → [Animation](https://api.flutter.dev/flutter/animation/Animation-class.html)<[double](https://api.flutter.dev/flutter/dart-core/double-class.html)> +##### [transitionAnimation](https:api.flutter.dev/flutter/material/SearchDelegate/transitionAnimation.html) → [Animation](https:api.flutter.dev/flutter/animation/Animation-class.html)<[double](https:api.flutter.dev/flutter/dart-core/double-class.html)\> -Animation triggered when the search pages fades in or out. -_read-onlyinherited_ +\Animation\ triggered when the search pages fades in or out. +_\read-only\\inherited\_ @@ -141,62 +141,62 @@ _read-onlyinherited_ ## Methods -##### [appBarTheme](https://api.flutter.dev/flutter/material/SearchDelegate/appBarTheme.html)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [ThemeData](https://api.flutter.dev/flutter/material/ThemeData-class.html) +##### [appBarTheme](https:api.flutter.dev/flutter/material/SearchDelegate/appBarTheme.html)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [ThemeData](https:api.flutter.dev/flutter/material/ThemeData-class.html) The theme used to configure the search page. -_inherited_ +_\inherited\_ -##### [buildActions](../widgets_event_search_delegate/EventSearch/buildActions.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html)> +##### [buildActions](../widgets_event_search_delegate/EventSearch/buildActions.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html)\> -Widgets to display after the search query in the AppBar. -_override_ +Widgets to display after the search query in the \AppBar\. +_\override\_ -##### [buildBottom](https://api.flutter.dev/flutter/material/SearchDelegate/buildBottom.html)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [PreferredSizeWidget](https://api.flutter.dev/flutter/widgets/PreferredSizeWidget-class.html)? +##### [buildBottom](https:api.flutter.dev/flutter/material/SearchDelegate/buildBottom.html)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [PreferredSizeWidget](https:api.flutter.dev/flutter/widgets/PreferredSizeWidget-class.html)? -Widget to display across the bottom of the AppBar. -_inherited_ +Widget to display across the bottom of the \AppBar\. +_\inherited\_ -##### [buildLeading](../widgets_event_search_delegate/EventSearch/buildLeading.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [buildLeading](../widgets_event_search_delegate/EventSearch/buildLeading.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) -A widget to display before the current query in the AppBar. -_override_ +A widget to display before the current query in the \AppBar\. +_\override\_ -##### [buildResults](../widgets_event_search_delegate/EventSearch/buildResults.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [buildResults](../widgets_event_search_delegate/EventSearch/buildResults.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) The results shown after the user submits a search from the search page. -_override_ +_\override\_ -##### [buildSuggestions](../widgets_event_search_delegate/EventSearch/buildSuggestions.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [buildSuggestions](../widgets_event_search_delegate/EventSearch/buildSuggestions.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Suggestions shown in the body of the search page while the user types a query into the search field. -_override_ +_\override\_ -##### [buildSuggestionsSucess](../widgets_event_search_delegate/EventSearch/buildSuggestionsSucess.md)([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Event](../models_events_event_model/Event-class.md)> suggestions) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [buildSuggestionsSucess](../widgets_event_search_delegate/EventSearch/buildSuggestionsSucess.md)([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Event](../models_events_event_model/Event-class.md)\> suggestions) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) @@ -205,50 +205,50 @@ _override_ -##### [close](https://api.flutter.dev/flutter/material/SearchDelegate/close.html)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context, [Event](../models_events_event_model/Event-class.md) result) void +##### [close](https:api.flutter.dev/flutter/material/SearchDelegate/close.html)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context, [Event](../models_events_event_model/Event-class.md) result) void Closes the search page and returns to the underlying route. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [showResults](https://api.flutter.dev/flutter/material/SearchDelegate/showResults.html)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) void +##### [showResults](https:api.flutter.dev/flutter/material/SearchDelegate/showResults.html)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) void -Transition from the suggestions returned by buildSuggestions to the -query results returned by buildResults. -_inherited_ +Transition from the suggestions returned by \buildSuggestions\ to the +\query\ results returned by \buildResults\. +_\inherited\_ -##### [showSuggestions](https://api.flutter.dev/flutter/material/SearchDelegate/showSuggestions.html)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) void +##### [showSuggestions](https:api.flutter.dev/flutter/material/SearchDelegate/showSuggestions.html)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) void -Transition from showing the results returned by buildResults to showing -the suggestions returned by buildSuggestions. -_inherited_ +Transition from showing the results returned by \buildResults\ to showing +the suggestions returned by \buildSuggestions\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/dart-core/Object/toString.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ @@ -256,12 +256,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/EventSearch.md b/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/EventSearch.md index 63dfbfee056..c9719b27904 100644 --- a/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/EventSearch.md +++ b/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/EventSearch.md @@ -9,7 +9,7 @@ -EventSearch({required [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Event](../../models_events_event_model/Event-class.md)> eventList, required [ExploreEventsViewModel](../../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md) exploreEventsViewModel}) +EventSearch(\{required [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Event](../../models_events_event_model/Event-class.md)\> eventList, required [ExploreEventsViewModel](../../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md) exploreEventsViewModel\}) @@ -18,7 +18,7 @@ EventSearch({required [List](https://api.flutter.dev/flutter/dart-core/List-clas ## Implementation ```dart -EventSearch({required this.eventList, required this.exploreEventsViewModel}); +EventSearch(\{required this.eventList, required this.exploreEventsViewModel\}); ``` diff --git a/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/buildActions.md b/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/buildActions.md index 955593cee4a..7b9f69cce91 100644 --- a/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/buildActions.md +++ b/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/buildActions.md @@ -9,24 +9,24 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html)> buildActions -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html)\> buildActions +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Widgets to display after the search query in the AppBar.

-

If the query is not empty, this should typically contain a button to -clear the query and show the suggestions again (via showSuggestions) if -the results are currently shown.

-

Returns null if no widget should be shown.

-

See also:

-
    -
  • AppBar.actions, the intended use for the return value of this method.
  • -
+\Widgets to display after the search query in the \AppBar\.\ +\If the \query\ is not empty, this should typically contain a button to +clear the query and show the suggestions again (via \showSuggestions\) if +the results are currently shown.\ +\Returns null if no widget should be shown.\ +\See also:\ +\ +\\AppBar.actions\, the intended use for the return value of this method.\ +\ @@ -34,19 +34,19 @@ the results are currently shown.

```dart @override -List buildActions(BuildContext context) { - /// Returns an icon button which closes the search page and returns - /// to the underlying route if the query is empty. Otherwise it sets the - /// query empty. +List\ buildActions(BuildContext context) \{ + Returns an icon button which closes the search page and returns + to the underlying route if the query is empty. Otherwise it sets the + query empty. return [ IconButton( - onPressed: () { + onPressed: () \{ query.isNotEmpty ? query = '' : close(context, eventList.first); - }, + \}, icon: const Icon(Icons.clear), ) ]; -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/buildLeading.md b/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/buildLeading.md index 932c3165c83..c1af82c52f5 100644 --- a/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/buildLeading.md +++ b/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/buildLeading.md @@ -9,25 +9,25 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) buildLeading -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) buildLeading +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

A widget to display before the current query in the AppBar.

-

Typically an IconButton configured with a BackButtonIcon that exits -the search with close. One can also use an AnimatedIcon driven by -transitionAnimation, which animates from e.g. a hamburger menu to the -back button as the search overlay fades in.

-

Returns null if no widget should be shown.

-

See also:

-
    -
  • AppBar.leading, the intended use for the return value of this method.
  • -
+\A widget to display before the current query in the \AppBar\.\ +\Typically an \IconButton\ configured with a \BackButtonIcon\ that exits +the search with \close\. One can also use an \AnimatedIcon\ driven by +\transitionAnimation\, which animates from e.g. a hamburger menu to the +back button as the search overlay fades in.\ +\Returns null if no widget should be shown.\ +\See also:\ +\ +\\AppBar.leading\, the intended use for the return value of this method.\ +\ @@ -35,16 +35,16 @@ back button as the search overlay fades in.

```dart @override -Widget buildLeading(BuildContext context) { - /// Returns an icon button which closes the search page and returns - /// to the underlying route +Widget buildLeading(BuildContext context) \{ + Returns an icon button which closes the search page and returns + to the underlying route return IconButton( - onPressed: () { + onPressed: () \{ close(context, eventList.first); - }, + \}, icon: const Icon(Icons.arrow_back), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/buildResults.md b/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/buildResults.md index f2746447d7b..56dd3957ca0 100644 --- a/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/buildResults.md +++ b/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/buildResults.md @@ -9,25 +9,25 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) buildResults -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) buildResults +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

The results shown after the user submits a search from the search page.

-

The current value of query can be used to determine what the user -searched for.

-

This method might be applied more than once to the same query. -If your buildResults method is computationally expensive, you may want -to cache the search results for one or more queries.

-

Typically, this method returns a ListView with the search results. -When the user taps on a particular search result, close should be called +\The results shown after the user submits a search from the search page.\ +\The current value of \query\ can be used to determine what the user +searched for.\ +\This method might be applied more than once to the same query. +If your \buildResults\ method is computationally expensive, you may want +to cache the search results for one or more queries.\ +\Typically, this method returns a \ListView\ with the search results. +When the user taps on a particular search result, \close\ should be called with the selected result as argument. This will close the search page and -communicate the result back to the initial caller of showSearch.

+communicate the result back to the initial caller of \showSearch\.\ @@ -35,9 +35,9 @@ communicate the result back to the initial caller of override_ +_\override\_ -

Suggestions shown in the body of the search page while the user types a -query into the search field.

-

The delegate method is called whenever the content of query changes. -The suggestions should be based on the current query string. If the query +\Suggestions shown in the body of the search page while the user types a +query into the search field.\ +\The delegate method is called whenever the content of \query\ changes. +The suggestions should be based on the current \query\ string. If the query string is empty, it is good practice to show suggested queries based on -past queries or the current context.

-

Usually, this method will return a ListView with one ListTile per -suggestion. When ListTile.onTap is called, query should be updated +past queries or the current context.\ +\Usually, this method will return a \ListView\ with one \ListTile\ per +suggestion. When \ListTile.onTap\ is called, \query\ should be updated with the corresponding suggestion and the results page should be shown -by calling showResults.

+by calling \showResults\.\ @@ -35,18 +35,18 @@ by calling suggestions) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) buildSuggestionsSucess +([List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Event](../../models_events_event_model/Event-class.md)\> suggestions) @@ -23,33 +23,33 @@ ## Implementation ```dart -Widget buildSuggestionsSucess(List suggestions) { - /// Takes a List of Events as parameter which is passed by the "buildSuggestions" function. - /// Returns a SingleChildScrollView of the events from the list. - /// SingleChildScrollView is box in which a single widget can be scrolled. +Widget buildSuggestionsSucess(List\ suggestions) \{ + Takes a List of Events as parameter which is passed by the "buildSuggestions" function. + Returns a SingleChildScrollView of the events from the list. + SingleChildScrollView is box in which a single widget can be scrolled. return SingleChildScrollView( child: ListView.builder( physics: const NeverScrollableScrollPhysics(), shrinkWrap: true, itemCount: suggestions.length, - itemBuilder: (BuildContext context, int index) { + itemBuilder: (BuildContext context, int index) \{ final highlightedText = suggestions[index].title!.substring(0, query.length); final normalText = suggestions[index].title!.substring(query.length); - /// Returns a widget that detects gestures. - /// Defers to its child for its sizing behavior. - /// Navigates to the screen with the event information. + Returns a widget that detects gestures. + Defers to its child for its sizing behavior. + Navigates to the screen with the event information. return GestureDetector( - onTap: () { + onTap: () \{ navigationService.pushScreen( "/eventInfo", - arguments: { + arguments: \{ "event": suggestions[index], "exploreEventViewModel": exploreEventsViewModel - }, + \}, ); - }, + \}, child: EventCard( event: suggestions[index], isSearchItem: true, @@ -57,10 +57,10 @@ Widget buildSuggestionsSucess(List suggestions) { eventTitleNormalText: normalText, ), ); - }, + \}, ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/eventList.md b/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/eventList.md index 9fb10e4c0ec..6ae22e4aa4f 100644 --- a/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/eventList.md +++ b/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/eventList.md @@ -9,9 +9,9 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Event](../../models_events_event_model/Event-class.md)> eventList +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Event](../../models_events_event_model/Event-class.md)\> eventList -_final_ +_\final\_ @@ -21,7 +21,7 @@ _final_ ## Implementation ```dart -final List eventList; +final List\ eventList; ``` diff --git a/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/exploreEventsViewModel.md b/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/exploreEventsViewModel.md index 3ca7e2f79b3..c1d9dc8e2e4 100644 --- a/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/exploreEventsViewModel.md +++ b/docs/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/exploreEventsViewModel.md @@ -11,7 +11,7 @@ [ExploreEventsViewModel](../../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md) exploreEventsViewModel -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/widgets_from_palisadoes/FromPalisadoes-class.md b/docs/talawa-mobile-docs/widgets_from_palisadoes/FromPalisadoes-class.md index 29596a85e9f..76b6c891013 100644 --- a/docs/talawa-mobile-docs/widgets_from_palisadoes/FromPalisadoes-class.md +++ b/docs/talawa-mobile-docs/widgets_from_palisadoes/FromPalisadoes-class.md @@ -11,16 +11,16 @@ -

This class generates the text "From Palisadoes" in a custom way.

+\This class generates the text "From Palisadoes" in a custom way.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - FromPalisadoes @@ -32,37 +32,37 @@ ## Constructors -[FromPalisadoes](../widgets_from_palisadoes/FromPalisadoes/FromPalisadoes.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +[FromPalisadoes](../widgets_from_palisadoes/FromPalisadoes/FromPalisadoes.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -70,95 +70,95 @@ _read-onlyinherited_ ## Methods -##### [build](../widgets_from_palisadoes/FromPalisadoes/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../widgets_from_palisadoes/FromPalisadoes/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -166,12 +166,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_from_palisadoes/FromPalisadoes/FromPalisadoes.md b/docs/talawa-mobile-docs/widgets_from_palisadoes/FromPalisadoes/FromPalisadoes.md index 2932b6ed570..38a59ab043c 100644 --- a/docs/talawa-mobile-docs/widgets_from_palisadoes/FromPalisadoes/FromPalisadoes.md +++ b/docs/talawa-mobile-docs/widgets_from_palisadoes/FromPalisadoes/FromPalisadoes.md @@ -9,7 +9,7 @@ const -FromPalisadoes({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +FromPalisadoes(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) @@ -18,7 +18,7 @@ FromPalisadoes({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html) ## Implementation ```dart -const FromPalisadoes({Key? key}) : super(key: key); +const FromPalisadoes(\{Key? key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_from_palisadoes/FromPalisadoes/build.md b/docs/talawa-mobile-docs/widgets_from_palisadoes/FromPalisadoes/build.md index e4b6eb4cf7c..d508fd397a3 100644 --- a/docs/talawa-mobile-docs/widgets_from_palisadoes/FromPalisadoes/build.md +++ b/docs/talawa-mobile-docs/widgets_from_palisadoes/FromPalisadoes/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,16 +58,16 @@ and ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ return Column( children: [ - // Customizing the word "from". + Customizing the word "from". Row( mainAxisSize: MainAxisSize.max, mainAxisAlignment: MainAxisAlignment.center, children: [ Text( - // This method is called for localized text. + This method is called for localized text. AppLocalizations.of(context)!.strictTranslate('from'), style: Theme.of(context).textTheme.bodySmall, ), @@ -76,7 +76,7 @@ Widget build(BuildContext context) { SizedBox( height: SizeConfig.blockSizeHorizontal, ), - // Customizing the word "Palisadoes". + Customizing the word "Palisadoes". Row( mainAxisSize: MainAxisSize.max, mainAxisAlignment: MainAxisAlignment.center, @@ -95,7 +95,7 @@ Widget build(BuildContext context) { ), ], ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_invite_child/iconButton.md b/docs/talawa-mobile-docs/widgets_invite_child/iconButton.md index 69577b9a844..a73fa413611 100644 --- a/docs/talawa-mobile-docs/widgets_invite_child/iconButton.md +++ b/docs/talawa-mobile-docs/widgets_invite_child/iconButton.md @@ -12,35 +12,35 @@ -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) iconButton -([String](https://api.flutter.dev/flutter/dart-core/String-class.html) key, [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) icon, [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) onTap) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) iconButton +([String](https:api.flutter.dev/flutter/dart-core/String-class.html) key, [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) icon, [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) onTap) -

This function is for debugging purposes. -It prints "tapped" in the console for the developer to know that the button was tapped.

+\This function is for debugging purposes. +It prints "tapped" in the console for the developer to know that the button was tapped.\ ## Implementation ```dart -Widget iconButton(String key, Widget icon, Function onTap) { +Widget iconButton(String key, Widget icon, Function onTap) \{ return Stack( children: [ IconButton( key: Key(key), - onPressed: () { + onPressed: () \{ print('tapped'); onTap(); - }, + \}, icon: icon, ), ], ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_invite_child/invite.md b/docs/talawa-mobile-docs/widgets_invite_child/invite.md index 2b55a998b7f..a5bcf16c342 100644 --- a/docs/talawa-mobile-docs/widgets_invite_child/invite.md +++ b/docs/talawa-mobile-docs/widgets_invite_child/invite.md @@ -12,38 +12,38 @@ -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) invite -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) invite +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -

This widget gives us various options to invite someone to an organization. -We can use QR code scanner, social media platforms like twitter, whatsapp, telegram and many more.

+\This widget gives us various options to invite someone to an organization. +We can use QR code scanner, social media platforms like twitter, whatsapp, telegram and many more.\ ## Implementation ```dart -Widget invite(BuildContext context) { +Widget invite(BuildContext context) \{ _appLanguageService.initialize(); final String url = - 'https://cyberwake.github.io/applink/invite?selectLang=${_appLanguageService.appLocal.languageCode}&setUrl=${GraphqlConfig.orgURI}&selectOrg=${userConfig.currentOrg.id!}'; + 'https:cyberwake.github.io/applink/invite?selectLang=$\{_appLanguageService.appLocal.languageCode\}&setUrl=$\{GraphqlConfig.orgURI\}&selectOrg=$\{userConfig.currentOrg.id!\}'; final String qrData = - '${GraphqlConfig.orgURI}?orgid=${userConfig.currentOrg.id!}'; + '$\{GraphqlConfig.orgURI\}?orgid=$\{userConfig.currentOrg.id!\}'; - // print(url); - // print(qrData); + print(url); + print(qrData); return Column( mainAxisSize: MainAxisSize.max, mainAxisAlignment: MainAxisAlignment.center, crossAxisAlignment: CrossAxisAlignment.center, children: [ - //Scan the below given QR code to join the organization. + Scan the below given QR code to join the organization. QrImage( key: const Key("QRcode"), data: qrData, @@ -55,13 +55,13 @@ Widget invite(BuildContext context) { height: SizeConfig.screenHeight! * 0.08, ), Text( - 'Scan the QR to join ${userConfig.currentOrg.name}', + 'Scan the QR to join $\{userConfig.currentOrg.name\}', style: const TextStyle(color: Colors.black), ), SizedBox( height: SizeConfig.screenHeight! * 0.02, ), - //Tap on the Twitter icon to join the organization through Twitter. + Tap on the Twitter icon to join the organization through Twitter. Row( mainAxisAlignment: MainAxisAlignment.spaceEvenly, mainAxisSize: MainAxisSize.min, @@ -73,19 +73,19 @@ Widget invite(BuildContext context) { size: 35, color: Color(0xFF1DA1F2), ), - () async => SocialShare.shareTwitter('Join us', url: url), + () async =\> SocialShare.shareTwitter('Join us', url: url), ), - //Tap on the Whatsapp icon to join the organization through Whatsapp. + Tap on the Whatsapp icon to join the organization through Whatsapp. iconButton( "WhatsApp", CustomPaint( size: const Size( 50, 50 * 1.004, - ), //You can Replace [WIDTH] with your desired width for Custom Paint and height will be calculated automatically + ), You can Replace [WIDTH] with your desired width for Custom Paint and height will be calculated automatically painter: WhatsappLogo(), ), - () async => SocialShare.shareWhatsapp(url), + () async =\> SocialShare.shareWhatsapp(url), ), iconButton( "Telegram", @@ -93,10 +93,10 @@ Widget invite(BuildContext context) { size: Size( 45, (45 * 1).toDouble(), - ), //You can Replace [WIDTH] with your desired width for Custom Paint and height will be calculated automatically + ), You can Replace [WIDTH] with your desired width for Custom Paint and height will be calculated automatically painter: TelegramLogo(), ), - () async => SocialShare.shareTelegram(url), + () async =\> SocialShare.shareTelegram(url), ), iconButton( "Alt", @@ -105,13 +105,13 @@ Widget invite(BuildContext context) { size: 30, color: Color(0xff40c351), ), - () async => SocialShare.shareOptions(url), + () async =\> SocialShare.shareOptions(url), ), ], ) ], ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_invite_child/widgets_invite_child-library.md b/docs/talawa-mobile-docs/widgets_invite_child/widgets_invite_child-library.md index dfc730d90ab..eb4dc967cf6 100644 --- a/docs/talawa-mobile-docs/widgets_invite_child/widgets_invite_child-library.md +++ b/docs/talawa-mobile-docs/widgets_invite_child/widgets_invite_child-library.md @@ -21,7 +21,7 @@ ## Functions -##### [iconButton](../widgets_invite_child/iconButton.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) key, [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) icon, [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) onTap) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [iconButton](../widgets_invite_child/iconButton.md)([String](https:api.flutter.dev/flutter/dart-core/String-class.html) key, [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) icon, [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) onTap) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) @@ -31,7 +31,7 @@ It prints "tapped" in the console for the developer to know that the button was -##### [invite](../widgets_invite_child/invite.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [invite](../widgets_invite_child/invite.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) diff --git a/docs/talawa-mobile-docs/widgets_lang_switch/LanguageTile-class.md b/docs/talawa-mobile-docs/widgets_lang_switch/LanguageTile-class.md index 43664061189..c763305053b 100644 --- a/docs/talawa-mobile-docs/widgets_lang_switch/LanguageTile-class.md +++ b/docs/talawa-mobile-docs/widgets_lang_switch/LanguageTile-class.md @@ -11,16 +11,16 @@ -

This widget enables language switch for "internationalizing our app".

+\This widget enables language switch for "internationalizing our app".\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - LanguageTile @@ -32,37 +32,37 @@ ## Constructors -[LanguageTile](../widgets_lang_switch/LanguageTile/LanguageTile.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +[LanguageTile](../widgets_lang_switch/LanguageTile/LanguageTile.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -70,95 +70,95 @@ _read-onlyinherited_ ## Methods -##### [build](../widgets_lang_switch/LanguageTile/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../widgets_lang_switch/LanguageTile/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -166,12 +166,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_lang_switch/LanguageTile/LanguageTile.md b/docs/talawa-mobile-docs/widgets_lang_switch/LanguageTile/LanguageTile.md index 34f40dc1f3d..5e4858ce545 100644 --- a/docs/talawa-mobile-docs/widgets_lang_switch/LanguageTile/LanguageTile.md +++ b/docs/talawa-mobile-docs/widgets_lang_switch/LanguageTile/LanguageTile.md @@ -9,7 +9,7 @@ const -LanguageTile({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +LanguageTile(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) @@ -18,7 +18,7 @@ LanguageTile({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? ## Implementation ```dart -const LanguageTile({Key? key}) : super(key: key); +const LanguageTile(\{Key? key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_lang_switch/LanguageTile/build.md b/docs/talawa-mobile-docs/widgets_lang_switch/LanguageTile/build.md index 71ec7fde9af..f44bdc7fbcb 100644 --- a/docs/talawa-mobile-docs/widgets_lang_switch/LanguageTile/build.md +++ b/docs/talawa-mobile-docs/widgets_lang_switch/LanguageTile/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,15 +58,15 @@ and ```dart @override -Widget build(BuildContext context) { - //AppLanguage enables to set up localized values for each locale that our app supports. - //A locale is an identifier used to select a user's language and formatting preferences. - //This represents a Unicode Language Identifier (i.e. without Locale extensions), - //except variants are not supported. - return Consumer( - builder: (context, appLang, _) { +Widget build(BuildContext context) \{ + AppLanguage enables to set up localized values for each locale that our app supports. + A locale is an identifier used to select a user's language and formatting preferences. + This represents a Unicode Language Identifier (i.e. without Locale extensions), + except variants are not supported. + return Consumer\( + builder: (context, appLang, _) \{ final Language userLanguage = languages.firstWhere( - (element) => element.langCode == appLang.appLocal.languageCode, + (element) =\> element.langCode == appLang.appLocal.languageCode, ); return ListTile( key: const Key('LanguageTile'), @@ -75,18 +75,18 @@ Widget build(BuildContext context) { Text(AppLocalizations.of(context)!.strictTranslate("Language")), trailing: TextButton( key: const Key('LanguageSelector'), - onPressed: () { + onPressed: () \{ navigationService.pushReplacementScreen( '/selectLang', arguments: '0', ); - }, + \}, child: Text(userLanguage.langName), ), ); - }, + \}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile-class.md b/docs/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile-class.md index 10202832bad..6953025c0bb 100644 --- a/docs/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile-class.md +++ b/docs/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile-class.md @@ -11,19 +11,19 @@ -

This widget returns a tile containing the name of the member. +\This widget returns a tile containing the name of the member. Along with the name, there is a circle avatar which either contains the image uploaded by the user or the first character of his/her name in -uppercase.

+uppercase.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - MemberNameTile @@ -35,64 +35,64 @@ uppercase.

## Constructors -[MemberNameTile](../widgets_member_name_tile/MemberNameTile/MemberNameTile.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) userName, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? userImage, required [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) onDelete}) +[MemberNameTile](../widgets_member_name_tile/MemberNameTile/MemberNameTile.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) userName, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? userImage, required [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) onDelete\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [onDelete](../widgets_member_name_tile/MemberNameTile/onDelete.md) → [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) +##### [onDelete](../widgets_member_name_tile/MemberNameTile/onDelete.md) → [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [userImage](../widgets_member_name_tile/MemberNameTile/userImage.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? +##### [userImage](../widgets_member_name_tile/MemberNameTile/userImage.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? -_final_ +_\final\_ -##### [userName](../widgets_member_name_tile/MemberNameTile/userName.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [userName](../widgets_member_name_tile/MemberNameTile/userName.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_final_ +_\final\_ @@ -100,95 +100,95 @@ _final_ ## Methods -##### [build](../widgets_member_name_tile/MemberNameTile/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../widgets_member_name_tile/MemberNameTile/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -196,12 +196,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/MemberNameTile.md b/docs/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/MemberNameTile.md index a2ae5471c94..f1a0c55ddfd 100644 --- a/docs/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/MemberNameTile.md +++ b/docs/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/MemberNameTile.md @@ -9,7 +9,7 @@ const -MemberNameTile({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) userName, [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? userImage, required [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) onDelete}) +MemberNameTile(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) userName, [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? userImage, required [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) onDelete\}) @@ -18,12 +18,12 @@ MemberNameTile({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html) ## Implementation ```dart -const MemberNameTile({ +const MemberNameTile(\{ Key? key, required this.userName, this.userImage, required this.onDelete, -}) : super(key: key); +\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/build.md b/docs/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/build.md index 2a1b65b4328..62eb88e0ac2 100644 --- a/docs/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/build.md +++ b/docs/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,7 +58,7 @@ and ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ return Padding( padding: const EdgeInsets.only(top: 10, right: 5), child: Container( @@ -72,14 +72,14 @@ Widget build(BuildContext context) { mainAxisAlignment: MainAxisAlignment.spaceBetween, crossAxisAlignment: CrossAxisAlignment.center, children: [ - // Background is set with the image uploaded by the user. + Background is set with the image uploaded by the user. userImage != null ? CircleAvatar( radius: SizeConfig.screenHeight! * 0.0201, backgroundImage: NetworkImage(userImage!), ) - // If the user has not uploaded his/her image, then a circle avatar is created. - // It has the first character of the user's name in uppercase and the default background color. + If the user has not uploaded his/her image, then a circle avatar is created. + It has the first character of the user's name in uppercase and the default background color. : CircleAvatar( radius: SizeConfig.screenHeight! * 0.0201, backgroundColor: Theme.of(context).colorScheme.secondary, @@ -88,7 +88,7 @@ Widget build(BuildContext context) { style: const TextStyle(color: Colors.white), ), ), - // The name of the member in text form. + The name of the member in text form. Padding( padding: const EdgeInsets.only(left: 5), child: Text( @@ -97,7 +97,7 @@ Widget build(BuildContext context) { ), IconButton( padding: EdgeInsets.zero, - onPressed: () => onDelete(), + onPressed: () =\> onDelete(), icon: const Icon( Icons.cancel_rounded, color: Color(0xff524F4F), @@ -108,7 +108,7 @@ Widget build(BuildContext context) { ), ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/onDelete.md b/docs/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/onDelete.md index 043ff31feb5..1f422ef9314 100644 --- a/docs/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/onDelete.md +++ b/docs/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/onDelete.md @@ -9,9 +9,9 @@ -[Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) onDelete +[Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) onDelete -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/userImage.md b/docs/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/userImage.md index a26568fc330..bc16abf0af8 100644 --- a/docs/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/userImage.md +++ b/docs/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/userImage.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? userImage +[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? userImage -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/userName.md b/docs/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/userName.md index 196794fd637..39f90646723 100644 --- a/docs/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/userName.md +++ b/docs/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/userName.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) userName +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) userName -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_organization_list/OrganizationList-class.md b/docs/talawa-mobile-docs/widgets_organization_list/OrganizationList-class.md index 11404fa293d..af26426c4b1 100644 --- a/docs/talawa-mobile-docs/widgets_organization_list/OrganizationList-class.md +++ b/docs/talawa-mobile-docs/widgets_organization_list/OrganizationList-class.md @@ -11,18 +11,18 @@ -

This class returns the OrganizationList widget.

-

which shows the list of all organizations exists in the URL. -This widget is used after the authentication.

+\This class returns the OrganizationList widget.\ +\which shows the list of all organizations exists in the URL. +This widget is used after the authentication.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - OrganizationList @@ -34,28 +34,28 @@ This widget is used after the authentication.

## Constructors -[OrganizationList](../widgets_organization_list/OrganizationList/OrganizationList.md) ({required [SelectOrganizationViewModel](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md) model, [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +[OrganizationList](../widgets_organization_list/OrganizationList/OrganizationList.md) (\{required [SelectOrganizationViewModel](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md) model, [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ @@ -63,17 +63,17 @@ _finalinherited_ -
model is a type of SelectOrganizationViewModel which provides methods to handle the data for this component. -_final_ +\model\ is a type of \SelectOrganizationViewModel\ which provides methods to handle the data for this component. +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -81,95 +81,95 @@ _read-onlyinherited_ ## Methods -##### [build](../widgets_organization_list/OrganizationList/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../widgets_organization_list/OrganizationList/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -177,12 +177,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_organization_list/OrganizationList/OrganizationList.md b/docs/talawa-mobile-docs/widgets_organization_list/OrganizationList/OrganizationList.md index d697ef28452..4b4683838a9 100644 --- a/docs/talawa-mobile-docs/widgets_organization_list/OrganizationList/OrganizationList.md +++ b/docs/talawa-mobile-docs/widgets_organization_list/OrganizationList/OrganizationList.md @@ -9,7 +9,7 @@ const -OrganizationList({required [SelectOrganizationViewModel](../../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md) model, [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +OrganizationList(\{required [SelectOrganizationViewModel](../../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md) model, [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) @@ -18,7 +18,7 @@ OrganizationList({required [SelectOrganizationViewModel](../../view_model_pre_au ## Implementation ```dart -const OrganizationList({required this.model, Key? key}) : super(key: key); +const OrganizationList(\{required this.model, Key? key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_organization_list/OrganizationList/build.md b/docs/talawa-mobile-docs/widgets_organization_list/OrganizationList/build.md index b4c96e96324..93b25c26013 100644 --- a/docs/talawa-mobile-docs/widgets_organization_list/OrganizationList/build.md +++ b/docs/talawa-mobile-docs/widgets_organization_list/OrganizationList/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,62 +58,62 @@ and ```dart @override -Widget build(BuildContext context) { - final navigationServiceLocal = locator(); +Widget build(BuildContext context) \{ + final navigationServiceLocal = locator\(); model.organizations = []; int noOfRefetch = 0; return GraphQLProvider( - client: ValueNotifier(graphqlConfig.clientToQuery()), + client: ValueNotifier\(graphqlConfig.clientToQuery()), child: Query( options: QueryOptions( document: gql(queries.fetchJoinInOrg), - variables: { - // fetch 15 items only, will fetch more when scrolling index is at the 3rd last item! + variables: \{ + fetch 15 items only, will fetch more when scrolling index is at the 3rd last item! 'first': 15, 'skip': 0, - }, + \}, ), builder: ( - QueryResult result, { - Future Function(FetchMoreOptions)? fetchMore, - Future Function()? refetch, - }) { - // checking for any errors, if true fetch again! - if (result.hasException) { + QueryResult result, \{ + Future\ Function(FetchMoreOptions)? fetchMore, + Future\ Function()? refetch, + \}) \{ + checking for any errors, if true fetch again! + if (result.hasException) \{ final isException = databaseFunctions.encounteredExceptionOrError( result.exception!, showSnackBar: noOfRefetch == 0, ); - if (isException != null) { - if (isException) { + if (isException != null) \{ + if (isException) \{ refetch!(); noOfRefetch++; - } else { + \} else \{ refetch!(); noOfRefetch++; - } - } - } else { - // If the result is still loading! - if (!result.isLoading) { + \} + \} + \} else \{ + If the result is still loading! + if (!result.isLoading) \{ model.organizations = OrgInfo().fromJsonToList( result.data!['organizationsConnection'] as List, ); - } + \} - Timer(const Duration(seconds: TimeOuts.small), () { - if (model.organizations.isEmpty) { + Timer(const Duration(seconds: TimeOuts.small), () \{ + if (model.organizations.isEmpty) \{ navigationServiceLocal.showTalawaErrorDialog( "No organizations found Please contact your admin", MessageType.error, ); - } - }); + \} + \}); return Scrollbar( thumbVisibility: true, interactive: true, controller: model.allOrgController, - // Listview is a scrollable list of widgets arranged linearly. + Listview is a scrollable list of widgets arranged linearly. child: ListView.separated( controller: model.allOrgController, padding: EdgeInsets.zero, @@ -121,10 +121,10 @@ Widget build(BuildContext context) { itemCount: result.isLoading ? model.organizations.length + 1 : model.organizations.length, - itemBuilder: (BuildContext context, int index) { - // If the index is at the end of the list! - if (index == model.organizations.length) { - // return the ListTile showing the loading icon! + itemBuilder: (BuildContext context, int index) \{ + If the index is at the end of the list! + if (index == model.organizations.length) \{ + return the ListTile showing the loading icon! return ListTile( title: Center( child: CupertinoActivityIndicator( @@ -132,49 +132,49 @@ Widget build(BuildContext context) { ), ), ); - } - // If the index is at the 3rd last item in the organization list. - if (index == model.organizations.length - 3) { - // return VisibilityDetector and fetch more items in the list to show up! + \} + If the index is at the 3rd last item in the organization list. + if (index == model.organizations.length - 3) \{ + return VisibilityDetector and fetch more items in the list to show up! return VisibilityDetector( key: const Key('OrgSelItem'), - onVisibilityChanged: (VisibilityInfo info) { - if (info.visibleFraction > 0) { + onVisibilityChanged: (VisibilityInfo info) \{ + if (info.visibleFraction \> 0) \{ model.fetchMoreHelper( fetchMore!, model.organizations, ); - } - }, + \} + \}, child: CustomListTile( index: index, type: TileType.org, orgInfo: model.organizations[index], - onTapOrgInfo: (item) => model.selectOrg(item), + onTapOrgInfo: (item) =\> model.selectOrg(item), key: Key('OrgSelItem$index'), ), ); - } - // return CustomeTile that shows a particular item in the list! + \} + return CustomeTile that shows a particular item in the list! return CustomListTile( index: index, type: TileType.org, orgInfo: model.organizations[index], - onTapOrgInfo: (item) => model.selectOrg(item), + onTapOrgInfo: (item) =\> model.selectOrg(item), key: Key('OrgSelItem$index'), ); - }, - separatorBuilder: (BuildContext context, int index) { + \}, + separatorBuilder: (BuildContext context, int index) \{ return Container(); - }, + \}, ), ); - } + \} return Container(); - }, + \}, ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_organization_list/OrganizationList/model.md b/docs/talawa-mobile-docs/widgets_organization_list/OrganizationList/model.md index d08ac7e6960..e7fa7e1333d 100644 --- a/docs/talawa-mobile-docs/widgets_organization_list/OrganizationList/model.md +++ b/docs/talawa-mobile-docs/widgets_organization_list/OrganizationList/model.md @@ -11,11 +11,11 @@ [SelectOrganizationViewModel](../../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md) model -_final_ +_\final\_ -

model is a type of SelectOrganizationViewModel which provides methods to handle the data for this component.

+\\model\ is a type of \SelectOrganizationViewModel\ which provides methods to handle the data for this component.\ diff --git a/docs/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList-class.md b/docs/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList-class.md index c7def0d5c55..3b4dae8804f 100644 --- a/docs/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList-class.md +++ b/docs/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList-class.md @@ -11,17 +11,17 @@ -

OrganizationSearchList class return a widget that shows all -the matching organizations searched on the search bar.

+\OrganizationSearchList class return a widget that shows all +the matching organizations searched on the search bar.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - OrganizationSearchList @@ -33,28 +33,28 @@ the matching organizations searched on the search bar.

## Constructors -[OrganizationSearchList](../widgets_organization_search_list/OrganizationSearchList/OrganizationSearchList.md) ({required [SelectOrganizationViewModel](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md) model, [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +[OrganizationSearchList](../widgets_organization_search_list/OrganizationSearchList/OrganizationSearchList.md) (\{required [SelectOrganizationViewModel](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md) model, [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ @@ -63,16 +63,16 @@ _finalinherited_ -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -80,95 +80,95 @@ _read-onlyinherited_ ## Methods -##### [build](../widgets_organization_search_list/OrganizationSearchList/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../widgets_organization_search_list/OrganizationSearchList/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -176,12 +176,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList/OrganizationSearchList.md b/docs/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList/OrganizationSearchList.md index 96e9f385d63..cce0afc9bac 100644 --- a/docs/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList/OrganizationSearchList.md +++ b/docs/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList/OrganizationSearchList.md @@ -9,7 +9,7 @@ const -OrganizationSearchList({required [SelectOrganizationViewModel](../../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md) model, [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +OrganizationSearchList(\{required [SelectOrganizationViewModel](../../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md) model, [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) @@ -18,7 +18,7 @@ OrganizationSearchList({required [SelectOrganizationViewModel](../../view_model_ ## Implementation ```dart -const OrganizationSearchList({required this.model, Key? key}) +const OrganizationSearchList(\{required this.model, Key? key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList/build.md b/docs/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList/build.md index 9ce4605352a..d3ee1967c50 100644 --- a/docs/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList/build.md +++ b/docs/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,48 +58,48 @@ and ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ return GraphQLProvider( - client: ValueNotifier(graphqlConfig.authClient()), + client: ValueNotifier\(graphqlConfig.authClient()), child: Query( options: QueryOptions( document: gql(Queries().fetchJoinInOrgByName), - variables: { + variables: \{ 'nameStartsWith': model.searchController.text, - // fetch 30 items only, will fetch more when scrolling index is at the 3rd last item! + fetch 30 items only, will fetch more when scrolling index is at the 3rd last item! 'first': 30, 'skip': 0, - }, + \}, ), builder: ( - QueryResult result, { - Future Function(FetchMoreOptions)? fetchMore, - Future Function()? refetch, - }) { - // checking for any errors, if true fetch again! - if (result.hasException) { + QueryResult result, \{ + Future\ Function(FetchMoreOptions)? fetchMore, + Future\ Function()? refetch, + \}) \{ + checking for any errors, if true fetch again! + if (result.hasException) \{ final isException = databaseFunctions.encounteredExceptionOrError( result.exception!, showSnackBar: false, ); - if (isException!) { + if (isException!) \{ refetch!(); - } else { + \} else \{ refetch!(); - } - } else { - // If the result is still loading! - if (!result.isLoading) { + \} + \} else \{ + If the result is still loading! + if (!result.isLoading) \{ model.organizations = OrgInfo().fromJsonToList( result.data!['organizationsConnection'] as List, ); - } - // return the Scroll bar widget for scrolling down the organizations. + \} + return the Scroll bar widget for scrolling down the organizations. return Scrollbar( thumbVisibility: true, interactive: true, controller: model.controller, - // Listview is a scrollable list of widgets arranged linearly. + Listview is a scrollable list of widgets arranged linearly. child: ListView.separated( controller: model.controller, padding: EdgeInsets.zero, @@ -107,10 +107,10 @@ Widget build(BuildContext context) { itemCount: result.isLoading ? model.organizations.length + 1 : model.organizations.length, - itemBuilder: (BuildContext context, int index) { - // If the index is at the end of the list! - if (index == model.organizations.length) { - // return the ListTile showing the loading icon! + itemBuilder: (BuildContext context, int index) \{ + If the index is at the end of the list! + if (index == model.organizations.length) \{ + return the ListTile showing the loading icon! return ListTile( title: Center( child: CupertinoActivityIndicator( @@ -118,41 +118,41 @@ Widget build(BuildContext context) { ), ), ); - } - // If the index is at the 3rd last item in the organization list. - if (index == model.organizations.length - 3) { - // return VisibilityDetector and fetch more items in the list to show up! + \} + If the index is at the 3rd last item in the organization list. + if (index == model.organizations.length - 3) \{ + return VisibilityDetector and fetch more items in the list to show up! return VisibilityDetector( key: const Key('OrgSelItem'), - onVisibilityChanged: (VisibilityInfo info) { - if (info.visibleFraction > 0) { + onVisibilityChanged: (VisibilityInfo info) \{ + if (info.visibleFraction \> 0) \{ print(model.organizations.length); model.fetchMoreHelper( fetchMore!, model.organizations, ); print(model.organizations.length); - } - }, + \} + \}, child: CustomListTile( index: index, type: TileType.org, orgInfo: model.organizations[index], - onTapOrgInfo: (item) => model.selectOrg(item), + onTapOrgInfo: (item) =\> model.selectOrg(item), key: Key('OrgSelItem$index'), ), ); - } - // return CustomeTile that shows a particular item in the list! + \} + return CustomeTile that shows a particular item in the list! return CustomListTile( index: index, type: TileType.org, orgInfo: model.organizations[index], - onTapOrgInfo: (item) => model.selectOrg(item), + onTapOrgInfo: (item) =\> model.selectOrg(item), key: Key('OrgSelItem$index'), ); - }, - separatorBuilder: (BuildContext context, int index) { + \}, + separatorBuilder: (BuildContext context, int index) \{ return Padding( padding: EdgeInsets.only( left: SizeConfig.screenWidth! * 0.2, @@ -163,15 +163,15 @@ Widget build(BuildContext context) { thickness: 0.5, ), ); - }, + \}, ), ); - } + \} return Container(); - }, + \}, ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList/model.md b/docs/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList/model.md index 5906910b451..1314a2f903f 100644 --- a/docs/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList/model.md +++ b/docs/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList/model.md @@ -11,7 +11,7 @@ [SelectOrganizationViewModel](../../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md) model -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller-class.md b/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller-class.md index cf25bd38166..d51338e8a4a 100644 --- a/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller-class.md +++ b/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller-class.md @@ -16,10 +16,10 @@ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html) - CustomCarouselScroller @@ -29,60 +29,60 @@ **Annotations** -- @[visibleForTesting](https://pub.dev/documentation/meta/1.8.0/meta/visibleForTesting-constant.html) +- @[visibleForTesting](https:pub.dev/documentation/meta/1.8.0/meta/visibleForTesting-constant.html) ## Constructors -[CustomCarouselScroller](../widgets_pinned_carousel_widget/CustomCarouselScroller/CustomCarouselScroller.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../models_post_post_model/Post-class.md)> pinnedPosts, required [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) navigateToIndividualPostPage}) +[CustomCarouselScroller](../widgets_pinned_carousel_widget/CustomCarouselScroller/CustomCarouselScroller.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../models_post_post_model/Post-class.md)\> pinnedPosts, required [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) navigateToIndividualPostPage\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [navigateToIndividualPostPage](../widgets_pinned_carousel_widget/CustomCarouselScroller/navigateToIndividualPostPage.md) → [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) +##### [navigateToIndividualPostPage](../widgets_pinned_carousel_widget/CustomCarouselScroller/navigateToIndividualPostPage.md) → [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) -_final_ +_\final\_ -##### [pinnedPosts](../widgets_pinned_carousel_widget/CustomCarouselScroller/pinnedPosts.md) → [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../models_post_post_model/Post-class.md)> +##### [pinnedPosts](../widgets_pinned_carousel_widget/CustomCarouselScroller/pinnedPosts.md) → [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../models_post_post_model/Post-class.md)\> -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -90,12 +90,12 @@ _read-onlyinherited_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ @@ -104,81 +104,81 @@ _inherited_ Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -186,12 +186,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller/CustomCarouselScroller.md b/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller/CustomCarouselScroller.md index 5cb9c6ebd63..bd8cb85cac9 100644 --- a/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller/CustomCarouselScroller.md +++ b/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller/CustomCarouselScroller.md @@ -9,7 +9,7 @@ const -CustomCarouselScroller({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)> pinnedPosts, required [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) navigateToIndividualPostPage}) +CustomCarouselScroller(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)\> pinnedPosts, required [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) navigateToIndividualPostPage\}) @@ -18,11 +18,11 @@ CustomCarouselScroller({[Key](https://api.flutter.dev/flutter/foundation/Key-cla ## Implementation ```dart -const CustomCarouselScroller({ +const CustomCarouselScroller(\{ Key? key, required this.pinnedPosts, required this.navigateToIndividualPostPage, -}) : super(key: key); +\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller/createState.md b/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller/createState.md index 581e73be453..4d931e39f78 100644 --- a/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller/createState.md +++ b/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) [CustomCarouselScrollerState](../../widgets_pinned_carousel_widget/CustomCarouselScrollerState-class.md) createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller/pinnedPosts.md b/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller/pinnedPosts.md index 4071846ea2c..c30dd276075 100644 --- a/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller/pinnedPosts.md +++ b/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller/pinnedPosts.md @@ -9,9 +9,9 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)> pinnedPosts +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)\> pinnedPosts -_final_ +_\final\_ @@ -21,7 +21,7 @@ _final_ ## Implementation ```dart -final List pinnedPosts; +final List\ pinnedPosts; ``` diff --git a/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState-class.md b/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState-class.md index 3af904b5186..a570139509d 100644 --- a/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState-class.md +++ b/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState-class.md @@ -11,15 +11,15 @@ -

CustomCarouselScrollerState class return a widget that is -used to generate slider for pinned post on the top of the Home Screen.

+\CustomCarouselScrollerState class return a widget that is +used to generate slider for pinned post on the top of the Home Screen.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [State](https://api.flutter.dev/flutter/widgets/State-class.html)<[CustomCarouselScroller](../widgets_pinned_carousel_widget/CustomCarouselScroller-class.md)> +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [State](https:api.flutter.dev/flutter/widgets/State-class.html)<[CustomCarouselScroller](../widgets_pinned_carousel_widget/CustomCarouselScroller-class.md)\> - CustomCarouselScrollerState @@ -27,12 +27,12 @@ used to generate slider for pinned post on the top of the Home Screen.

**Available Extensions** -- [StateExt](https://pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/StateExt.html) +- [StateExt](https:pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/StateExt.html) **Annotations** -- @[visibleForTesting](https://pub.dev/documentation/meta/1.8.0/meta/visibleForTesting-constant.html) +- @[visibleForTesting](https:pub.dev/documentation/meta/1.8.0/meta/visibleForTesting-constant.html) ## Constructors @@ -44,66 +44,66 @@ used to generate slider for pinned post on the top of the Home Screen.

## Properties -##### [context](https://api.flutter.dev/flutter/widgets/State/context.html) → [BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) +##### [context](https:api.flutter.dev/flutter/widgets/State/context.html) → [BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) The location in the tree where this widget builds. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [controller](../widgets_pinned_carousel_widget/CustomCarouselScrollerState/controller.md) → [PageController](https://api.flutter.dev/flutter/widgets/PageController-class.html) +##### [controller](../widgets_pinned_carousel_widget/CustomCarouselScrollerState/controller.md) → [PageController](https:api.flutter.dev/flutter/widgets/PageController-class.html) -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [mounted](https://api.flutter.dev/flutter/widgets/State/mounted.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [mounted](https:api.flutter.dev/flutter/widgets/State/mounted.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -Whether this
State object is currently in a tree. -_read-onlyinherited_ +Whether this \State\ object is currently in a tree. +_\read-only\\inherited\_ -##### [pindex](../widgets_pinned_carousel_widget/CustomCarouselScrollerState/pindex.md) ↔ [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [pindex](../widgets_pinned_carousel_widget/CustomCarouselScrollerState/pindex.md) ↔ [int](https:api.flutter.dev/flutter/dart-core/int-class.html) -_read / write_ +_\read / write\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [widget](https://api.flutter.dev/flutter/widgets/State/widget.html) → [CustomCarouselScroller](../widgets_pinned_carousel_widget/CustomCarouselScroller-class.md) +##### [widget](https:api.flutter.dev/flutter/widgets/State/widget.html) → [CustomCarouselScroller](../widgets_pinned_carousel_widget/CustomCarouselScroller-class.md) The current configuration. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -111,133 +111,133 @@ _read-onlyinherited_ ## Methods -##### [activate](https://api.flutter.dev/flutter/widgets/State/activate.html)() void +##### [activate](https:api.flutter.dev/flutter/widgets/State/activate.html)() void Called when this object is reinserted into the tree after having been -removed via deactivate. -_inherited_ +removed via \deactivate\. +_\inherited\_ -##### [build](../widgets_pinned_carousel_widget/CustomCarouselScrollerState/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../widgets_pinned_carousel_widget/CustomCarouselScrollerState/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [deactivate](https://api.flutter.dev/flutter/widgets/State/deactivate.html)() void +##### [deactivate](https:api.flutter.dev/flutter/widgets/State/deactivate.html)() void Called when this object is removed from the tree. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/State/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/State/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [didChangeDependencies](https://api.flutter.dev/flutter/widgets/State/didChangeDependencies.html)() void +##### [didChangeDependencies](https:api.flutter.dev/flutter/widgets/State/didChangeDependencies.html)() void -Called when a dependency of this State object changes. -_inherited_ +Called when a dependency of this \State\ object changes. +_\inherited\_ -##### [didUpdateWidget](https://api.flutter.dev/flutter/widgets/State/didUpdateWidget.html)(covariant [CustomCarouselScroller](../widgets_pinned_carousel_widget/CustomCarouselScroller-class.md) oldWidget) void +##### [didUpdateWidget](https:api.flutter.dev/flutter/widgets/State/didUpdateWidget.html)(covariant [CustomCarouselScroller](../widgets_pinned_carousel_widget/CustomCarouselScroller-class.md) oldWidget) void Called whenever the widget configuration changes. -_inherited_ +_\inherited\_ -##### [dispose](https://api.flutter.dev/flutter/widgets/State/dispose.html)() void +##### [dispose](https:api.flutter.dev/flutter/widgets/State/dispose.html)() void Called when this object is removed from the tree permanently. -_inherited_ +_\inherited\_ -##### [initState](https://api.flutter.dev/flutter/widgets/State/initState.html)() void +##### [initState](https:api.flutter.dev/flutter/widgets/State/initState.html)() void Called when this object is inserted into the tree. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [reassemble](https://api.flutter.dev/flutter/widgets/State/reassemble.html)() void +##### [reassemble](https:api.flutter.dev/flutter/widgets/State/reassemble.html)() void Called whenever the application is reassembled during debugging, for example during hot reload. -_inherited_ +_\inherited\_ -##### [setState](https://api.flutter.dev/flutter/widgets/State/setState.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) fn) void +##### [setState](https:api.flutter.dev/flutter/widgets/State/setState.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) fn) void Notify the framework that the internal state of this object has changed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/Diagnosticable/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/Diagnosticable/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/foundation/Diagnosticable/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/foundation/Diagnosticable/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -A brief description of this object, usually just the runtimeType and the -hashCode. -_inherited_ +A brief description of this object, usually just the \runtimeType\ and the +\hashCode\. +_\inherited\_ @@ -245,12 +245,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState/controller.md b/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState/controller.md index 1ba09ce41a1..4615db63c8c 100644 --- a/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState/controller.md +++ b/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState/controller.md @@ -9,9 +9,9 @@ -[PageController](https://api.flutter.dev/flutter/widgets/PageController-class.html) controller +[PageController](https:api.flutter.dev/flutter/widgets/PageController-class.html) controller -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState/pindex.md b/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState/pindex.md index e609f0c2820..cb90088971e 100644 --- a/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState/pindex.md +++ b/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState/pindex.md @@ -9,9 +9,9 @@ -[int](https://api.flutter.dev/flutter/dart-core/int-class.html) pindex +[int](https:api.flutter.dev/flutter/dart-core/int-class.html) pindex -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel-class.md b/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel-class.md index fc37c189159..c88d1b8d3e6 100644 --- a/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel-class.md +++ b/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel-class.md @@ -11,18 +11,18 @@ -

PinnedPostCarousel class returns a widget for pinned posts in +\PinnedPostCarousel class returns a widget for pinned posts in the slider/carousel on the top of the Home Screen. -Tapping on a post will redirect you to the respective post screen.

+Tapping on a post will redirect you to the respective post screen.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - PinnedPostCarousel @@ -34,64 +34,64 @@ Tapping on a post will redirect you to the respective post screen.

## Constructors -[PinnedPostCarousel](../widgets_pinned_carousel_widget/PinnedPostCarousel/PinnedPostCarousel.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../models_post_post_model/Post-class.md)> pinnedPosts, required [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) navigateToPinnedPostPage, required [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) navigateToIndividualPostPage}) +[PinnedPostCarousel](../widgets_pinned_carousel_widget/PinnedPostCarousel/PinnedPostCarousel.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../models_post_post_model/Post-class.md)\> pinnedPosts, required [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) navigateToPinnedPostPage, required [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) navigateToIndividualPostPage\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [navigateToIndividualPostPage](../widgets_pinned_carousel_widget/PinnedPostCarousel/navigateToIndividualPostPage.md) → [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) +##### [navigateToIndividualPostPage](../widgets_pinned_carousel_widget/PinnedPostCarousel/navigateToIndividualPostPage.md) → [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) -_final_ +_\final\_ -##### [navigateToPinnedPostPage](../widgets_pinned_carousel_widget/PinnedPostCarousel/navigateToPinnedPostPage.md) → [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) +##### [navigateToPinnedPostPage](../widgets_pinned_carousel_widget/PinnedPostCarousel/navigateToPinnedPostPage.md) → [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) -_final_ +_\final\_ -##### [pinnedPosts](../widgets_pinned_carousel_widget/PinnedPostCarousel/pinnedPosts.md) → [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../models_post_post_model/Post-class.md)> +##### [pinnedPosts](../widgets_pinned_carousel_widget/PinnedPostCarousel/pinnedPosts.md) → [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../models_post_post_model/Post-class.md)\> -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -99,95 +99,95 @@ _read-onlyinherited_ ## Methods -##### [build](../widgets_pinned_carousel_widget/PinnedPostCarousel/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../widgets_pinned_carousel_widget/PinnedPostCarousel/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -195,12 +195,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/PinnedPostCarousel.md b/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/PinnedPostCarousel.md index f2cc5392f20..c2df8eb3bc8 100644 --- a/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/PinnedPostCarousel.md +++ b/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/PinnedPostCarousel.md @@ -9,7 +9,7 @@ const -PinnedPostCarousel({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)> pinnedPosts, required [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) navigateToPinnedPostPage, required [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) navigateToIndividualPostPage}) +PinnedPostCarousel(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)\> pinnedPosts, required [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) navigateToPinnedPostPage, required [Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) navigateToIndividualPostPage\}) @@ -18,12 +18,12 @@ PinnedPostCarousel({[Key](https://api.flutter.dev/flutter/foundation/Key-class.h ## Implementation ```dart -const PinnedPostCarousel({ +const PinnedPostCarousel(\{ Key? key, required this.pinnedPosts, required this.navigateToPinnedPostPage, required this.navigateToIndividualPostPage, -}) : super(key: key); +\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/build.md b/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/build.md index 8010d7a7389..d355cb9d28c 100644 --- a/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/build.md +++ b/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,7 +58,7 @@ and ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ return Column( children: [ Container( @@ -71,11 +71,11 @@ Widget build(BuildContext context) { navigateToIndividualPostPage: navigateToIndividualPostPage, ), ), - // Gesture Detector in Flutter is used to detect the user's gestures on the application. - // It is a non-visual widget. Inside the gesture detector, another widget is placed and - // the gesture detector will capture all these events (gestures) and execute the tasks accordingly. + Gesture Detector in Flutter is used to detect the user's gestures on the application. + It is a non-visual widget. Inside the gesture detector, another widget is placed and + the gesture detector will capture all these events (gestures) and execute the tasks accordingly. GestureDetector( - onTap: () => navigateToPinnedPostPage(), + onTap: () =\> navigateToPinnedPostPage(), child: Container( height: 50, width: SizeConfig.screenWidth, @@ -108,7 +108,7 @@ Widget build(BuildContext context) { ) ], ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/navigateToIndividualPostPage.md b/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/navigateToIndividualPostPage.md index 362a98fd379..1386881614c 100644 --- a/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/navigateToIndividualPostPage.md +++ b/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/navigateToIndividualPostPage.md @@ -9,9 +9,9 @@ -[Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) navigateToIndividualPostPage +[Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) navigateToIndividualPostPage -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/navigateToPinnedPostPage.md b/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/navigateToPinnedPostPage.md index 9fbe8e2758c..26d293fb379 100644 --- a/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/navigateToPinnedPostPage.md +++ b/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/navigateToPinnedPostPage.md @@ -9,9 +9,9 @@ -[Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) navigateToPinnedPostPage +[Function](https:api.flutter.dev/flutter/dart-core/Function-class.html) navigateToPinnedPostPage -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/pinnedPosts.md b/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/pinnedPosts.md index 4071846ea2c..c30dd276075 100644 --- a/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/pinnedPosts.md +++ b/docs/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/pinnedPosts.md @@ -9,9 +9,9 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)> pinnedPosts +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)\> pinnedPosts -_final_ +_\final\_ @@ -21,7 +21,7 @@ _final_ ## Implementation ```dart -final List pinnedPosts; +final List\ pinnedPosts; ``` diff --git a/docs/talawa-mobile-docs/widgets_post_detailed_page/DescriptionTextWidget-class.md b/docs/talawa-mobile-docs/widgets_post_detailed_page/DescriptionTextWidget-class.md index 270bf50da58..80503e7bf54 100644 --- a/docs/talawa-mobile-docs/widgets_post_detailed_page/DescriptionTextWidget-class.md +++ b/docs/talawa-mobile-docs/widgets_post_detailed_page/DescriptionTextWidget-class.md @@ -11,19 +11,19 @@ -

This class sets up the post page. +\This class sets up the post page. To implement the "show less" and "show more" functions for the text, we divide the text into two parts: firstHalf and secondHalf. A flag is set to -track whether to display either the firstHalf or both(the entire text).

+track whether to display either the firstHalf or both(the entire text).\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html) - DescriptionTextWidget @@ -35,46 +35,46 @@ track whether to display either the firstHalf or both(the entire text).

## Constructors -[DescriptionTextWidget](../widgets_post_detailed_page/DescriptionTextWidget/DescriptionTextWidget.md) ({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) text}) +[DescriptionTextWidget](../widgets_post_detailed_page/DescriptionTextWidget/DescriptionTextWidget.md) (\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) text\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [text](../widgets_post_detailed_page/DescriptionTextWidget/text.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [text](../widgets_post_detailed_page/DescriptionTextWidget/text.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_final_ +_\final\_ @@ -82,12 +82,12 @@ _final_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a
StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ @@ -96,81 +96,81 @@ _inherited_ Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -178,12 +178,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_post_detailed_page/DescriptionTextWidget/DescriptionTextWidget.md b/docs/talawa-mobile-docs/widgets_post_detailed_page/DescriptionTextWidget/DescriptionTextWidget.md index 9e9f4749e7f..4fdd398753f 100644 --- a/docs/talawa-mobile-docs/widgets_post_detailed_page/DescriptionTextWidget/DescriptionTextWidget.md +++ b/docs/talawa-mobile-docs/widgets_post_detailed_page/DescriptionTextWidget/DescriptionTextWidget.md @@ -9,7 +9,7 @@ const -DescriptionTextWidget({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) text}) +DescriptionTextWidget(\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) text\}) @@ -18,7 +18,7 @@ DescriptionTextWidget({required [String](https://api.flutter.dev/flutter/dart-co ## Implementation ```dart -const DescriptionTextWidget({required this.text}); +const DescriptionTextWidget(\{required this.text\}); ``` diff --git a/docs/talawa-mobile-docs/widgets_post_detailed_page/DescriptionTextWidget/createState.md b/docs/talawa-mobile-docs/widgets_post_detailed_page/DescriptionTextWidget/createState.md index 334915de6fa..10f5810b2ed 100644 --- a/docs/talawa-mobile-docs/widgets_post_detailed_page/DescriptionTextWidget/createState.md +++ b/docs/talawa-mobile-docs/widgets_post_detailed_page/DescriptionTextWidget/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) _DescriptionTextWidgetState createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_post_list_widget/PostListWidget-class.md b/docs/talawa-mobile-docs/widgets_post_list_widget/PostListWidget-class.md index 45a69dc1ca4..8497eb4da2b 100644 --- a/docs/talawa-mobile-docs/widgets_post_list_widget/PostListWidget-class.md +++ b/docs/talawa-mobile-docs/widgets_post_list_widget/PostListWidget-class.md @@ -11,16 +11,16 @@ -

This class receives a List of all the Post widgets and returns a ListView.

+\This class receives a List of all the Post widgets and returns a ListView.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - PostListWidget @@ -32,7 +32,7 @@ ## Constructors -[PostListWidget](../widgets_post_list_widget/PostListWidget/PostListWidget.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../models_post_post_model/Post-class.md)> posts, dynamic function([Post](../models_post_post_model/Post-class.md))?}) +[PostListWidget](../widgets_post_list_widget/PostListWidget/PostListWidget.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../models_post_post_model/Post-class.md)\> posts, dynamic function([Post](../models_post_post_model/Post-class.md))?\}) _const_ @@ -44,43 +44,43 @@ -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [posts](../widgets_post_list_widget/PostListWidget/posts.md) → [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../models_post_post_model/Post-class.md)> +##### [posts](../widgets_post_list_widget/PostListWidget/posts.md) → [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../models_post_post_model/Post-class.md)\> -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -88,95 +88,95 @@ _read-onlyinherited_ ## Methods -##### [build](../widgets_post_list_widget/PostListWidget/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../widgets_post_list_widget/PostListWidget/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -184,12 +184,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/PostListWidget.md b/docs/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/PostListWidget.md index de062397731..8352e7c2a2d 100644 --- a/docs/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/PostListWidget.md +++ b/docs/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/PostListWidget.md @@ -9,7 +9,7 @@ const -PostListWidget({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)> posts, dynamic function([Post](../../models_post_post_model/Post-class.md))?}) +PostListWidget(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)\> posts, dynamic function([Post](../../models_post_post_model/Post-class.md))?\}) @@ -18,11 +18,11 @@ PostListWidget({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html) ## Implementation ```dart -const PostListWidget({ +const PostListWidget(\{ Key? key, required this.posts, this.function, -}) : super(key: key); +\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/build.md b/docs/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/build.md index 9bc187f9a32..a42c5c7bd1f 100644 --- a/docs/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/build.md +++ b/docs/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,13 +58,13 @@ and ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ return ListView.builder( scrollDirection: Axis.vertical, physics: const NeverScrollableScrollPhysics(), shrinkWrap: true, itemCount: posts.length, - itemBuilder: (BuildContext context, int index) { + itemBuilder: (BuildContext context, int index) \{ return Column( children: [ NewsPost( @@ -80,9 +80,9 @@ Widget build(BuildContext context) { ) ], ); - }, + \}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/function.md b/docs/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/function.md index 4e87ea5a33f..8c2e859549e 100644 --- a/docs/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/function.md +++ b/docs/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/function.md @@ -11,7 +11,7 @@ (dynamic Function([Post](../../models_post_post_model/Post-class.md))?) function -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/posts.md b/docs/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/posts.md index 9a3b8ad6532..14f475e4c7a 100644 --- a/docs/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/posts.md +++ b/docs/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/posts.md @@ -9,9 +9,9 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)> posts +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)\> posts -_final_ +_\final\_ @@ -21,7 +21,7 @@ _final_ ## Implementation ```dart -final List posts; +final List\ posts; ``` diff --git a/docs/talawa-mobile-docs/widgets_post_widget/NewsPost-class.md b/docs/talawa-mobile-docs/widgets_post_widget/NewsPost-class.md index 181f9935bd8..c33cb46e884 100644 --- a/docs/talawa-mobile-docs/widgets_post_widget/NewsPost-class.md +++ b/docs/talawa-mobile-docs/widgets_post_widget/NewsPost-class.md @@ -16,10 +16,10 @@ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - NewsPost @@ -31,7 +31,7 @@ ## Constructors -[NewsPost](../widgets_post_widget/NewsPost/NewsPost.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Post](../models_post_post_model/Post-class.md) post, dynamic function([Post](../models_post_post_model/Post-class.md))?}) +[NewsPost](../widgets_post_widget/NewsPost/NewsPost.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Post](../models_post_post_model/Post-class.md) post, dynamic function([Post](../models_post_post_model/Post-class.md))?\}) _const_ @@ -43,25 +43,25 @@ -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ @@ -70,16 +70,16 @@ _finalinherited_ -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -87,95 +87,95 @@ _read-onlyinherited_ ## Methods -##### [build](../widgets_post_widget/NewsPost/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../widgets_post_widget/NewsPost/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -183,12 +183,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_post_widget/NewsPost/NewsPost.md b/docs/talawa-mobile-docs/widgets_post_widget/NewsPost/NewsPost.md index 4f831c08be5..5edac697069 100644 --- a/docs/talawa-mobile-docs/widgets_post_widget/NewsPost/NewsPost.md +++ b/docs/talawa-mobile-docs/widgets_post_widget/NewsPost/NewsPost.md @@ -9,7 +9,7 @@ const -NewsPost({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Post](../../models_post_post_model/Post-class.md) post, dynamic function([Post](../../models_post_post_model/Post-class.md))?}) +NewsPost(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Post](../../models_post_post_model/Post-class.md) post, dynamic function([Post](../../models_post_post_model/Post-class.md))?\}) @@ -18,11 +18,11 @@ NewsPost({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, ## Implementation ```dart -const NewsPost({ +const NewsPost(\{ Key? key, required this.post, this.function, -}) : super(key: key); +\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_post_widget/NewsPost/build.md b/docs/talawa-mobile-docs/widgets_post_widget/NewsPost/build.md index 3e6ebf46995..b07c17ce080 100644 --- a/docs/talawa-mobile-docs/widgets_post_widget/NewsPost/build.md +++ b/docs/talawa-mobile-docs/widgets_post_widget/NewsPost/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,11 +58,11 @@ and ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ return Column( crossAxisAlignment: CrossAxisAlignment.start, children: [ - // const PinnedPostCarousel(), + const PinnedPostCarousel(), ListTile( leading: CustomAvatar( isImageNull: post.creator!.image == null, @@ -72,7 +72,7 @@ Widget build(BuildContext context) { fontSize: 24, ), title: Text( - "${post.creator!.firstName} ${post.creator!.lastName}", + "$\{post.creator!.firstName\} $\{post.creator!.lastName\}", style: const TextStyle(fontSize: 20, fontWeight: FontWeight.w400), ), subtitle: Text(post.getPostCreatedDuration()), @@ -84,11 +84,11 @@ Widget build(BuildContext context) { Theme.of(context).colorScheme.primaryContainer.withOpacity(0.5), child: PostContainer(id: post.sId), ), - BaseView( - onModelReady: (model) { + BaseView\( + onModelReady: (model) \{ model.initialize(post.likedBy ?? [], post.sId); - }, - builder: (context, model, child) => Column( + \}, + builder: (context, model, child) =\> Column( children: [ Padding( padding: @@ -97,9 +97,9 @@ Widget build(BuildContext context) { mainAxisAlignment: MainAxisAlignment.spaceBetween, children: [ GestureDetector( - onTap: () => function != null ? function!(post) : {}, + onTap: () =\> function != null ? function!(post) : \{\}, child: Text( - "${model.likedBy.length} ${AppLocalizations.of(context)!.strictTranslate("Likes")}", + "$\{model.likedBy.length\} $\{AppLocalizations.of(context)!.strictTranslate("Likes")\}", style: const TextStyle( fontFamily: 'open-sans', fontWeight: FontWeight.w800, @@ -107,9 +107,9 @@ Widget build(BuildContext context) { ), ), GestureDetector( - onTap: () => function != null ? function!(post) : {}, + onTap: () =\> function != null ? function!(post) : \{\}, child: Text( - "${post.comments!.length} ${AppLocalizations.of(context)!.strictTranslate("comments")}", + "$\{post.comments!.length\} $\{AppLocalizations.of(context)!.strictTranslate("comments")\}", ), ) ], @@ -125,9 +125,9 @@ Widget build(BuildContext context) { child: Row( children: [ GestureDetector( - onTap: () { + onTap: () \{ model.toggleIsLiked(); - }, + \}, child: Icon( Icons.thumb_up, color: model.isLiked @@ -136,7 +136,7 @@ Widget build(BuildContext context) { ), ), GestureDetector( - onTap: () => function != null ? function!(post) : {}, + onTap: () =\> function != null ? function!(post) : \{\}, child: const Padding( padding: EdgeInsets.only(left: 18.0), child: Icon( @@ -153,7 +153,7 @@ Widget build(BuildContext context) { ), ], ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_post_widget/NewsPost/function.md b/docs/talawa-mobile-docs/widgets_post_widget/NewsPost/function.md index 4e87ea5a33f..8c2e859549e 100644 --- a/docs/talawa-mobile-docs/widgets_post_widget/NewsPost/function.md +++ b/docs/talawa-mobile-docs/widgets_post_widget/NewsPost/function.md @@ -11,7 +11,7 @@ (dynamic Function([Post](../../models_post_post_model/Post-class.md))?) function -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_post_widget/NewsPost/post.md b/docs/talawa-mobile-docs/widgets_post_widget/NewsPost/post.md index e986becbc0b..56f2ac89553 100644 --- a/docs/talawa-mobile-docs/widgets_post_widget/NewsPost/post.md +++ b/docs/talawa-mobile-docs/widgets_post_widget/NewsPost/post.md @@ -11,7 +11,7 @@ [Post](../../models_post_post_model/Post-class.md) post -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_post_widget/PostContainer-class.md b/docs/talawa-mobile-docs/widgets_post_widget/PostContainer-class.md index 5ae9ca9e608..90e0d2b1242 100644 --- a/docs/talawa-mobile-docs/widgets_post_widget/PostContainer-class.md +++ b/docs/talawa-mobile-docs/widgets_post_widget/PostContainer-class.md @@ -16,10 +16,10 @@ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html) - PostContainer @@ -31,46 +31,46 @@ ## Constructors -[PostContainer](../widgets_post_widget/PostContainer/PostContainer.md) ({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) id, [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +[PostContainer](../widgets_post_widget/PostContainer/PostContainer.md) (\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) id, [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [id](../widgets_post_widget/PostContainer/id.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [id](../widgets_post_widget/PostContainer/id.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_final_ +_\final\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -78,12 +78,12 @@ _read-onlyinherited_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ @@ -92,81 +92,81 @@ _inherited_ Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -174,12 +174,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_post_widget/PostContainer/PostContainer.md b/docs/talawa-mobile-docs/widgets_post_widget/PostContainer/PostContainer.md index dc9ee62f139..5bd7a72c25b 100644 --- a/docs/talawa-mobile-docs/widgets_post_widget/PostContainer/PostContainer.md +++ b/docs/talawa-mobile-docs/widgets_post_widget/PostContainer/PostContainer.md @@ -9,7 +9,7 @@ const -PostContainer({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) id, [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +PostContainer(\{required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) id, [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) @@ -18,10 +18,10 @@ PostContainer({required [String](https://api.flutter.dev/flutter/dart-core/Strin ## Implementation ```dart -const PostContainer({ +const PostContainer(\{ required this.id, Key? key, -}) : super(key: key); +\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_post_widget/PostContainer/createState.md b/docs/talawa-mobile-docs/widgets_post_widget/PostContainer/createState.md index 85cd7e218dc..0fd13e30fd7 100644 --- a/docs/talawa-mobile-docs/widgets_post_widget/PostContainer/createState.md +++ b/docs/talawa-mobile-docs/widgets_post_widget/PostContainer/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) [PostContainerState](../../widgets_post_widget/PostContainerState-class.md) createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState-class.md b/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState-class.md index e8506d7a1b0..935377f622e 100644 --- a/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState-class.md +++ b/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState-class.md @@ -16,8 +16,8 @@ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [State](https://api.flutter.dev/flutter/widgets/State-class.html)<[PostContainer](../widgets_post_widget/PostContainer-class.md)> +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [State](https:api.flutter.dev/flutter/widgets/State-class.html)<[PostContainer](../widgets_post_widget/PostContainer-class.md)\> - PostContainerState @@ -25,7 +25,7 @@ **Available Extensions** -- [StateExt](https://pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/StateExt.html) +- [StateExt](https:pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/StateExt.html) @@ -39,84 +39,84 @@ ## Properties -##### [context](https://api.flutter.dev/flutter/widgets/State/context.html) → [BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) +##### [context](https:api.flutter.dev/flutter/widgets/State/context.html) → [BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) The location in the tree where this widget builds. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [controller](../widgets_post_widget/PostContainerState/controller.md) → [PageController](https://api.flutter.dev/flutter/widgets/PageController-class.html) +##### [controller](../widgets_post_widget/PostContainerState/controller.md) → [PageController](https:api.flutter.dev/flutter/widgets/PageController-class.html) -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/dart-core/Object/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [inView](../widgets_post_widget/PostContainerState/inView.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [inView](../widgets_post_widget/PostContainerState/inView.md) ↔ [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read / write_ +_\read / write\_ -##### [mounted](https://api.flutter.dev/flutter/widgets/State/mounted.html) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [mounted](https:api.flutter.dev/flutter/widgets/State/mounted.html) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -Whether this State object is currently in a tree. -_read-onlyinherited_ +Whether this \State\ object is currently in a tree. +_\read-only\\inherited\_ -##### [pindex](../widgets_post_widget/PostContainerState/pindex.md) ↔ [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [pindex](../widgets_post_widget/PostContainerState/pindex.md) ↔ [int](https:api.flutter.dev/flutter/dart-core/int-class.html) -_read / write_ +_\read / write\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [startedPlaying](../widgets_post_widget/PostContainerState/startedPlaying.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [startedPlaying](../widgets_post_widget/PostContainerState/startedPlaying.md) ↔ [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_read / write_ +_\read / write\_ -##### [widget](https://api.flutter.dev/flutter/widgets/State/widget.html) → [PostContainer](../widgets_post_widget/PostContainer-class.md) +##### [widget](https:api.flutter.dev/flutter/widgets/State/widget.html) → [PostContainer](../widgets_post_widget/PostContainer-class.md) The current configuration. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -124,58 +124,58 @@ _read-onlyinherited_ ## Methods -##### [activate](https://api.flutter.dev/flutter/widgets/State/activate.html)() void +##### [activate](https:api.flutter.dev/flutter/widgets/State/activate.html)() void Called when this object is reinserted into the tree after having been -removed via deactivate. -_inherited_ +removed via \deactivate\. +_\inherited\_ -##### [build](../widgets_post_widget/PostContainerState/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../widgets_post_widget/PostContainerState/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [deactivate](https://api.flutter.dev/flutter/widgets/State/deactivate.html)() void +##### [deactivate](https:api.flutter.dev/flutter/widgets/State/deactivate.html)() void Called when this object is removed from the tree. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/State/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/State/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [didChangeDependencies](https://api.flutter.dev/flutter/widgets/State/didChangeDependencies.html)() void +##### [didChangeDependencies](https:api.flutter.dev/flutter/widgets/State/didChangeDependencies.html)() void -Called when a dependency of this State object changes. -_inherited_ +Called when a dependency of this \State\ object changes. +_\inherited\_ -##### [didUpdateWidget](https://api.flutter.dev/flutter/widgets/State/didUpdateWidget.html)(covariant [PostContainer](../widgets_post_widget/PostContainer-class.md) oldWidget) void +##### [didUpdateWidget](https:api.flutter.dev/flutter/widgets/State/didUpdateWidget.html)(covariant [PostContainer](../widgets_post_widget/PostContainer-class.md) oldWidget) void Called whenever the widget configuration changes. -_inherited_ +_\inherited\_ @@ -184,7 +184,7 @@ _inherited_ Called when this object is removed from the tree permanently. -_override_ +_\override\_ @@ -193,64 +193,64 @@ _override_ Called when this object is inserted into the tree. -_override_ +_\override\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [reassemble](https://api.flutter.dev/flutter/widgets/State/reassemble.html)() void +##### [reassemble](https:api.flutter.dev/flutter/widgets/State/reassemble.html)() void Called whenever the application is reassembled during debugging, for example during hot reload. -_inherited_ +_\inherited\_ -##### [setState](https://api.flutter.dev/flutter/widgets/State/setState.html)([VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) fn) void +##### [setState](https:api.flutter.dev/flutter/widgets/State/setState.html)([VoidCallback](https:api.flutter.dev/flutter/dart-ui/VoidCallback.html) fn) void Notify the framework that the internal state of this object has changed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/Diagnosticable/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/Diagnosticable/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/foundation/Diagnosticable/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/foundation/Diagnosticable/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -A brief description of this object, usually just the runtimeType and the -hashCode. -_inherited_ +A brief description of this object, usually just the \runtimeType\ and the +\hashCode\. +_\inherited\_ @@ -258,12 +258,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/dart-core/Object/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState/controller.md b/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState/controller.md index 1ba09ce41a1..4615db63c8c 100644 --- a/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState/controller.md +++ b/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState/controller.md @@ -9,9 +9,9 @@ -[PageController](https://api.flutter.dev/flutter/widgets/PageController-class.html) controller +[PageController](https:api.flutter.dev/flutter/widgets/PageController-class.html) controller -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState/dispose.md b/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState/dispose.md index 74c5469f9b5..fbf7fda0cd0 100644 --- a/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState/dispose.md +++ b/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState/dispose.md @@ -9,41 +9,41 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) void dispose () -_override_ +_\override\_ -

Called when this object is removed from the tree permanently.

-

The framework calls this method when this State object will never -build again. After the framework calls dispose, the State object is -considered unmounted and the mounted property is false. It is an error -to call setState at this point. This stage of the lifecycle is terminal: -there is no way to remount a State object that has been disposed.

-

Subclasses should override this method to release any resources retained -by this object (e.g., stop any active animations).

-

If a State's build method depends on an object that can itself -change state, for example a ChangeNotifier or Stream, or some +\Called when this object is removed from the tree permanently.\ +\The framework calls this method when this \State\ object will never +build again. After the framework calls \dispose\, the \State\ object is +considered unmounted and the \mounted\ property is false. It is an error +to call \setState\ at this point. This stage of the lifecycle is terminal: +there is no way to remount a \State\ object that has been disposed.\ +\Subclasses should override this method to release any resources retained +by this object (e.g., stop any active animations).\ +\If a \State\'s \build\ method depends on an object that can itself +change state, for example a \ChangeNotifier\ or \Stream\, or some other object to which one can subscribe to receive notifications, then -be sure to subscribe and unsubscribe properly in initState, -didUpdateWidget, and dispose:

- -

Implementations of this method should end with a call to the inherited -method, as in super.dispose().

-

See also:

- +replacing the object.\ +\In \dispose\, unsubscribe from the object.\ +\ +\Implementations of this method should end with a call to the inherited +method, as in \super.dispose()\.\ +\See also:\ +\ +\\deactivate\, which is called prior to \dispose\.\ +\ @@ -51,10 +51,10 @@ method, as in super.dispose().

```dart @override -void dispose() { +void dispose() \{ controller.dispose(); super.dispose(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState/inView.md b/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState/inView.md index 92c14bb973b..3cda1f7301e 100644 --- a/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState/inView.md +++ b/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState/inView.md @@ -9,9 +9,9 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) inView +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) inView -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState/initState.md b/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState/initState.md index 7e00195161b..6a1cdf966c3 100644 --- a/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState/initState.md +++ b/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState/initState.md @@ -9,39 +9,39 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) void initState () -_override_ +_\override\_ -

Called when this object is inserted into the tree.

-

The framework will call this method exactly once for each State object -it creates.

-

Override this method to perform initialization that depends on the -location at which this object was inserted into the tree (i.e., context) -or on the widget used to configure this object (i.e., widget).

-

If a State's build method depends on an object that can itself -change state, for example a ChangeNotifier or Stream, or some +\Called when this object is inserted into the tree.\ +\The framework will call this method exactly once for each \State\ object +it creates.\ +\Override this method to perform initialization that depends on the +location at which this object was inserted into the tree (i.e., \context\) +or on the widget used to configure this object (i.e., \widget\).\ +\If a \State\'s \build\ method depends on an object that can itself +change state, for example a \ChangeNotifier\ or \Stream\, or some other object to which one can subscribe to receive notifications, then -be sure to subscribe and unsubscribe properly in initState, -didUpdateWidget, and dispose:

- -

You cannot use BuildContext.dependOnInheritedWidgetOfExactType from this -method. However, didChangeDependencies will be called immediately -following this method, and BuildContext.dependOnInheritedWidgetOfExactType can -be used there.

-

Implementations of this method should start with a call to the inherited -method, as in super.initState().

+replacing the object.\ +\In \dispose\, unsubscribe from the object.\ +\ +\You cannot use \BuildContext.dependOnInheritedWidgetOfExactType\ from this +method. However, \didChangeDependencies\ will be called immediately +following this method, and \BuildContext.dependOnInheritedWidgetOfExactType\ can +be used there.\ +\Implementations of this method should start with a call to the inherited +method, as in \super.initState()\.\ @@ -49,9 +49,9 @@ method, as in super.initState().

```dart @override -void initState() { +void initState() \{ super.initState(); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState/pindex.md b/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState/pindex.md index e609f0c2820..cb90088971e 100644 --- a/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState/pindex.md +++ b/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState/pindex.md @@ -9,9 +9,9 @@ -[int](https://api.flutter.dev/flutter/dart-core/int-class.html) pindex +[int](https:api.flutter.dev/flutter/dart-core/int-class.html) pindex -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState/startedPlaying.md b/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState/startedPlaying.md index 765d3d6af0f..91228eb47e3 100644 --- a/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState/startedPlaying.md +++ b/docs/talawa-mobile-docs/widgets_post_widget/PostContainerState/startedPlaying.md @@ -9,9 +9,9 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) startedPlaying +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) startedPlaying -_read / write_ +_\read / write\_ diff --git a/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton-class.md b/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton-class.md index f4dd829d244..6b0ffc436a0 100644 --- a/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton-class.md +++ b/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton-class.md @@ -11,17 +11,17 @@ -

This class returns a widget for a raised rounded button, -for example: login button in login screen.

+\This class returns a widget for a raised rounded button, +for example: login button in login screen.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html) - RaisedRoundedButton @@ -33,55 +33,55 @@ for example: login button in login screen.

## Constructors -[RaisedRoundedButton](../widgets_raised_round_edge_button/RaisedRoundedButton/RaisedRoundedButton.md) ({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) buttonLabel, required [Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) backgroundColor, required [Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) textColor, required dynamic onTap(), [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? height, [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? width, [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) showArrow = false}) +[RaisedRoundedButton](../widgets_raised_round_edge_button/RaisedRoundedButton/RaisedRoundedButton.md) (\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) buttonLabel, required [Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) backgroundColor, required [Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) textColor, required dynamic onTap(), [double](https:api.flutter.dev/flutter/dart-core/double-class.html)? height, [double](https:api.flutter.dev/flutter/dart-core/double-class.html)? width, [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) showArrow = false\}) _const_ ## Properties -##### [backgroundColor](../widgets_raised_round_edge_button/RaisedRoundedButton/backgroundColor.md) → [Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) +##### [backgroundColor](../widgets_raised_round_edge_button/RaisedRoundedButton/backgroundColor.md) → [Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) -_final_ +_\final\_ -##### [buttonLabel](../widgets_raised_round_edge_button/RaisedRoundedButton/buttonLabel.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [buttonLabel](../widgets_raised_round_edge_button/RaisedRoundedButton/buttonLabel.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [height](../widgets_raised_round_edge_button/RaisedRoundedButton/height.md) → [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? +##### [height](../widgets_raised_round_edge_button/RaisedRoundedButton/height.md) → [double](https:api.flutter.dev/flutter/dart-core/double-class.html)? -_final_ +_\final\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ @@ -90,43 +90,43 @@ _finalinherited_ -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [showArrow](../widgets_raised_round_edge_button/RaisedRoundedButton/showArrow.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [showArrow](../widgets_raised_round_edge_button/RaisedRoundedButton/showArrow.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_final_ +_\final\_ -##### [textColor](../widgets_raised_round_edge_button/RaisedRoundedButton/textColor.md) → [Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) +##### [textColor](../widgets_raised_round_edge_button/RaisedRoundedButton/textColor.md) → [Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) -_final_ +_\final\_ -##### [width](../widgets_raised_round_edge_button/RaisedRoundedButton/width.md) → [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? +##### [width](../widgets_raised_round_edge_button/RaisedRoundedButton/width.md) → [double](https:api.flutter.dev/flutter/dart-core/double-class.html)? -_final_ +_\final\_ @@ -134,12 +134,12 @@ _final_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a
StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ @@ -148,81 +148,81 @@ _inherited_ Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -230,12 +230,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/RaisedRoundedButton.md b/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/RaisedRoundedButton.md index 99d95d5c858..d3408959c92 100644 --- a/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/RaisedRoundedButton.md +++ b/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/RaisedRoundedButton.md @@ -9,7 +9,7 @@ const -RaisedRoundedButton({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) buttonLabel, required [Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) backgroundColor, required [Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) textColor, required dynamic onTap(), [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? height, [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? width, [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) showArrow = false}) +RaisedRoundedButton(\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) buttonLabel, required [Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) backgroundColor, required [Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) textColor, required dynamic onTap(), [double](https:api.flutter.dev/flutter/dart-core/double-class.html)? height, [double](https:api.flutter.dev/flutter/dart-core/double-class.html)? width, [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) showArrow = false\}) @@ -18,7 +18,7 @@ RaisedRoundedButton({required [Key](https://api.flutter.dev/flutter/foundation/K ## Implementation ```dart -const RaisedRoundedButton({ +const RaisedRoundedButton(\{ required Key key, required this.buttonLabel, required this.backgroundColor, @@ -27,7 +27,7 @@ const RaisedRoundedButton({ this.height, this.width, this.showArrow = false, -}) : super(key: key); +\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/backgroundColor.md b/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/backgroundColor.md index 07df8f90434..227444998b8 100644 --- a/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/backgroundColor.md +++ b/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/backgroundColor.md @@ -9,9 +9,9 @@ -[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) backgroundColor +[Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) backgroundColor -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/buttonLabel.md b/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/buttonLabel.md index 9dad55b192a..881f662524f 100644 --- a/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/buttonLabel.md +++ b/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/buttonLabel.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) buttonLabel +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) buttonLabel -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/createState.md b/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/createState.md index 15334762515..043ba74ea9a 100644 --- a/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/createState.md +++ b/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) _RaisedRoundedButtonState createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/onTap.md b/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/onTap.md index 71f15a9add6..044966c2092 100644 --- a/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/onTap.md +++ b/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/onTap.md @@ -11,7 +11,7 @@ dynamic Function() onTap -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/showArrow.md b/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/showArrow.md index 989fd8683cb..b08f747ff92 100644 --- a/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/showArrow.md +++ b/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/showArrow.md @@ -9,9 +9,9 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) showArrow +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) showArrow -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/textColor.md b/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/textColor.md index 7c04e70516e..f208b1de580 100644 --- a/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/textColor.md +++ b/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/textColor.md @@ -9,9 +9,9 @@ -[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) textColor +[Color](https:api.flutter.dev/flutter/dart-ui/Color-class.html) textColor -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/width.md b/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/width.md index e35287c28d2..88962380352 100644 --- a/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/width.md +++ b/docs/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/width.md @@ -9,9 +9,9 @@ -[double](https://api.flutter.dev/flutter/dart-core/double-class.html)? width +[double](https:api.flutter.dev/flutter/dart-core/double-class.html)? width -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_rich_text/CustomRichText-class.md b/docs/talawa-mobile-docs/widgets_rich_text/CustomRichText-class.md index c57b561fd60..2620f477ce6 100644 --- a/docs/talawa-mobile-docs/widgets_rich_text/CustomRichText-class.md +++ b/docs/talawa-mobile-docs/widgets_rich_text/CustomRichText-class.md @@ -11,17 +11,17 @@ -

CustomRichText class returns a widget for customized rich/bold text. -These rich text are being used in form for changing the password.

+\CustomRichText class returns a widget for customized rich/bold text. +These rich text are being used in form for changing the password.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - CustomRichText @@ -33,46 +33,46 @@ These rich text are being used in form for changing the password.

## Constructors -[CustomRichText](../widgets_rich_text/CustomRichText/CustomRichText.md) ({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key, required [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic>> words}) +[CustomRichText](../widgets_rich_text/CustomRichText/CustomRichText.md) (\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key, required [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> words\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [words](../widgets_rich_text/CustomRichText/words.md) → [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic>> +##### [words](../widgets_rich_text/CustomRichText/words.md) → [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> -_final_ +_\final\_ @@ -80,95 +80,95 @@ _final_ ## Methods -##### [build](../widgets_rich_text/CustomRichText/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../widgets_rich_text/CustomRichText/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -176,12 +176,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_rich_text/CustomRichText/CustomRichText.md b/docs/talawa-mobile-docs/widgets_rich_text/CustomRichText/CustomRichText.md index a8ef77480a9..a91a7c2c5d2 100644 --- a/docs/talawa-mobile-docs/widgets_rich_text/CustomRichText/CustomRichText.md +++ b/docs/talawa-mobile-docs/widgets_rich_text/CustomRichText/CustomRichText.md @@ -9,7 +9,7 @@ const -CustomRichText({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key, required [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic>> words}) +CustomRichText(\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key, required [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> words\}) @@ -18,7 +18,7 @@ CustomRichText({required [Key](https://api.flutter.dev/flutter/foundation/Key-cl ## Implementation ```dart -const CustomRichText({required Key key, required this.words}) +const CustomRichText(\{required Key key, required this.words\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_rich_text/CustomRichText/build.md b/docs/talawa-mobile-docs/widgets_rich_text/CustomRichText/build.md index 47b3462392a..df51119cc40 100644 --- a/docs/talawa-mobile-docs/widgets_rich_text/CustomRichText/build.md +++ b/docs/talawa-mobile-docs/widgets_rich_text/CustomRichText/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,24 +58,24 @@ and ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ return RichText( textAlign: TextAlign.start, text: TextSpan( text: - "${AppLocalizations.of(context)!.strictTranslate(words[0]['text'].toString().trim())} ", + "$\{AppLocalizations.of(context)!.strictTranslate(words[0]['text'].toString().trim())\} ", style: words[0]['textStyle'] as TextStyle, children: List.generate( words.length - 1, - (index) => TextSpan( + (index) =\> TextSpan( text: - "${AppLocalizations.of(context)!.strictTranslate(words[index + 1]['text'].toString().trim())} ", + "$\{AppLocalizations.of(context)!.strictTranslate(words[index + 1]['text'].toString().trim())\} ", style: words[index + 1]['textStyle'] as TextStyle, ), ), ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_rich_text/CustomRichText/words.md b/docs/talawa-mobile-docs/widgets_rich_text/CustomRichText/words.md index 6f9a3090036..548d708fa4b 100644 --- a/docs/talawa-mobile-docs/widgets_rich_text/CustomRichText/words.md +++ b/docs/talawa-mobile-docs/widgets_rich_text/CustomRichText/words.md @@ -9,9 +9,9 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic>> words +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Map](https:api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> words -_final_ +_\final\_ @@ -21,7 +21,7 @@ _final_ ## Implementation ```dart -final List> words; +final List\\> words; ``` diff --git a/docs/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator-class.md b/docs/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator-class.md index 55f30f0084d..9a8e88aae84 100644 --- a/docs/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator-class.md +++ b/docs/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator-class.md @@ -11,17 +11,17 @@ -

This class returns a widget for showing the -progress indicator/flow while Signing Up/ Registration.

+\This class returns a widget for showing the +progress indicator/flow while Signing Up/ Registration.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - SignupProgressIndicator @@ -33,55 +33,55 @@ progress indicator/flow while Signing Up/ Registration.

## Constructors -[SignupProgressIndicator](../widgets_signup_progress_indicator/SignupProgressIndicator/SignupProgressIndicator.md) ({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key, required [int](https://api.flutter.dev/flutter/dart-core/int-class.html) currentPageIndex}) +[SignupProgressIndicator](../widgets_signup_progress_indicator/SignupProgressIndicator/SignupProgressIndicator.md) (\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key, required [int](https:api.flutter.dev/flutter/dart-core/int-class.html) currentPageIndex\}) ## Properties -##### [currentPageIndex](../widgets_signup_progress_indicator/SignupProgressIndicator/currentPageIndex.md) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [currentPageIndex](../widgets_signup_progress_indicator/SignupProgressIndicator/currentPageIndex.md) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [progressLabel](../widgets_signup_progress_indicator/SignupProgressIndicator/progressLabel.md) → [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html)> +##### [progressLabel](../widgets_signup_progress_indicator/SignupProgressIndicator/progressLabel.md) → [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html)\> -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -89,95 +89,95 @@ _read-onlyinherited_ ## Methods -##### [build](../widgets_signup_progress_indicator/SignupProgressIndicator/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../widgets_signup_progress_indicator/SignupProgressIndicator/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -185,12 +185,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/SignupProgressIndicator.md b/docs/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/SignupProgressIndicator.md index a3b52a67b4d..0195def58b5 100644 --- a/docs/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/SignupProgressIndicator.md +++ b/docs/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/SignupProgressIndicator.md @@ -9,7 +9,7 @@ -SignupProgressIndicator({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key, required [int](https://api.flutter.dev/flutter/dart-core/int-class.html) currentPageIndex}) +SignupProgressIndicator(\{required [Key](https:api.flutter.dev/flutter/foundation/Key-class.html) key, required [int](https:api.flutter.dev/flutter/dart-core/int-class.html) currentPageIndex\}) @@ -18,7 +18,7 @@ SignupProgressIndicator({required [Key](https://api.flutter.dev/flutter/foundati ## Implementation ```dart -SignupProgressIndicator({required Key key, required this.currentPageIndex}) +SignupProgressIndicator(\{required Key key, required this.currentPageIndex\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/build.md b/docs/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/build.md index 7ed129c74e2..afb5f4bb1df 100644 --- a/docs/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/build.md +++ b/docs/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,7 +58,7 @@ and ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ return Container( alignment: Alignment.center, height: SizeConfig.screenHeight! * 0.15, @@ -67,34 +67,34 @@ Widget build(BuildContext context) { physics: const NeverScrollableScrollPhysics(), padding: EdgeInsets.zero, builder: TimelineTileBuilder.connected( - contentsBuilder: (_, index) => Text( + contentsBuilder: (_, index) =\> Text( AppLocalizations.of(context)!.strictTranslate(progressLabel[index]), style: Theme.of(context).textTheme.bodyMedium!.copyWith( - // If the flow index is greater than currentPageIndex then - // show green(visited) color else show fade(not visited) color. - color: index <= currentPageIndex + If the flow index is greater than currentPageIndex then + show green(visited) color else show fade(not visited) color. + color: index \<= currentPageIndex ? const Color(0xFF008A37) : const Color(0xFF737373), ), textAlign: TextAlign.center, ), - connectorBuilder: (_, index, __) { + connectorBuilder: (_, index, __) \{ return SolidLineConnector( space: 30, - // If the flow index is greater than currentPageIndex then - // show green(visited) color else show fade(not visited) color. - color: index < currentPageIndex + If the flow index is greater than currentPageIndex then + show green(visited) color else show fade(not visited) color. + color: index \< currentPageIndex ? const Color(0xFF008A37) : const Color(0xFF737373), ); - }, - indicatorBuilder: (_, index) { + \}, + indicatorBuilder: (_, index) \{ return DotIndicator( size: 25, - color: index <= currentPageIndex + color: index \<= currentPageIndex ? const Color(0xFF008A37) : const Color(0xFF737373), - child: index < currentPageIndex + child: index \< currentPageIndex ? const Icon( Icons.done, color: Colors.white, @@ -102,13 +102,13 @@ Widget build(BuildContext context) { ) : const SizedBox(), ); - }, - itemExtentBuilder: (_, __) => MediaQuery.of(context).size.width / 3, + \}, + itemExtentBuilder: (_, __) =\> MediaQuery.of(context).size.width / 3, itemCount: 3, ), ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/currentPageIndex.md b/docs/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/currentPageIndex.md index f5f2af3eaa4..70b82d0bcab 100644 --- a/docs/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/currentPageIndex.md +++ b/docs/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/currentPageIndex.md @@ -9,9 +9,9 @@ -[int](https://api.flutter.dev/flutter/dart-core/int-class.html) currentPageIndex +[int](https:api.flutter.dev/flutter/dart-core/int-class.html) currentPageIndex -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/progressLabel.md b/docs/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/progressLabel.md index 7bb05930d7d..060e544a0b7 100644 --- a/docs/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/progressLabel.md +++ b/docs/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/progressLabel.md @@ -9,9 +9,9 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html)> progressLabel +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[String](https:api.flutter.dev/flutter/dart-core/String-class.html)\> progressLabel -_final_ +_\final\_ @@ -21,7 +21,7 @@ _final_ ## Implementation ```dart -final List progressLabel = [ +final List\ progressLabel = [ 'Select\nOrganization', 'Enter Details', 'Final', diff --git a/docs/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog-class.md b/docs/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog-class.md index 3718686e111..ce917e2357b 100644 --- a/docs/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog-class.md +++ b/docs/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog-class.md @@ -16,10 +16,10 @@ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - TalawaErrorDialog @@ -31,37 +31,37 @@ ## Constructors -[TalawaErrorDialog](../widgets_talawa_error_dialog/TalawaErrorDialog/TalawaErrorDialog.md) ([String](https://api.flutter.dev/flutter/dart-core/String-class.html) errorMessage, {[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [MessageType](../enums_enums/MessageType.md) messageType}) +[TalawaErrorDialog](../widgets_talawa_error_dialog/TalawaErrorDialog/TalawaErrorDialog.md) ([String](https:api.flutter.dev/flutter/dart-core/String-class.html) errorMessage, \{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [MessageType](../enums_enums/MessageType.md) messageType\}) _const_ ## Properties -##### [errorMessage](../widgets_talawa_error_dialog/TalawaErrorDialog/errorMessage.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [errorMessage](../widgets_talawa_error_dialog/TalawaErrorDialog/errorMessage.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ @@ -70,16 +70,16 @@ _finalinherited_ -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -87,95 +87,95 @@ _read-onlyinherited_ ## Methods -##### [build](../widgets_talawa_error_dialog/TalawaErrorDialog/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../widgets_talawa_error_dialog/TalawaErrorDialog/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -183,12 +183,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/TalawaErrorDialog.md b/docs/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/TalawaErrorDialog.md index 7ae8a4bd283..ca46d329acb 100644 --- a/docs/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/TalawaErrorDialog.md +++ b/docs/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/TalawaErrorDialog.md @@ -9,7 +9,7 @@ const -TalawaErrorDialog([String](https://api.flutter.dev/flutter/dart-core/String-class.html) errorMessage, {[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [MessageType](../../enums_enums/MessageType.md) messageType}) +TalawaErrorDialog([String](https:api.flutter.dev/flutter/dart-core/String-class.html) errorMessage, \{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [MessageType](../../enums_enums/MessageType.md) messageType\}) @@ -19,10 +19,10 @@ TalawaErrorDialog([String](https://api.flutter.dev/flutter/dart-core/String-clas ```dart const TalawaErrorDialog( - this.errorMessage, { + this.errorMessage, \{ Key? key, required this.messageType, -}) : super(key: key); +\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/build.md b/docs/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/build.md index a8c9273fadb..31589650c89 100644 --- a/docs/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/build.md +++ b/docs/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,7 +58,7 @@ and ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ return SizedBox( child: AlertDialog( content: SizedBox( @@ -125,9 +125,9 @@ Widget build(BuildContext context) { ], ), ), - actions: [ - // Expanded( - // child: + actions: \[ + Expanded( + child: TextButton( style: TextButton.styleFrom( backgroundColor: messageType == MessageType.error @@ -149,15 +149,15 @@ Widget build(BuildContext context) { : 'Dismiss', style: const TextStyle(color: Color.fromRGBO(202, 202, 202, 1)), ), - onPressed: () { + onPressed: () \{ Navigator.of(context).pop(); - }, + \}, + ), ), - // ), ], ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/errorMessage.md b/docs/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/errorMessage.md index b9844493a99..5f455e5757a 100644 --- a/docs/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/errorMessage.md +++ b/docs/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/errorMessage.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) errorMessage +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) errorMessage -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/messageType.md b/docs/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/messageType.md index 62809db57cd..724708bde53 100644 --- a/docs/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/messageType.md +++ b/docs/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/messageType.md @@ -11,7 +11,7 @@ [MessageType](../../enums_enums/MessageType.md) messageType -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar-class.md b/docs/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar-class.md index 8d8412b336b..a2e852a5be0 100644 --- a/docs/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar-class.md +++ b/docs/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar-class.md @@ -16,10 +16,10 @@ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - TalawaErrorSnackBar @@ -31,37 +31,37 @@ ## Constructors -[TalawaErrorSnackBar](../widgets_talawa_error_snackbar/TalawaErrorSnackBar/TalawaErrorSnackBar.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) errorMessage, required [MessageType](../enums_enums/MessageType.md) messageType}) +[TalawaErrorSnackBar](../widgets_talawa_error_snackbar/TalawaErrorSnackBar/TalawaErrorSnackBar.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) errorMessage, required [MessageType](../enums_enums/MessageType.md) messageType\}) _const_ ## Properties -##### [errorMessage](../widgets_talawa_error_snackbar/TalawaErrorSnackBar/errorMessage.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [errorMessage](../widgets_talawa_error_snackbar/TalawaErrorSnackBar/errorMessage.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ @@ -70,16 +70,16 @@ _finalinherited_ -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -87,95 +87,95 @@ _read-onlyinherited_ ## Methods -##### [build](../widgets_talawa_error_snackbar/TalawaErrorSnackBar/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../widgets_talawa_error_snackbar/TalawaErrorSnackBar/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -183,12 +183,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/TalawaErrorSnackBar.md b/docs/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/TalawaErrorSnackBar.md index c8d6fa0af12..19d63b8cff3 100644 --- a/docs/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/TalawaErrorSnackBar.md +++ b/docs/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/TalawaErrorSnackBar.md @@ -9,7 +9,7 @@ const -TalawaErrorSnackBar({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) errorMessage, required [MessageType](../../enums_enums/MessageType.md) messageType}) +TalawaErrorSnackBar(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) errorMessage, required [MessageType](../../enums_enums/MessageType.md) messageType\}) @@ -18,11 +18,11 @@ TalawaErrorSnackBar({[Key](https://api.flutter.dev/flutter/foundation/Key-class. ## Implementation ```dart -const TalawaErrorSnackBar({ +const TalawaErrorSnackBar(\{ Key? key, required this.errorMessage, required this.messageType, -}) : super(key: key); +\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/build.md b/docs/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/build.md index 34867b9c114..814b2ba86a2 100644 --- a/docs/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/build.md +++ b/docs/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,7 +58,7 @@ and ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ return Row( children: [ Container( @@ -85,7 +85,7 @@ Widget build(BuildContext context) { : messageType == MessageType.info ? Icons.info_outline : Icons.error, - // Icons.error, + Icons.error, color: messageType == MessageType.error ? Colors.red : messageType == MessageType.warning @@ -110,7 +110,7 @@ Widget build(BuildContext context) { ) ], ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/errorMessage.md b/docs/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/errorMessage.md index b9844493a99..5f455e5757a 100644 --- a/docs/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/errorMessage.md +++ b/docs/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/errorMessage.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) errorMessage +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) errorMessage -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/messageType.md b/docs/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/messageType.md index 62809db57cd..724708bde53 100644 --- a/docs/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/messageType.md +++ b/docs/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/messageType.md @@ -11,7 +11,7 @@ [MessageType](../../enums_enums/MessageType.md) messageType -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_task_form/DescriptionField-class.md b/docs/talawa-mobile-docs/widgets_task_form/DescriptionField-class.md index f6fad42ea59..397976da1b8 100644 --- a/docs/talawa-mobile-docs/widgets_task_form/DescriptionField-class.md +++ b/docs/talawa-mobile-docs/widgets_task_form/DescriptionField-class.md @@ -16,10 +16,10 @@ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - DescriptionField @@ -31,37 +31,37 @@ ## Constructors -[DescriptionField](../widgets_task_form/DescriptionField/DescriptionField.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +[DescriptionField](../widgets_task_form/DescriptionField/DescriptionField.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -69,95 +69,95 @@ _read-onlyinherited_ ## Methods -##### [build](../widgets_task_form/DescriptionField/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../widgets_task_form/DescriptionField/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -165,12 +165,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_task_form/DescriptionField/DescriptionField.md b/docs/talawa-mobile-docs/widgets_task_form/DescriptionField/DescriptionField.md index cc04187762a..b537303e297 100644 --- a/docs/talawa-mobile-docs/widgets_task_form/DescriptionField/DescriptionField.md +++ b/docs/talawa-mobile-docs/widgets_task_form/DescriptionField/DescriptionField.md @@ -9,7 +9,7 @@ const -DescriptionField({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +DescriptionField(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) @@ -18,7 +18,7 @@ DescriptionField({[Key](https://api.flutter.dev/flutter/foundation/Key-class.htm ## Implementation ```dart -const DescriptionField({Key? key}) : super(key: key); +const DescriptionField(\{Key? key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_task_form/DescriptionField/build.md b/docs/talawa-mobile-docs/widgets_task_form/DescriptionField/build.md index 27bb4f2875a..a65707a7fb2 100644 --- a/docs/talawa-mobile-docs/widgets_task_form/DescriptionField/build.md +++ b/docs/talawa-mobile-docs/widgets_task_form/DescriptionField/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,15 +58,15 @@ and ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ final taskDescriptionTextController = context.select( - (CreateTaskViewModel model) => model.taskDescriptionTextController, + (CreateTaskViewModel model) =\> model.taskDescriptionTextController, ); return TextFormField( keyboardType: TextInputType.multiline, controller: taskDescriptionTextController, - validator: (value) => Validator.validateEventForm(value!, 'Description'), + validator: (value) =\> Validator.validateEventForm(value!, 'Description'), maxLines: 10, minLines: 1, decoration: InputDecoration( @@ -89,7 +89,7 @@ Widget build(BuildContext context) { ), ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_task_form/TaskForm-class.md b/docs/talawa-mobile-docs/widgets_task_form/TaskForm-class.md index 6f56ca2b49a..37f36ce9077 100644 --- a/docs/talawa-mobile-docs/widgets_task_form/TaskForm-class.md +++ b/docs/talawa-mobile-docs/widgets_task_form/TaskForm-class.md @@ -16,10 +16,10 @@ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html) - TaskForm @@ -31,64 +31,64 @@ ## Constructors -[TaskForm](../widgets_task_form/TaskForm/TaskForm.md) ({required [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)> onSave(), required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) title, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) actionText, [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +[TaskForm](../widgets_task_form/TaskForm/TaskForm.md) (\{required [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)\> onSave(), required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) title, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) actionText, [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) _const_ ## Properties -##### [actionText](../widgets_task_form/TaskForm/actionText.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [actionText](../widgets_task_form/TaskForm/actionText.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [onSave](../widgets_task_form/TaskForm/onSave.md) → [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)> Function() +##### [onSave](../widgets_task_form/TaskForm/onSave.md) → [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)\> Function() -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [title](../widgets_task_form/TaskForm/title.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [title](../widgets_task_form/TaskForm/title.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_final_ +_\final\_ @@ -96,95 +96,95 @@ _final_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [createState](../widgets_task_form/TaskForm/createState.md)() [State](https://api.flutter.dev/flutter/widgets/State-class.html)<[TaskForm](../widgets_task_form/TaskForm-class.md)> +##### [createState](../widgets_task_form/TaskForm/createState.md)() [State](https:api.flutter.dev/flutter/widgets/State-class.html)<[TaskForm](../widgets_task_form/TaskForm-class.md)\> Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -192,12 +192,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_task_form/TaskForm/TaskForm.md b/docs/talawa-mobile-docs/widgets_task_form/TaskForm/TaskForm.md index 4270294a8fa..a06eb2548d4 100644 --- a/docs/talawa-mobile-docs/widgets_task_form/TaskForm/TaskForm.md +++ b/docs/talawa-mobile-docs/widgets_task_form/TaskForm/TaskForm.md @@ -9,7 +9,7 @@ const -TaskForm({required [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)> onSave(), required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) title, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) actionText, [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +TaskForm(\{required [Future](https:api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html)\> onSave(), required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) title, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) actionText, [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) @@ -18,12 +18,12 @@ TaskForm({required [Future](https://api.flutter.dev/flutter/dart-async/Future-cl ## Implementation ```dart -const TaskForm({ +const TaskForm(\{ required this.onSave, required this.title, required this.actionText, Key? key, -}) : super(key: key); +\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_task_form/TaskForm/actionText.md b/docs/talawa-mobile-docs/widgets_task_form/TaskForm/actionText.md index ca533420f07..7ebb5b27bfb 100644 --- a/docs/talawa-mobile-docs/widgets_task_form/TaskForm/actionText.md +++ b/docs/talawa-mobile-docs/widgets_task_form/TaskForm/actionText.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) actionText +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) actionText -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_task_form/TaskForm/createState.md b/docs/talawa-mobile-docs/widgets_task_form/TaskForm/createState.md index f746871161e..f4496f9493f 100644 --- a/docs/talawa-mobile-docs/widgets_task_form/TaskForm/createState.md +++ b/docs/talawa-mobile-docs/widgets_task_form/TaskForm/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[State](https://api.flutter.dev/flutter/widgets/State-class.html)<[TaskForm](../../widgets_task_form/TaskForm-class.md)> createState +[State](https:api.flutter.dev/flutter/widgets/State-class.html)<[TaskForm](../../widgets_task_form/TaskForm-class.md)\> createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh final_ +_\final\_ @@ -21,7 +21,7 @@ _final_ ## Implementation ```dart -final Future Function() onSave; +final Future\ Function() onSave; ``` diff --git a/docs/talawa-mobile-docs/widgets_task_form/TaskForm/title.md b/docs/talawa-mobile-docs/widgets_task_form/TaskForm/title.md index 7c14a386485..27e728d54a8 100644 --- a/docs/talawa-mobile-docs/widgets_task_form/TaskForm/title.md +++ b/docs/talawa-mobile-docs/widgets_task_form/TaskForm/title.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) title +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) title -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_task_form/TitleField-class.md b/docs/talawa-mobile-docs/widgets_task_form/TitleField-class.md index 3a1b005b536..3386becd80f 100644 --- a/docs/talawa-mobile-docs/widgets_task_form/TitleField-class.md +++ b/docs/talawa-mobile-docs/widgets_task_form/TitleField-class.md @@ -16,10 +16,10 @@ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - TitleField @@ -31,37 +31,37 @@ ## Constructors -[TitleField](../widgets_task_form/TitleField/TitleField.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +[TitleField](../widgets_task_form/TitleField/TitleField.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -69,95 +69,95 @@ _read-onlyinherited_ ## Methods -##### [build](../widgets_task_form/TitleField/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../widgets_task_form/TitleField/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -165,12 +165,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_task_form/TitleField/TitleField.md b/docs/talawa-mobile-docs/widgets_task_form/TitleField/TitleField.md index 4ceaed2f95a..c0ca058dc11 100644 --- a/docs/talawa-mobile-docs/widgets_task_form/TitleField/TitleField.md +++ b/docs/talawa-mobile-docs/widgets_task_form/TitleField/TitleField.md @@ -9,7 +9,7 @@ const -TitleField({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +TitleField(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) @@ -18,7 +18,7 @@ TitleField({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? ke ## Implementation ```dart -const TitleField({Key? key}) : super(key: key); +const TitleField(\{Key? key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_task_form/TitleField/build.md b/docs/talawa-mobile-docs/widgets_task_form/TitleField/build.md index 8efb4db8d97..b35af5ab852 100644 --- a/docs/talawa-mobile-docs/widgets_task_form/TitleField/build.md +++ b/docs/talawa-mobile-docs/widgets_task_form/TitleField/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,15 +58,15 @@ and ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ final taskTitleTextController = context - .select((CreateTaskViewModel model) => model.taskTitleTextController); + .select((CreateTaskViewModel model) =\> model.taskTitleTextController); return TextFormField( textInputAction: TextInputAction.next, controller: taskTitleTextController, keyboardType: TextInputType.name, maxLength: 100, - validator: (value) => Validator.validateEventForm(value!, 'Title'), + validator: (value) =\> Validator.validateEventForm(value!, 'Title'), decoration: InputDecoration( labelText: 'Add Task Title', isDense: true, @@ -87,7 +87,7 @@ Widget build(BuildContext context) { ), ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_task_schedule/TaskCard-class.md b/docs/talawa-mobile-docs/widgets_task_schedule/TaskCard-class.md index 75f697cb2fe..bba14874e8b 100644 --- a/docs/talawa-mobile-docs/widgets_task_schedule/TaskCard-class.md +++ b/docs/talawa-mobile-docs/widgets_task_schedule/TaskCard-class.md @@ -16,10 +16,10 @@ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - TaskCard @@ -31,55 +31,55 @@ ## Constructors -[TaskCard](../widgets_task_schedule/TaskCard/TaskCard.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Appointment](https://pub.dev/documentation/syncfusion_flutter_calendar/20.4.54/calendar/Appointment-class.html) appointment, required [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) showMoreOptions, required [Task](../models_task_task_model/Task-class.md) task}) +[TaskCard](../widgets_task_schedule/TaskCard/TaskCard.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Appointment](https:pub.dev/documentation/syncfusion_flutter_calendar/20.4.54/calendar/Appointment-class.html) appointment, required [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) showMoreOptions, required [Task](../models_task_task_model/Task-class.md) task\}) _const_ ## Properties -##### [appointment](../widgets_task_schedule/TaskCard/appointment.md) → [Appointment](https://pub.dev/documentation/syncfusion_flutter_calendar/20.4.54/calendar/Appointment-class.html) +##### [appointment](../widgets_task_schedule/TaskCard/appointment.md) → [Appointment](https:pub.dev/documentation/syncfusion_flutter_calendar/20.4.54/calendar/Appointment-class.html) -_final_ +_\final\_ -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [showMoreOptions](../widgets_task_schedule/TaskCard/showMoreOptions.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [showMoreOptions](../widgets_task_schedule/TaskCard/showMoreOptions.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_final_ +_\final\_ @@ -88,7 +88,7 @@ _final_ -_final_ +_\final\_ @@ -96,95 +96,95 @@ _final_ ## Methods -##### [build](../widgets_task_schedule/TaskCard/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../widgets_task_schedule/TaskCard/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -192,12 +192,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_task_schedule/TaskCard/TaskCard.md b/docs/talawa-mobile-docs/widgets_task_schedule/TaskCard/TaskCard.md index 1f611b973dc..b41c0b3c6bc 100644 --- a/docs/talawa-mobile-docs/widgets_task_schedule/TaskCard/TaskCard.md +++ b/docs/talawa-mobile-docs/widgets_task_schedule/TaskCard/TaskCard.md @@ -9,7 +9,7 @@ const -TaskCard({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Appointment](https://pub.dev/documentation/syncfusion_flutter_calendar/20.4.54/calendar/Appointment-class.html) appointment, required [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) showMoreOptions, required [Task](../../models_task_task_model/Task-class.md) task}) +TaskCard(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Appointment](https:pub.dev/documentation/syncfusion_flutter_calendar/20.4.54/calendar/Appointment-class.html) appointment, required [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) showMoreOptions, required [Task](../../models_task_task_model/Task-class.md) task\}) @@ -18,12 +18,12 @@ TaskCard({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, ## Implementation ```dart -const TaskCard({ +const TaskCard(\{ Key? key, required this.appointment, required this.showMoreOptions, required this.task, -}) : super(key: key); +\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_task_schedule/TaskCard/appointment.md b/docs/talawa-mobile-docs/widgets_task_schedule/TaskCard/appointment.md index 7c06657a231..81b45df2909 100644 --- a/docs/talawa-mobile-docs/widgets_task_schedule/TaskCard/appointment.md +++ b/docs/talawa-mobile-docs/widgets_task_schedule/TaskCard/appointment.md @@ -9,9 +9,9 @@ -[Appointment](https://pub.dev/documentation/syncfusion_flutter_calendar/20.4.54/calendar/Appointment-class.html) appointment +[Appointment](https:pub.dev/documentation/syncfusion_flutter_calendar/20.4.54/calendar/Appointment-class.html) appointment -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_task_schedule/TaskCard/build.md b/docs/talawa-mobile-docs/widgets_task_schedule/TaskCard/build.md index 3ff8b01218e..899bdc80cc2 100644 --- a/docs/talawa-mobile-docs/widgets_task_schedule/TaskCard/build.md +++ b/docs/talawa-mobile-docs/widgets_task_schedule/TaskCard/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,7 +58,7 @@ and ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ return Container( decoration: BoxDecoration( color: appointment.color, @@ -75,7 +75,7 @@ Widget build(BuildContext context) { mainAxisAlignment: MainAxisAlignment.center, children: [ Text( - ' ${appointment.subject}', + ' $\{appointment.subject\}', style: const TextStyle( fontWeight: FontWeight.w500, fontSize: 18, @@ -98,7 +98,7 @@ Widget build(BuildContext context) { ), showMoreOptions ? IconButton( - onPressed: () { + onPressed: () \{ navigationService.pushDialog( AlertDialog( title: Text( @@ -110,39 +110,39 @@ Widget build(BuildContext context) { actions: [ TextButton( child: const Text('Delete'), - onPressed: () { - context.read().deleteTask( + onPressed: () \{ + context.read\().deleteTask( task.id, task.creator.id!, ); navigationService.pop(); - }, + \}, ), TextButton( child: const Text('Edit'), - onPressed: () { + onPressed: () \{ navigationService.pop(); navigationService.pushScreen( Routes.editTask, arguments: task, ); - }, + \}, ), TextButton( child: const Text('Cancel'), - onPressed: () => navigationService.pop(), + onPressed: () =\> navigationService.pop(), ), ], ), ); - }, + \}, icon: const Icon(Icons.more_vert), ) : Container(), ], ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_task_schedule/TaskCard/showMoreOptions.md b/docs/talawa-mobile-docs/widgets_task_schedule/TaskCard/showMoreOptions.md index 8ea65561495..0d62f3122cf 100644 --- a/docs/talawa-mobile-docs/widgets_task_schedule/TaskCard/showMoreOptions.md +++ b/docs/talawa-mobile-docs/widgets_task_schedule/TaskCard/showMoreOptions.md @@ -9,9 +9,9 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) showMoreOptions +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) showMoreOptions -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_task_schedule/TaskCard/task.md b/docs/talawa-mobile-docs/widgets_task_schedule/TaskCard/task.md index 3cf99076fd6..e2fb263172d 100644 --- a/docs/talawa-mobile-docs/widgets_task_schedule/TaskCard/task.md +++ b/docs/talawa-mobile-docs/widgets_task_schedule/TaskCard/task.md @@ -11,7 +11,7 @@ [Task](../../models_task_task_model/Task-class.md) task -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_task_schedule/TaskSchedule-class.md b/docs/talawa-mobile-docs/widgets_task_schedule/TaskSchedule-class.md index 26e9e352d53..4c7fd271dac 100644 --- a/docs/talawa-mobile-docs/widgets_task_schedule/TaskSchedule-class.md +++ b/docs/talawa-mobile-docs/widgets_task_schedule/TaskSchedule-class.md @@ -16,10 +16,10 @@ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - TaskSchedule @@ -31,55 +31,55 @@ ## Constructors -[TaskSchedule](../widgets_task_schedule/TaskSchedule/TaskSchedule.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Task](../models_task_task_model/Task-class.md)> tasks, [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) showMoreOptions = false}) +[TaskSchedule](../widgets_task_schedule/TaskSchedule/TaskSchedule.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Task](../models_task_task_model/Task-class.md)\> tasks, [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) showMoreOptions = false\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [showMoreOptions](../widgets_task_schedule/TaskSchedule/showMoreOptions.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [showMoreOptions](../widgets_task_schedule/TaskSchedule/showMoreOptions.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_final_ +_\final\_ -##### [tasks](../widgets_task_schedule/TaskSchedule/tasks.md) → [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Task](../models_task_task_model/Task-class.md)> +##### [tasks](../widgets_task_schedule/TaskSchedule/tasks.md) → [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Task](../models_task_task_model/Task-class.md)\> -_final_ +_\final\_ @@ -87,16 +87,16 @@ _final_ ## Methods -##### [build](../widgets_task_schedule/TaskSchedule/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../widgets_task_schedule/TaskSchedule/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [calendarTapped](../widgets_task_schedule/TaskSchedule/calendarTapped.md)([CalendarTapDetails](https://pub.dev/documentation/syncfusion_flutter_calendar/20.4.54/calendar/CalendarTapDetails-class.html) details) void +##### [calendarTapped](../widgets_task_schedule/TaskSchedule/calendarTapped.md)([CalendarTapDetails](https:pub.dev/documentation/syncfusion_flutter_calendar/20.4.54/calendar/CalendarTapDetails-class.html) details) void @@ -105,86 +105,86 @@ _override_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -192,12 +192,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/TaskSchedule.md b/docs/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/TaskSchedule.md index 06e9a9ce6e2..242aeec5948 100644 --- a/docs/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/TaskSchedule.md +++ b/docs/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/TaskSchedule.md @@ -9,7 +9,7 @@ const -TaskSchedule({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Task](../../models_task_task_model/Task-class.md)> tasks, [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) showMoreOptions = false}) +TaskSchedule(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Task](../../models_task_task_model/Task-class.md)\> tasks, [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) showMoreOptions = false\}) @@ -18,11 +18,11 @@ TaskSchedule({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? ## Implementation ```dart -const TaskSchedule({ +const TaskSchedule(\{ Key? key, required this.tasks, this.showMoreOptions = false, -}) : super(key: key); +\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/build.md b/docs/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/build.md index 88667691ac0..4fd1a0cdef2 100644 --- a/docs/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/build.md +++ b/docs/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,7 +58,7 @@ and ```dart @override -Widget build(BuildContext context) { +Widget build(BuildContext context) \{ return SfCalendar( view: CalendarView.schedule, dataSource: _getCalendarDataSource(tasks), @@ -70,17 +70,17 @@ Widget build(BuildContext context) { ), ), onTap: calendarTapped, - appointmentBuilder: (context, appointments) { + appointmentBuilder: (context, appointments) \{ final appointment = appointments.appointments.first as Appointment; - final task = tasks.firstWhere((task) => task.id == appointment.id); + final task = tasks.firstWhere((task) =\> task.id == appointment.id); return TaskCard( appointment: appointment, showMoreOptions: showMoreOptions, task: task, ); - }, + \}, ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/calendarTapped.md b/docs/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/calendarTapped.md index 8f719be54cb..f6d450a7651 100644 --- a/docs/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/calendarTapped.md +++ b/docs/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/calendarTapped.md @@ -11,7 +11,7 @@ void calendarTapped -([CalendarTapDetails](https://pub.dev/documentation/syncfusion_flutter_calendar/20.4.54/calendar/CalendarTapDetails-class.html) details) +([CalendarTapDetails](https:pub.dev/documentation/syncfusion_flutter_calendar/20.4.54/calendar/CalendarTapDetails-class.html) details) @@ -23,9 +23,9 @@ void calendarTapped ## Implementation ```dart -void calendarTapped(CalendarTapDetails details) { +void calendarTapped(CalendarTapDetails details) \{ if (details.targetElement == CalendarElement.appointment || - details.targetElement == CalendarElement.agenda) { + details.targetElement == CalendarElement.agenda) \{ final Appointment appointmentDetails = details.appointments![0] as Appointment; final subjectText = appointmentDetails.subject; @@ -57,14 +57,14 @@ void calendarTapped(CalendarTapDetails details) { ), actions: [ TextButton( - onPressed: () => navigationService.pop(), + onPressed: () =\> navigationService.pop(), child: const Text('Close'), ) ], ), ); - } -} + \} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/showMoreOptions.md b/docs/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/showMoreOptions.md index 8ea65561495..0d62f3122cf 100644 --- a/docs/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/showMoreOptions.md +++ b/docs/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/showMoreOptions.md @@ -9,9 +9,9 @@ -[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) showMoreOptions +[bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) showMoreOptions -_final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/tasks.md b/docs/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/tasks.md index d003e0b0e0c..8963cdd7a9b 100644 --- a/docs/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/tasks.md +++ b/docs/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/tasks.md @@ -9,9 +9,9 @@ -[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Task](../../models_task_task_model/Task-class.md)> tasks +[List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[Task](../../models_task_task_model/Task-class.md)\> tasks -_final_ +_\final\_ @@ -21,7 +21,7 @@ _final_ ## Implementation ```dart -final List tasks; +final List\ tasks; ``` diff --git a/docs/talawa-mobile-docs/widgets_theme_switch/ChangeThemeTile-class.md b/docs/talawa-mobile-docs/widgets_theme_switch/ChangeThemeTile-class.md index 3a74a348cc8..c1300f2786e 100644 --- a/docs/talawa-mobile-docs/widgets_theme_switch/ChangeThemeTile-class.md +++ b/docs/talawa-mobile-docs/widgets_theme_switch/ChangeThemeTile-class.md @@ -11,17 +11,17 @@ -

This class enables theme switch. -It returns a ListTile which contains a Toggle button to switch between Dark and Light Themes.

+\This class enables theme switch. +It returns a ListTile which contains a Toggle button to switch between Dark and Light Themes.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatelessWidget](https:api.flutter.dev/flutter/widgets/StatelessWidget-class.html) - ChangeThemeTile @@ -33,37 +33,37 @@ It returns a ListTile which contains a Toggle button to switch between Dark and ## Constructors -[ChangeThemeTile](../widgets_theme_switch/ChangeThemeTile/ChangeThemeTile.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +[ChangeThemeTile](../widgets_theme_switch/ChangeThemeTile/ChangeThemeTile.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ @@ -71,95 +71,95 @@ _read-onlyinherited_ ## Methods -##### [build](../widgets_theme_switch/ChangeThemeTile/build.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) +##### [build](../widgets_theme_switch/ChangeThemeTile/build.md)([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) Describes the part of the user interface represented by this widget. -_override_ +_\override\_ -##### [createElement](https://api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https://api.flutter.dev/flutter/widgets/StatelessElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatelessWidget/createElement.html)() [StatelessElement](https:api.flutter.dev/flutter/widgets/StatelessElement-class.html) -Creates a
StatelessElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatelessElement\ to manage this widget's location in the tree. +_\inherited\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -167,12 +167,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_theme_switch/ChangeThemeTile/ChangeThemeTile.md b/docs/talawa-mobile-docs/widgets_theme_switch/ChangeThemeTile/ChangeThemeTile.md index 88b586d9d92..c90b86453b9 100644 --- a/docs/talawa-mobile-docs/widgets_theme_switch/ChangeThemeTile/ChangeThemeTile.md +++ b/docs/talawa-mobile-docs/widgets_theme_switch/ChangeThemeTile/ChangeThemeTile.md @@ -9,7 +9,7 @@ const -ChangeThemeTile({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) +ChangeThemeTile(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key\}) @@ -18,7 +18,7 @@ ChangeThemeTile({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html ## Implementation ```dart -const ChangeThemeTile({Key? key}) : super(key: key); +const ChangeThemeTile(\{Key? key\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_theme_switch/ChangeThemeTile/build.md b/docs/talawa-mobile-docs/widgets_theme_switch/ChangeThemeTile/build.md index bc0b2b30f60..47e33064b14 100644 --- a/docs/talawa-mobile-docs/widgets_theme_switch/ChangeThemeTile/build.md +++ b/docs/talawa-mobile-docs/widgets_theme_switch/ChangeThemeTile/build.md @@ -9,48 +9,48 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) -[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) build -([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) +[Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) build +([BuildContext](https:api.flutter.dev/flutter/widgets/BuildContext-class.html) context) -_override_ +_\override\_ -

Describes the part of the user interface represented by this widget.

-

The framework calls this method when this widget is inserted into the tree -in a given BuildContext and when the dependencies of this widget change -(e.g., an InheritedWidget referenced by this widget changes). This +\Describes the part of the user interface represented by this widget.\ +\The framework calls this method when this widget is inserted into the tree +in a given \BuildContext\ and when the dependencies of this widget change +(e.g., an \InheritedWidget\ referenced by this widget changes). This method can potentially be called in every frame and should not have any side -effects beyond building a widget.

-

The framework replaces the subtree below this widget with the widget +effects beyond building a widget.\ +\The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing -subtree, as determined by calling Widget.canUpdate.

-

Typically implementations return a newly created constellation of widgets +subtree, as determined by calling \Widget.canUpdate\.\ +\Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and -from the given BuildContext.

-

The given BuildContext contains information about the location in the +from the given \BuildContext\.\ +\The given \BuildContext\ contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A -given widget might be built with multiple different BuildContext +given widget might be built with multiple different \BuildContext\ arguments over time if the widget is moved around the tree or if the -widget is inserted into the tree in multiple places at once.

-

The implementation of this method must only depend on:

-
-

If a widget's build method is to depend on anything else, use a -StatefulWidget instead.

-

See also:

-
    -
  • StatelessWidget, which contains the discussion on performance considerations.
  • -
+widget is inserted into the tree in multiple places at once.\ +\The implementation of this method must only depend on:\ +\ +\the fields of the widget, which themselves must not change over time, +and\ +\any ambient state obtained from the \context\ using +\BuildContext.dependOnInheritedWidgetOfExactType\.\ +\ +\If a widget's \build\ method is to depend on anything else, use a +\StatefulWidget\ instead.\ +\See also:\ +\ +\\StatelessWidget\, which contains the discussion on performance considerations.\ +\ @@ -58,8 +58,8 @@ and ```dart @override -Widget build(BuildContext context) { - final themeProvider = Provider.of(context); +Widget build(BuildContext context) \{ + final themeProvider = Provider.of\(context); return ListTile( key: const Key('ThemeSwitch'), contentPadding: EdgeInsets.zero, @@ -69,13 +69,13 @@ Widget build(BuildContext context) { autofocus: true, activeColor: Theme.of(context).colorScheme.primary, value: themeProvider.isdarkTheme, - onChanged: (value) { - final provider = Provider.of(context, listen: false); + onChanged: (value) \{ + final provider = Provider.of\(context, listen: false); provider.switchTheme(isOn: value); - }, + \}, ), ); -} +\} ``` diff --git a/docs/talawa-mobile-docs/widgets_video_widget/VideoWidget-class.md b/docs/talawa-mobile-docs/widgets_video_widget/VideoWidget-class.md index 162c160f8b5..116d0716751 100644 --- a/docs/talawa-mobile-docs/widgets_video_widget/VideoWidget-class.md +++ b/docs/talawa-mobile-docs/widgets_video_widget/VideoWidget-class.md @@ -11,16 +11,16 @@ -

This class creates a video widget.

+\This class creates a video widget.\ **Inheritance** -- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) -- [DiagnosticableTree](https://api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) -- [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) -- [StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html) +- [Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) +- [DiagnosticableTree](https:api.flutter.dev/flutter/foundation/DiagnosticableTree-class.html) +- [Widget](https:api.flutter.dev/flutter/widgets/Widget-class.html) +- [StatefulWidget](https:api.flutter.dev/flutter/widgets/StatefulWidget-class.html) - VideoWidget @@ -32,55 +32,55 @@ ## Constructors -[VideoWidget](../widgets_video_widget/VideoWidget/VideoWidget.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) url, required [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) play}) +[VideoWidget](../widgets_video_widget/VideoWidget/VideoWidget.md) (\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) url, required [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) play\}) _const_ ## Properties -##### [hashCode](https://api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) +##### [hashCode](https:api.flutter.dev/flutter/widgets/Widget/hashCode.html) → [int](https:api.flutter.dev/flutter/dart-core/int-class.html) The hash code for this object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [key](https://api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? +##### [key](https:api.flutter.dev/flutter/widgets/Widget/key.html) → [Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? Controls how one widget replaces another widget in the tree. -_finalinherited_ +_\final\\inherited\_ -##### [play](../widgets_video_widget/VideoWidget/play.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [play](../widgets_video_widget/VideoWidget/play.md) → [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) -_final_ +_\final\_ -##### [runtimeType](https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https://api.flutter.dev/flutter/dart-core/Type-class.html) +##### [runtimeType](https:api.flutter.dev/flutter/dart-core/Object/runtimeType.html) → [Type](https:api.flutter.dev/flutter/dart-core/Type-class.html) A representation of the runtime type of the object. -_read-onlyinherited_ +_\read-only\\inherited\_ -##### [url](../widgets_video_widget/VideoWidget/url.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [url](../widgets_video_widget/VideoWidget/url.md) → [String](https:api.flutter.dev/flutter/dart-core/String-class.html) -_final_ +_\final\_ @@ -88,12 +88,12 @@ _final_ ## Methods -##### [createElement](https://api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https://api.flutter.dev/flutter/widgets/StatefulElement-class.html) +##### [createElement](https:api.flutter.dev/flutter/widgets/StatefulWidget/createElement.html)() [StatefulElement](https:api.flutter.dev/flutter/widgets/StatefulElement-class.html) -Creates a
StatefulElement to manage this widget's location in the tree. -_inherited_ +Creates a \StatefulElement\ to manage this widget's location in the tree. +_\inherited\_ @@ -102,81 +102,81 @@ _inherited_ Creates the mutable state for this widget at a given location in the tree. -_override_ +_\override\_ -##### [debugDescribeChildren](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)> +##### [debugDescribeChildren](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/debugDescribeChildren.html)() [List](https:api.flutter.dev/flutter/dart-core/List-class.html)<[DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html)\> -Returns a list of DiagnosticsNode objects describing this node's +Returns a list of \DiagnosticsNode\ objects describing this node's children. -_inherited_ +_\inherited\_ -##### [debugFillProperties](https://api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void +##### [debugFillProperties](https:api.flutter.dev/flutter/widgets/Widget/debugFillProperties.html)([DiagnosticPropertiesBuilder](https:api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html) properties) void Add additional properties associated with the node. -_inherited_ +_\inherited\_ -##### [noSuchMethod](https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https://api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic +##### [noSuchMethod](https:api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html)([Invocation](https:api.flutter.dev/flutter/dart-core/Invocation-class.html) invocation) dynamic Invoked when a non-existent method or property is accessed. -_inherited_ +_\inherited\_ -##### [toDiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style}) [DiagnosticsNode](https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) +##### [toDiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toDiagnosticsNode.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html)? name, [DiagnosticsTreeStyle](https:api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html)? style\}) [DiagnosticsNode](https:api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html) Returns a debug representation of the object that is used by debugging -tools and by DiagnosticsNode.toStringDeep. -_inherited_ +tools and by \DiagnosticsNode.toStringDeep\. +_\inherited\_ -##### [toString](https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)({[DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toString](https:api.flutter.dev/flutter/foundation/Diagnosticable/toString.html)(\{[DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.info\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A string representation of this object. -_inherited_ +_\inherited\_ -##### [toStringDeep](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringDeep](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringDeep.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) prefixLineOne = '', [String](https:api.flutter.dev/flutter/dart-core/String-class.html)? prefixOtherLines, [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a string representation of this node and its descendants. -_inherited_ +_\inherited\_ -##### [toStringShallow](https://api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShallow](https:api.flutter.dev/flutter/foundation/DiagnosticableTree/toStringShallow.html)(\{[String](https:api.flutter.dev/flutter/dart-core/String-class.html) joiner = ', ', [DiagnosticLevel](https:api.flutter.dev/flutter/foundation/DiagnosticLevel.html) minLevel = DiagnosticLevel.debug\}) [String](https:api.flutter.dev/flutter/dart-core/String-class.html) Returns a one-line detailed description of the object. -_inherited_ +_\inherited\_ -##### [toStringShort](https://api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) +##### [toStringShort](https:api.flutter.dev/flutter/widgets/Widget/toStringShort.html)() [String](https:api.flutter.dev/flutter/dart-core/String-class.html) A short, textual description of this widget. -_inherited_ +_\inherited\_ @@ -184,12 +184,12 @@ _inherited_ ## Operators -##### [operator ==](https://api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) +##### [operator ==](https:api.flutter.dev/flutter/widgets/Widget/operator_equals.html)([Object](https:api.flutter.dev/flutter/dart-core/Object-class.html) other) [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) The equality operator. -_inherited_ +_\inherited\_ diff --git a/docs/talawa-mobile-docs/widgets_video_widget/VideoWidget/VideoWidget.md b/docs/talawa-mobile-docs/widgets_video_widget/VideoWidget/VideoWidget.md index 6e7a0763bd2..fd975ec26e5 100644 --- a/docs/talawa-mobile-docs/widgets_video_widget/VideoWidget/VideoWidget.md +++ b/docs/talawa-mobile-docs/widgets_video_widget/VideoWidget/VideoWidget.md @@ -9,7 +9,7 @@ const -VideoWidget({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) url, required [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) play}) +VideoWidget(\{[Key](https:api.flutter.dev/flutter/foundation/Key-class.html)? key, required [String](https:api.flutter.dev/flutter/dart-core/String-class.html) url, required [bool](https:api.flutter.dev/flutter/dart-core/bool-class.html) play\}) @@ -18,7 +18,7 @@ VideoWidget({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? k ## Implementation ```dart -const VideoWidget({Key? key, required this.url, required this.play}) +const VideoWidget(\{Key? key, required this.url, required this.play\}) : super(key: key); ``` diff --git a/docs/talawa-mobile-docs/widgets_video_widget/VideoWidget/createState.md b/docs/talawa-mobile-docs/widgets_video_widget/VideoWidget/createState.md index 723fd83743f..d3a36b2a327 100644 --- a/docs/talawa-mobile-docs/widgets_video_widget/VideoWidget/createState.md +++ b/docs/talawa-mobile-docs/widgets_video_widget/VideoWidget/createState.md @@ -9,28 +9,28 @@ -- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +- @[override](https:api.flutter.dev/flutter/dart-core/override-constant.html) _VideoWidgetState createState () -_override_ +_\override\_ -

Creates the mutable state for this widget at a given location in the tree.

-

Subclasses should override this method to return a newly created -instance of their associated State subclass:

-
@override
+\Creates the mutable state for this widget at a given location in the tree.\
+\Subclasses should override this method to return a newly created
+instance of their associated \State\ subclass:\
+\
\@override
 State<SomeWidget> createState() => _SomeWidgetState();
-
-

The framework can call this method multiple times over the lifetime of -a StatefulWidget. For example, if the widget is inserted into the tree -in multiple locations, the framework will create a separate State object +\\ +\The framework can call this method multiple times over the lifetime of +a \StatefulWidget\. For example, if the widget is inserted into the tree +in multiple locations, the framework will create a separate \State\ object for each location. Similarly, if the widget is removed from the tree and -later inserted into the tree again, the framework will call createState -again to create a fresh State object, simplifying the lifecycle of -State objects.

+later inserted into the tree again, the framework will call \createState\ +again to create a fresh \State\ object, simplifying the lifecycle of +\State\ objects.\ @@ -38,7 +38,7 @@ again to create a fresh final_ +_\final\_ diff --git a/docs/talawa-mobile-docs/widgets_video_widget/VideoWidget/url.md b/docs/talawa-mobile-docs/widgets_video_widget/VideoWidget/url.md index 872efdaa1d4..ef6f144e964 100644 --- a/docs/talawa-mobile-docs/widgets_video_widget/VideoWidget/url.md +++ b/docs/talawa-mobile-docs/widgets_video_widget/VideoWidget/url.md @@ -9,9 +9,9 @@ -[String](https://api.flutter.dev/flutter/dart-core/String-class.html) url +[String](https:api.flutter.dev/flutter/dart-core/String-class.html) url -_final_ +_\final\_